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

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