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_queue_free_full(GQueue * queue) {
 124     while (!g_queue_is_empty(queue)) {
 125         gpointer data;
 126         data = g_queue_pop_head(queue);
 127         amfree(data);
 128     }
 129     g_queue_free(queue);
 130 }
 131
 132 void g_ptr_array_free_full(GPtrArray * array) {
 133     size_t i;
 134
 135     for (i = 0; i < array->len; i ++) {
 136         amfree(g_ptr_array_index(array, i));
 137     }
 138     g_ptr_array_free(array, TRUE);
 139 }
 140
 141 gboolean g_value_compare(GValue * a, GValue * b) {
 142     if (a == NULL && b == NULL)
 143         return TRUE;
 144     if (a == NULL || b == NULL)
 145         return FALSE;
 146     if (G_VALUE_TYPE(a) != G_VALUE_TYPE(b))
 147         return FALSE;
 148     if (g_value_fits_pointer(a) && g_value_fits_pointer(b)) {
 149         return g_value_peek_pointer(a) == g_value_peek_pointer(b);
 150     } else {
 151         /* Since there is no builtin comparison function, we resort to
 152            comparing serialized strings. Yuck. */
 153         char * a_str;
 154         char * b_str;
 155         gboolean rval;
 156         a_str = g_strdup_value_contents(a);
 157         b_str = g_strdup_value_contents(b);
 158         rval = (0 == strcmp(a_str, b_str));
 159         amfree(a_str);
 160         amfree(b_str);
 161         return rval;
 162     }
 163
 164     g_assert_not_reached();
 165 }
 166
 167 static gboolean
 168 g_value_set_boolean_from_string(
 169     GValue * val,
 170     char * str)
 171 {
 172     int b = string_to_boolean(str);
 173
 174     if (b == -1)
 175         return FALSE;
 176
 177     g_value_set_boolean(val, b);
 178     return TRUE;
 179 }
 180
 181 static gboolean g_value_set_int_from_string(GValue * val, char * string) {
 182     long int strto_result;
 183     char * strto_end;
 184     gint64 multiplier;
 185     strto_result = strtol(string, &strto_end, 0);
 186     multiplier = find_multiplier(strto_end);
 187     if (multiplier == G_MAXINT64) {
 188         if (strto_result >= 0) {
 189             g_value_set_int(val, G_MAXINT);
 190         } else {
 191             g_value_set_int(val, G_MININT);
 192         }
 193         return TRUE;
 194     } else if (*string == '\0' || multiplier == 0
 195                || strto_result < G_MININT / multiplier
 196                || strto_result > G_MAXINT / multiplier) {
 197         return FALSE;
 198     } else {
 199         g_value_set_int(val, (int)(strto_result * multiplier));
 200         return TRUE;
 201     }
 202 }
 203
 204 static gboolean g_value_set_uint_from_string(GValue * val, char * string) {
 205     unsigned long int strto_result;
 206     char * strto_end;
 207     guint64 multiplier;
 208     strto_result = strtoul(string, &strto_end, 0);
 209     multiplier = find_multiplier(strto_end); /* casts */
 210     if (multiplier == G_MAXINT64) {
 211         g_value_set_uint(val, G_MAXUINT);
 212         return TRUE;
 213     } else if (multiplier == 0 || *string == '\0' ||
 214                strto_result > G_MAXUINT / multiplier) {
 215         return FALSE;
 216     } else {
 217         g_value_set_uint(val, (guint)(strto_result * multiplier));
 218         return TRUE;
 219     }
 220 }
 221
 222 static gboolean g_value_set_uint64_from_string(GValue * val, char * string) {
 223     unsigned long long int strto_result;
 224     char * strto_end;
 225     guint64 multiplier;
 226     strto_result = strtoull(string, &strto_end, 0);
 227     multiplier = find_multiplier(strto_end); /* casts */
 228     if (multiplier == G_MAXINT64) {
 229         g_value_set_uint64(val, G_MAXUINT64);
 230         return TRUE;
 231     } else if (multiplier == 0 || *string == '\0' ||
 232         strto_result > G_MAXUINT64 / multiplier) {
 233         return FALSE;
 234     } else {
 235         g_value_set_uint64(val, (guint64)(strto_result * multiplier));
 236         return TRUE;
 237     }
 238 }
 239
 240 /* Flags can contain multiple values. We assume here that values are like
 241  * C identifiers (that is, they match /[A-Za-z_][A-Za-z0-9_]+/), although
 242  * that doesn't seem to be a requirement of GLib. With that assumption in
 243  * mind, we look for the format "FLAG_1 | FLAG_2 | ... | FLAG_N". */
 244 static gboolean g_value_set_flags_from_string(GValue * val, char * string) {
 245     guint value = 0;
 246     char * strtok_saveptr;
 247     char * string_copy;
 248     char * strtok_first_arg;
 249     const char delim[] = " \t,|";
 250     GFlagsClass * flags_class;
 251
 252     flags_class = (GFlagsClass*) g_type_class_ref(G_VALUE_TYPE(val));
 253     g_return_val_if_fail(flags_class != NULL, FALSE);
 254     g_return_val_if_fail(G_IS_FLAGS_CLASS(flags_class), FALSE);
 255
 256     /* Don't let strtok stop on original. */
 257     strtok_first_arg = string_copy = strdup(string);
 258
 259     for (;;) {
 260         GFlagsValue * flag_value;
 261         char * token = strtok_r(strtok_first_arg, delim, &strtok_saveptr);
 262         strtok_first_arg = NULL;
 263
 264         if (token == NULL) {
 265             break;
 266         }
 267
 268         flag_value = g_flags_get_value_by_name(flags_class, token);
 269         if (flag_value == NULL) {
 270             flag_value = g_flags_get_value_by_nick(flags_class, token);
 271         }
 272         if (flag_value == NULL) {
 273             g_fprintf(stderr, _("Invalid flag %s for type %s\n"), token,
 274                     g_type_name(G_VALUE_TYPE(val)));
 275             continue;
 276         }
 277
 278         value |= flag_value->value;
 279     }
 280
 281     amfree(string_copy);
 282
 283     if (value == 0) {
 284         g_fprintf(stderr, _("No valid flags for type %s in string %s\n"),
 285                 g_type_name(G_VALUE_TYPE(val)), string);
 286         return FALSE;
 287     }
 288
 289     g_value_set_flags(val, value);
 290     return TRUE;
 291
 292 }
 293
 294 /* This function really ought not to be part of Amanda. In my (Ian's) opinion,
 295    serialization and deserialization should be a part of the GValue
 296    interface. But it's not, and here we are. */
 297 gboolean g_value_set_from_string(GValue * val, char * string) {
 298     g_return_val_if_fail(val != NULL, FALSE);
 299     g_return_val_if_fail(G_IS_VALUE(val), FALSE);
 300
 301     if (G_VALUE_HOLDS_BOOLEAN(val)) {
 302         return g_value_set_boolean_from_string(val, string);
 303     } else if (G_VALUE_HOLDS_INT(val)) {
 304         return g_value_set_int_from_string(val, string);
 305     } else if (G_VALUE_HOLDS_UINT(val)) {
 306         return g_value_set_uint_from_string(val, string);
 307     } else if (G_VALUE_HOLDS_UINT64(val)) {
 308         return g_value_set_uint64_from_string(val, string);
 309     } else if (G_VALUE_HOLDS_STRING(val)) {
 310         g_value_set_string(val, string);
 311         return TRUE;
 312     } else if (G_VALUE_HOLDS_FLAGS(val)) {
 313         return g_value_set_flags_from_string(val, string);
 314     }
 315
 316     return TRUE;
 317 }
 318
 319 gint
 320 g_compare_strings(
 321     gconstpointer a,
 322     gconstpointer b)
 323 {
 324     return strcmp((char *)a, (char *)b);
 325 }
 326
 327 char * g_strjoinv_and_free(char ** strv, const char * seperator) {
 328     char * rval = g_strjoinv(seperator, strv);
 329     g_strfreev(strv);
 330     return rval;
 331 }
 332
 333 char ** g_flags_name_to_strv(int value, GType type) {
 334     return g_flags_to_strv(value, type, FLAG_STRING_NAME);
 335 }
 336
 337 char ** g_flags_short_name_to_strv(int value, GType type) {
 338     return g_flags_to_strv(value, type, FLAG_STRING_SHORT_NAME);
 339 }
 340
 341 char ** g_flags_nick_to_strv(int value, GType type) {
 342     return g_flags_to_strv(value, type, FLAG_STRING_NICK);
 343 }
 344
 345 static char * get_name_from_value(GFlagsValue * value, FlagString source) {
 346     switch (source) {
 347     case FLAG_STRING_NAME:
 348     case FLAG_STRING_SHORT_NAME:
 349         return strdup(value->value_name);
 350     case FLAG_STRING_NICK:
 351         return strdup(value->value_nick);
 352     default:
 353         return NULL;
 354     }
 355 }
 356
 357 /* If freed and notfreed have a common prefix that is different from freed,
 358    then return that and free freed. Otherwise, return freed. */
 359 static char * find_common_prefix(char * freed, const char * notfreed) {
 360     char * freed_ptr = freed;
 361     const char * notfreed_ptr = notfreed;
 362
 363     if (freed == NULL) {
 364         if (notfreed == NULL) {
 365             return NULL;
 366         } else {
 367             return strdup(notfreed);
 368         }
 369     } else if (notfreed == NULL) {
 370         amfree(freed);
 371         return strdup("");
 372     }
 373
 374     while (*freed_ptr == *notfreed_ptr) {
 375         freed_ptr ++;
 376         notfreed_ptr ++;
 377     }
 378
 379     *freed_ptr = '\0';
 380     return freed;
 381 }
 382
 383 static char ** g_flags_to_strv(int value, GType type,
 384                                FlagString source) {
 385     GPtrArray * rval;
 386     GFlagsValue * flagsvalue;
 387     char * common_prefix = NULL;
 388     int common_prefix_len;
 389     GFlagsClass * class;
 390
 391     g_return_val_if_fail(G_TYPE_IS_FLAGS(type), NULL);
 392     g_return_val_if_fail((class = g_type_class_ref(type)) != NULL, NULL);
 393     g_return_val_if_fail(G_IS_FLAGS_CLASS(class), NULL);
 394
 395     rval = g_ptr_array_new();
 396     for (flagsvalue = class->values;
 397          flagsvalue->value_name != NULL;
 398          flagsvalue ++) {
 399         if (source == FLAG_STRING_SHORT_NAME) {
 400             common_prefix = find_common_prefix(common_prefix,
 401                                                flagsvalue->value_name);
 402         }
 403
 404         if ((flagsvalue->value == 0 && value == 0) ||
 405             (flagsvalue->value != 0 && (value & flagsvalue->value))) {
 406             g_ptr_array_add(rval, get_name_from_value(flagsvalue, source));
 407         }
 408     }
 409
 410     if (source == FLAG_STRING_SHORT_NAME && common_prefix != NULL &&
 411         ((common_prefix_len = strlen(common_prefix))) > 0) {
 412         char * old;
 413         char * new;
 414         guint i;
 415         for (i = 0; i < rval->len; i ++) {
 416             old = g_ptr_array_index(rval, i);
 417             new = strdup(old + common_prefix_len);
 418             g_ptr_array_index(rval, i) = new;
 419             g_free(old);
 420         }
 421     }
 422
 423     g_ptr_array_add(rval, NULL);
 424
 425     amfree(common_prefix);
 426     return (char**)g_ptr_array_free(rval, FALSE);
 427 }
 428
 429 char * g_english_strjoinv(char ** strv, const char * conjunction) {
 430     int length;
 431     char * last;
 432     char * joined;
 433     char * rval;
 434     strv = g_strdupv(strv);
 435
 436     length = g_strv_length(strv);
 437
 438     if (length == 1)
 439         return stralloc(strv[0]);
 440
 441     last = strv[length - 1];
 442     strv[length - 1] = NULL;
 443
 444     joined = g_strjoinv(", ", strv);
 445     rval = g_strdup_printf("%s, %s %s", joined, conjunction, last);
 446
 447     g_free(joined);
 448     g_free(last);
 449     g_strfreev(strv);
 450     return rval;
 451 }
 452
 453 char * g_english_strjoinv_and_free(char ** strv, const char * conjunction) {
 454     char * rval = g_english_strjoinv(strv, conjunction);
 455     g_strfreev(strv);
 456     return rval;
 457 }
 458
 459 #if !(GLIB_CHECK_VERSION(2,6,0))
 460 guint g_strv_length(gchar ** strv) {
 461     int rval = 0;
 462
 463     if (G_UNLIKELY(strv == NULL))
 464         return 0;
 465
 466     while (*strv != NULL) {
 467         rval ++;
 468         strv ++;
 469     }
 470     return rval;
 471 }
 472 #endif /* GLIB_CHECK_VERSION(2.6.0) */
 473
 474 #if !GLIB_CHECK_VERSION(2,4,0)
 475 void
 476 g_ptr_array_foreach (GPtrArray *array,
 477                      GFunc      func,
 478                      gpointer   user_data)
 479 {
 480   guint i;
 481
 482   g_return_if_fail (array);
 483
 484   for (i = 0; i < array->len; i++)
 485     (*func) (array->pdata[i], user_data);
 486 }
 487 #endif
 488
 489 guint
 490 g_str_amanda_hash(
 491         gconstpointer key)
 492 {
 493     /* modified version of glib's hash function, copyright
 494      * GLib Team and others 1997-2000. */
 495     const char *p;
 496     guint h = 0;
 497
 498     for (p = key; *p != '\0'; p++)
 499         h = (h << 5) - h + (('_' == *p) ? '-' : g_ascii_tolower(*p));
 500
 501     return h;
 502 }
 503
 504 gboolean
 505 g_str_amanda_equal(
 506         gconstpointer v1,
 507         gconstpointer v2)
 508 {
 509     const gchar *p1 = v1, *p2 = v2;
 510     while (*p1) {
 511         /* letting '-' == '_' */
 512         if (!('-' == *p1 || '_' == *p1) || !('-' == *p2 || '_' == *p2))
 513             if (g_ascii_tolower(*p1) != g_ascii_tolower(*p2))
 514                 return FALSE;
 515
 516         p1++;
 517         p2++;
 518     }
 519
 520     /* p1 is at '\0' is p2 too? */
 521     return *p2? FALSE : TRUE;
 522 }