git.gag.com Git - debian/amanda/blob - common-src/glib-util.c

   1 /*
   2  * Copyright (c) 2007, 2008, 2009, 2010 Zmanda, Inc.  All Rights Reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License version 2 as published
   6  * by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  10  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  11  * for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16  *
  17  * Contact information: Zmanda Inc., 465 S. Mathilda Ave., Suite 300
  18  * Sunnyvale, CA 94085, USA, or: http://www.zmanda.com
  19  */
  20
  21 /*
  22  * Utilities that aren't quite included in glib
  23  *
  24  * Author: Dustin J. Mitchell <dustin@zmanda.com>, Ian Turner <ian@zmanda.com>
  25  */
  26
  27 #include "amanda.h"
  28 #include "glib-util.h"
  29 #include "conffile.h" /* For find_multiplier. */
  30
  31 #ifdef HAVE_LIBCURL
  32 #include <curl/curl.h>
  33 #endif
  34
  35 void
  36 glib_init(void) {
  37     static gboolean did_glib_init = FALSE;
  38     if (did_glib_init) return;
  39     did_glib_init = TRUE;
  40
  41     /* set up libcurl (this must happen before threading
  42      * is initialized) */
  43 #ifdef HAVE_LIBCURL
  44 # ifdef G_THREADS_ENABLED
  45     g_assert(!g_thread_supported()); /* assert threads aren't initialized yet */
  46 # endif
  47     g_assert(curl_global_init(CURL_GLOBAL_ALL) == 0);
  48 #endif
  49
  50     /* do a version check */
  51 #if GLIB_CHECK_VERSION(2,6,0)
  52     {
  53         const char *glib_err = glib_check_version(GLIB_MAJOR_VERSION,
  54                                                   GLIB_MINOR_VERSION,
  55                                                   GLIB_MICRO_VERSION);
  56         if (glib_err) {
  57             error(_("%s: Amanda was compiled with glib-%d.%d.%d"), glib_err,
  58                     GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION, GLIB_MICRO_VERSION);
  59             exit(1); /* glib_init may be called before error handling is set up */
  60         }
  61     }
  62 #endif
  63
  64     /* Initialize glib's type system.  On glib >= 2.24, this will initialize
  65      * threads, so it must be done after curl is initialized. */
  66     g_type_init();
  67
  68     /* And set up glib's threads */
  69 #if defined(G_THREADS_ENABLED) && !defined(G_THREADS_IMPL_NONE)
  70     if (!g_thread_supported())
  71         g_thread_init(NULL);
  72 #endif
  73 }
  74
  75 typedef enum {
  76     FLAG_STRING_NAME,
  77     FLAG_STRING_SHORT_NAME,
  78     FLAG_STRING_NICK
  79 } FlagString;
  80
  81 static char ** g_flags_to_strv(int value, GType type, FlagString source);
  82
  83 void
  84 _glib_util_foreach_glue(gpointer data, gpointer func)
  85 {
  86     void (*one_arg_fn)(gpointer) = (void (*)(gpointer))func;
  87     one_arg_fn(data);
  88 }
  89
  90 GValue* g_value_unset_init(GValue* value, GType type) {
  91     g_return_val_if_fail(value != NULL, NULL);
  92
  93     if (G_IS_VALUE(value)) {
  94         g_value_unset(value);
  95     }
  96     g_value_init(value, type);
  97     return value;
  98 }
  99
 100 GValue* g_value_unset_copy(const GValue * from, GValue * to) {
 101     g_return_val_if_fail(from != NULL, NULL);
 102     g_return_val_if_fail(to != NULL, NULL);
 103
 104     g_value_unset_init(to, G_VALUE_TYPE(from));
 105     g_value_copy(from, to);
 106     return to;
 107 }
 108
 109 #if (GLIB_MAJOR_VERSION < 2 || (GLIB_MAJOR_VERSION == 2 && GLIB_MINOR_VERSION < 28))
 110 void slist_free_full(GSList * list, GDestroyNotify free_fn) {
 111     GSList * cur = list;
 112
 113     while (cur != NULL) {
 114         gpointer data = cur->data;
 115         free_fn(data);
 116         cur = g_slist_next(cur);
 117     }
 118
 119     g_slist_free(list);
 120 }
 121 #endif
 122
 123 void g_ptr_array_free_full(GPtrArray * array) {
 124     size_t i;
 125
 126     for (i = 0; i < array->len; i ++) {
 127         amfree(g_ptr_array_index(array, i));
 128     }
 129     g_ptr_array_free(array, TRUE);
 130 }
 131
 132 gboolean g_value_compare(GValue * a, GValue * b) {
 133     if (a == NULL && b == NULL)
 134         return TRUE;
 135     if (a == NULL || b == NULL)
 136         return FALSE;
 137     if (G_VALUE_TYPE(a) != G_VALUE_TYPE(b))
 138         return FALSE;
 139     if (g_value_fits_pointer(a) && g_value_fits_pointer(b)) {
 140         return g_value_peek_pointer(a) == g_value_peek_pointer(b);
 141     } else {
 142         /* Since there is no builtin comparison function, we resort to
 143            comparing serialized strings. Yuck. */
 144         char * a_str;
 145         char * b_str;
 146         gboolean rval;
 147         a_str = g_strdup_value_contents(a);
 148         b_str = g_strdup_value_contents(b);
 149         rval = (0 == strcmp(a_str, b_str));
 150         amfree(a_str);
 151         amfree(b_str);
 152         return rval;
 153     }
 154
 155     g_assert_not_reached();
 156 }
 157
 158 static gboolean
 159 g_value_set_boolean_from_string(
 160     GValue * val,
 161     char * str)
 162 {
 163     int b = string_to_boolean(str);
 164
 165     if (b == -1)
 166         return FALSE;
 167
 168     g_value_set_boolean(val, b);
 169     return TRUE;
 170 }
 171
 172 static gboolean g_value_set_int_from_string(GValue * val, char * string) {
 173     long int strto_result;
 174     char * strto_end;
 175     gint64 multiplier;
 176     strto_result = strtol(string, &strto_end, 0);
 177     multiplier = find_multiplier(strto_end);
 178     if (multiplier == G_MAXINT64) {
 179         if (strto_result >= 0) {
 180             g_value_set_int(val, G_MAXINT);
 181         } else {
 182             g_value_set_int(val, G_MININT);
 183         }
 184         return TRUE;
 185     } else if (*string == '\0' || multiplier == 0
 186                || strto_result < G_MININT / multiplier
 187                || strto_result > G_MAXINT / multiplier) {
 188         return FALSE;
 189     } else {
 190         g_value_set_int(val, (int)(strto_result * multiplier));
 191         return TRUE;
 192     }
 193 }
 194
 195 static gboolean g_value_set_uint_from_string(GValue * val, char * string) {
 196     unsigned long int strto_result;
 197     char * strto_end;
 198     guint64 multiplier;
 199     strto_result = strtoul(string, &strto_end, 0);
 200     multiplier = find_multiplier(strto_end); /* casts */
 201     if (multiplier == G_MAXINT64) {
 202         g_value_set_uint(val, G_MAXUINT);
 203         return TRUE;
 204     } else if (multiplier == 0 || *string == '\0' ||
 205                strto_result > G_MAXUINT / multiplier) {
 206         return FALSE;
 207     } else {
 208         g_value_set_uint(val, (guint)(strto_result * multiplier));
 209         return TRUE;
 210     }
 211 }
 212
 213 static gboolean g_value_set_uint64_from_string(GValue * val, char * string) {
 214     unsigned long long int strto_result;
 215     char * strto_end;
 216     guint64 multiplier;
 217     strto_result = strtoull(string, &strto_end, 0);
 218     multiplier = find_multiplier(strto_end); /* casts */
 219     if (multiplier == G_MAXINT64) {
 220         g_value_set_uint64(val, G_MAXUINT64);
 221         return TRUE;
 222     } else if (multiplier == 0 || *string == '\0' ||
 223         strto_result > G_MAXUINT64 / multiplier) {
 224         return FALSE;
 225     } else {
 226         g_value_set_uint64(val, (guint64)(strto_result * multiplier));
 227         return TRUE;
 228     }
 229 }
 230
 231 /* Flags can contain multiple values. We assume here that values are like
 232  * C identifiers (that is, they match /[A-Za-z_][A-Za-z0-9_]+/), although
 233  * that doesn't seem to be a requirement of GLib. With that assumption in
 234  * mind, we look for the format "FLAG_1 | FLAG_2 | ... | FLAG_N". */
 235 static gboolean g_value_set_flags_from_string(GValue * val, char * string) {
 236     guint value = 0;
 237     char * strtok_saveptr;
 238     char * string_copy;
 239     char * strtok_first_arg;
 240     const char delim[] = " \t,|";
 241     GFlagsClass * flags_class;
 242
 243     flags_class = (GFlagsClass*) g_type_class_ref(G_VALUE_TYPE(val));
 244     g_return_val_if_fail(flags_class != NULL, FALSE);
 245     g_return_val_if_fail(G_IS_FLAGS_CLASS(flags_class), FALSE);
 246
 247     /* Don't let strtok stop on original. */
 248     strtok_first_arg = string_copy = strdup(string);
 249
 250     for (;;) {
 251         GFlagsValue * flag_value;
 252         char * token = strtok_r(strtok_first_arg, delim, &strtok_saveptr);
 253         strtok_first_arg = NULL;
 254
 255         if (token == NULL) {
 256             break;
 257         }
 258
 259         flag_value = g_flags_get_value_by_name(flags_class, token);
 260         if (flag_value == NULL) {
 261             flag_value = g_flags_get_value_by_nick(flags_class, token);
 262         }
 263         if (flag_value == NULL) {
 264             g_fprintf(stderr, _("Invalid flag %s for type %s\n"), token,
 265                     g_type_name(G_VALUE_TYPE(val)));
 266             continue;
 267         }
 268
 269         value |= flag_value->value;
 270     }
 271
 272     amfree(string_copy);
 273
 274     if (value == 0) {
 275         g_fprintf(stderr, _("No valid flags for type %s in string %s\n"),
 276                 g_type_name(G_VALUE_TYPE(val)), string);
 277         return FALSE;
 278     }
 279
 280     g_value_set_flags(val, value);
 281     return TRUE;
 282
 283 }
 284
 285 /* This function really ought not to be part of Amanda. In my (Ian's) opinion,
 286    serialization and deserialization should be a part of the GValue
 287    interface. But it's not, and here we are. */
 288 gboolean g_value_set_from_string(GValue * val, char * string) {
 289     g_return_val_if_fail(val != NULL, FALSE);
 290     g_return_val_if_fail(G_IS_VALUE(val), FALSE);
 291
 292     if (G_VALUE_HOLDS_BOOLEAN(val)) {
 293         return g_value_set_boolean_from_string(val, string);
 294     } else if (G_VALUE_HOLDS_INT(val)) {
 295         return g_value_set_int_from_string(val, string);
 296     } else if (G_VALUE_HOLDS_UINT(val)) {
 297         return g_value_set_uint_from_string(val, string);
 298     } else if (G_VALUE_HOLDS_UINT64(val)) {
 299         return g_value_set_uint64_from_string(val, string);
 300     } else if (G_VALUE_HOLDS_STRING(val)) {
 301         g_value_set_string(val, string);
 302         return TRUE;
 303     } else if (G_VALUE_HOLDS_FLAGS(val)) {
 304         return g_value_set_flags_from_string(val, string);
 305     }
 306
 307     return TRUE;
 308 }
 309
 310 gint
 311 g_compare_strings(
 312     gconstpointer a,
 313     gconstpointer b)
 314 {
 315     return strcmp((char *)a, (char *)b);
 316 }
 317
 318 char * g_strjoinv_and_free(char ** strv, const char * seperator) {
 319     char * rval = g_strjoinv(seperator, strv);
 320     g_strfreev(strv);
 321     return rval;
 322 }
 323
 324 char ** g_flags_name_to_strv(int value, GType type) {
 325     return g_flags_to_strv(value, type, FLAG_STRING_NAME);
 326 }
 327
 328 char ** g_flags_short_name_to_strv(int value, GType type) {
 329     return g_flags_to_strv(value, type, FLAG_STRING_SHORT_NAME);
 330 }
 331
 332 char ** g_flags_nick_to_strv(int value, GType type) {
 333     return g_flags_to_strv(value, type, FLAG_STRING_NICK);
 334 }
 335
 336 static char * get_name_from_value(GFlagsValue * value, FlagString source) {
 337     switch (source) {
 338     case FLAG_STRING_NAME:
 339     case FLAG_STRING_SHORT_NAME:
 340         return strdup(value->value_name);
 341     case FLAG_STRING_NICK:
 342         return strdup(value->value_nick);
 343     default:
 344         return NULL;
 345     }
 346 }
 347
 348 /* If freed and notfreed have a common prefix that is different from freed,
 349    then return that and free freed. Otherwise, return freed. */
 350 static char * find_common_prefix(char * freed, const char * notfreed) {
 351     char * freed_ptr = freed;
 352     const char * notfreed_ptr = notfreed;
 353
 354     if (freed == NULL) {
 355         if (notfreed == NULL) {
 356             return NULL;
 357         } else {
 358             return strdup(notfreed);
 359         }
 360     } else if (notfreed == NULL) {
 361         amfree(freed);
 362         return strdup("");
 363     }
 364
 365     while (*freed_ptr == *notfreed_ptr) {
 366         freed_ptr ++;
 367         notfreed_ptr ++;
 368     }
 369
 370     *freed_ptr = '\0';
 371     return freed;
 372 }
 373
 374 static char ** g_flags_to_strv(int value, GType type,
 375                                FlagString source) {
 376     GPtrArray * rval;
 377     GFlagsValue * flagsvalue;
 378     char * common_prefix = NULL;
 379     int common_prefix_len;
 380     GFlagsClass * class;
 381
 382     g_return_val_if_fail(G_TYPE_IS_FLAGS(type), NULL);
 383     g_return_val_if_fail((class = g_type_class_ref(type)) != NULL, NULL);
 384     g_return_val_if_fail(G_IS_FLAGS_CLASS(class), NULL);
 385
 386     rval = g_ptr_array_new();
 387     for (flagsvalue = class->values;
 388          flagsvalue->value_name != NULL;
 389          flagsvalue ++) {
 390         if (source == FLAG_STRING_SHORT_NAME) {
 391             common_prefix = find_common_prefix(common_prefix,
 392                                                flagsvalue->value_name);
 393         }
 394
 395         if ((flagsvalue->value == 0 && value == 0) ||
 396             (flagsvalue->value != 0 && (value & flagsvalue->value))) {
 397             g_ptr_array_add(rval, get_name_from_value(flagsvalue, source));
 398         }
 399     }
 400
 401     if (source == FLAG_STRING_SHORT_NAME && common_prefix != NULL &&
 402         ((common_prefix_len = strlen(common_prefix))) > 0) {
 403         char * old;
 404         char * new;
 405         guint i;
 406         for (i = 0; i < rval->len; i ++) {
 407             old = g_ptr_array_index(rval, i);
 408             new = strdup(old + common_prefix_len);
 409             g_ptr_array_index(rval, i) = new;
 410             g_free(old);
 411         }
 412     }
 413
 414     g_ptr_array_add(rval, NULL);
 415
 416     amfree(common_prefix);
 417     return (char**)g_ptr_array_free(rval, FALSE);
 418 }
 419
 420 char * g_english_strjoinv(char ** strv, const char * conjunction) {
 421     int length;
 422     char * last;
 423     char * joined;
 424     char * rval;
 425     strv = g_strdupv(strv);
 426
 427     length = g_strv_length(strv);
 428
 429     if (length == 1)
 430         return stralloc(strv[0]);
 431
 432     last = strv[length - 1];
 433     strv[length - 1] = NULL;
 434
 435     joined = g_strjoinv(", ", strv);
 436     rval = g_strdup_printf("%s, %s %s", joined, conjunction, last);
 437
 438     g_free(joined);
 439     g_free(last);
 440     g_strfreev(strv);
 441     return rval;
 442 }
 443
 444 char * g_english_strjoinv_and_free(char ** strv, const char * conjunction) {
 445     char * rval = g_english_strjoinv(strv, conjunction);
 446     g_strfreev(strv);
 447     return rval;
 448 }
 449
 450 #if !(GLIB_CHECK_VERSION(2,6,0))
 451 guint g_strv_length(gchar ** strv) {
 452     int rval = 0;
 453
 454     if (G_UNLIKELY(strv == NULL))
 455         return 0;
 456
 457     while (*strv != NULL) {
 458         rval ++;
 459         strv ++;
 460     }
 461     return rval;
 462 }
 463 #endif /* GLIB_CHECK_VERSION(2.6.0) */
 464
 465 #if !GLIB_CHECK_VERSION(2,4,0)
 466 void
 467 g_ptr_array_foreach (GPtrArray *array,
 468                      GFunc      func,
 469                      gpointer   user_data)
 470 {
 471   guint i;
 472
 473   g_return_if_fail (array);
 474
 475   for (i = 0; i < array->len; i++)
 476     (*func) (array->pdata[i], user_data);
 477 }
 478 #endif
 479
 480 guint
 481 g_str_amanda_hash(
 482         gconstpointer key)
 483 {
 484     /* modified version of glib's hash function, copyright
 485      * GLib Team and others 1997-2000. */
 486     const char *p;
 487     guint h = 0;
 488
 489     for (p = key; *p != '\0'; p++)
 490         h = (h << 5) - h + (('_' == *p) ? '-' : g_ascii_tolower(*p));
 491
 492     return h;
 493 }
 494
 495 gboolean
 496 g_str_amanda_equal(
 497         gconstpointer v1,
 498         gconstpointer v2)
 499 {
 500     const gchar *p1 = v1, *p2 = v2;
 501     while (*p1) {
 502         /* letting '-' == '_' */
 503         if (!('-' == *p1 || '_' == *p1) || !('-' == *p2 || '_' == *p2))
 504             if (g_ascii_tolower(*p1) != g_ascii_tolower(*p2))
 505                 return FALSE;
 506
 507         p1++;
 508         p2++;
 509     }
 510
 511     /* p1 is at '\0' is p2 too? */
 512     return *p2? FALSE : TRUE;
 513 }