2 * Copyright (c) 2007-2012 Zmanda, Inc. All Rights Reserved.
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.
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
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
17 * Contact information: Zmanda Inc., 465 S. Mathilda Ave., Suite 300
18 * Sunnyvale, CA 94085, USA, or: http://www.zmanda.com
22 * Utilities that aren't quite included in glib
24 * Author: Dustin J. Mitchell <dustin@zmanda.com>, Ian Turner <ian@zmanda.com>
28 #include "glib-util.h"
29 #include "conffile.h" /* For find_multiplier. */
32 #include <curl/curl.h>
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)
41 if (mode & CRYPTO_LOCK) {
42 g_mutex_lock(openssl_mutex_array[type]);
45 g_mutex_unlock(openssl_mutex_array[type]);
54 openssl_mutex_array = g_new0(GMutex *, CRYPTO_num_locks());
56 for (i=0; i<CRYPTO_num_locks(); i++) {
57 openssl_mutex_array[i] = g_mutex_new();
59 CRYPTO_set_locking_callback(openssl_lock_callback);
63 #else /* LIBCURL_USE_OPENSSL */
64 #if defined LIBCURL_USE_GNUTLS
69 GCRY_THREAD_OPTION_PTHREAD_IMPL;
73 gcry_control(GCRYCTL_SET_THREAD_CBS);
76 #else /* LIBCURL_USE_GNUTLS */
82 #endif /* LIBCURL_USE_GNUTLS */
83 #endif /* LIBCURL_USE_OPENSSL */
85 #else /* HAVE_LIBCURL */
90 #endif /* HAVE_LIBCURL */
94 static gboolean did_glib_init = FALSE;
95 if (did_glib_init) return;
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 */
105 g_assert(curl_global_init(CURL_GLOBAL_ALL) == 0);
108 /* do a version check */
109 #if GLIB_CHECK_VERSION(2,6,0)
111 const char *glib_err = glib_check_version(GLIB_MAJOR_VERSION,
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 */
122 /* Initialize glib's type system. On glib >= 2.24, this will initialize
123 * threads, so it must be done after curl is initialized. */
126 /* And set up glib's threads */
127 #if defined(G_THREADS_ENABLED) && !defined(G_THREADS_IMPL_NONE)
128 if (!g_thread_supported())
139 FLAG_STRING_SHORT_NAME,
143 static char ** g_flags_to_strv(int value, GType type, FlagString source);
146 _glib_util_foreach_glue(gpointer data, gpointer func)
148 void (*one_arg_fn)(gpointer) = (void (*)(gpointer))func;
152 GValue* g_value_unset_init(GValue* value, GType type) {
153 g_return_val_if_fail(value != NULL, NULL);
155 if (G_IS_VALUE(value)) {
156 g_value_unset(value);
158 g_value_init(value, type);
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);
166 g_value_unset_init(to, G_VALUE_TYPE(from));
167 g_value_copy(from, to);
171 #if (GLIB_MAJOR_VERSION < 2 || (GLIB_MAJOR_VERSION == 2 && GLIB_MINOR_VERSION < 28))
172 void slist_free_full(GSList * list, GDestroyNotify free_fn) {
175 while (cur != NULL) {
176 gpointer data = cur->data;
178 cur = g_slist_next(cur);
185 void g_ptr_array_free_full(GPtrArray * array) {
188 for (i = 0; i < array->len; i ++) {
189 amfree(g_ptr_array_index(array, i));
191 g_ptr_array_free(array, TRUE);
194 gboolean g_value_compare(GValue * a, GValue * b) {
195 if (a == NULL && b == NULL)
197 if (a == NULL || b == NULL)
199 if (G_VALUE_TYPE(a) != G_VALUE_TYPE(b))
201 if (g_value_fits_pointer(a) && g_value_fits_pointer(b)) {
202 return g_value_peek_pointer(a) == g_value_peek_pointer(b);
204 /* Since there is no builtin comparison function, we resort to
205 comparing serialized strings. Yuck. */
209 a_str = g_strdup_value_contents(a);
210 b_str = g_strdup_value_contents(b);
211 rval = (0 == strcmp(a_str, b_str));
217 g_assert_not_reached();
221 g_value_set_boolean_from_string(
225 int b = string_to_boolean(str);
230 g_value_set_boolean(val, b);
234 static gboolean g_value_set_int_from_string(GValue * val, char * string) {
235 long int strto_result;
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);
244 g_value_set_int(val, G_MININT);
247 } else if (*string == '\0' || multiplier == 0
248 || strto_result < G_MININT / multiplier
249 || strto_result > G_MAXINT / multiplier) {
252 g_value_set_int(val, (int)(strto_result * multiplier));
257 static gboolean g_value_set_uint_from_string(GValue * val, char * string) {
258 unsigned long int strto_result;
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);
266 } else if (multiplier == 0 || *string == '\0' ||
267 strto_result > G_MAXUINT / multiplier) {
270 g_value_set_uint(val, (guint)(strto_result * multiplier));
275 static gboolean g_value_set_uint64_from_string(GValue * val, char * string) {
276 unsigned long long int strto_result;
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);
284 } else if (multiplier == 0 || *string == '\0' ||
285 strto_result > G_MAXUINT64 / multiplier) {
288 g_value_set_uint64(val, (guint64)(strto_result * multiplier));
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) {
299 char * strtok_saveptr;
301 char * strtok_first_arg;
302 const char delim[] = " \t,|";
303 GFlagsClass * flags_class;
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);
309 /* Don't let strtok stop on original. */
310 strtok_first_arg = string_copy = strdup(string);
313 GFlagsValue * flag_value;
314 char * token = strtok_r(strtok_first_arg, delim, &strtok_saveptr);
315 strtok_first_arg = NULL;
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);
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)));
331 value |= flag_value->value;
337 g_fprintf(stderr, _("No valid flags for type %s in string %s\n"),
338 g_type_name(G_VALUE_TYPE(val)), string);
342 g_value_set_flags(val, value);
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);
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);
365 } else if (G_VALUE_HOLDS_FLAGS(val)) {
366 return g_value_set_flags_from_string(val, string);
377 return strcmp((char *)a, (char *)b);
380 char * g_strjoinv_and_free(char ** strv, const char * seperator) {
381 char * rval = g_strjoinv(seperator, strv);
386 char ** g_flags_name_to_strv(int value, GType type) {
387 return g_flags_to_strv(value, type, FLAG_STRING_NAME);
390 char ** g_flags_short_name_to_strv(int value, GType type) {
391 return g_flags_to_strv(value, type, FLAG_STRING_SHORT_NAME);
394 char ** g_flags_nick_to_strv(int value, GType type) {
395 return g_flags_to_strv(value, type, FLAG_STRING_NICK);
398 static char * get_name_from_value(GFlagsValue * value, FlagString 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);
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;
417 if (notfreed == NULL) {
420 return strdup(notfreed);
422 } else if (notfreed == NULL) {
427 while (*freed_ptr == *notfreed_ptr) {
436 static char ** g_flags_to_strv(int value, GType type,
439 GFlagsValue * flagsvalue;
440 char * common_prefix = NULL;
441 int common_prefix_len;
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);
448 rval = g_ptr_array_new();
449 for (flagsvalue = class->values;
450 flagsvalue->value_name != NULL;
452 if (source == FLAG_STRING_SHORT_NAME) {
453 common_prefix = find_common_prefix(common_prefix,
454 flagsvalue->value_name);
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));
463 if (source == FLAG_STRING_SHORT_NAME && common_prefix != NULL &&
464 ((common_prefix_len = strlen(common_prefix))) > 0) {
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;
476 g_ptr_array_add(rval, NULL);
478 amfree(common_prefix);
479 return (char**)g_ptr_array_free(rval, FALSE);
482 char * g_english_strjoinv(char ** strv, const char * conjunction) {
487 strv = g_strdupv(strv);
489 length = g_strv_length(strv);
492 return stralloc(strv[0]);
494 last = strv[length - 1];
495 strv[length - 1] = NULL;
497 joined = g_strjoinv(", ", strv);
498 rval = g_strdup_printf("%s, %s %s", joined, conjunction, last);
506 char * g_english_strjoinv_and_free(char ** strv, const char * conjunction) {
507 char * rval = g_english_strjoinv(strv, conjunction);
512 #if !(GLIB_CHECK_VERSION(2,6,0))
513 guint g_strv_length(gchar ** strv) {
516 if (G_UNLIKELY(strv == NULL))
519 while (*strv != NULL) {
525 #endif /* GLIB_CHECK_VERSION(2.6.0) */
527 #if !GLIB_CHECK_VERSION(2,4,0)
529 g_ptr_array_foreach (GPtrArray *array,
535 g_return_if_fail (array);
537 for (i = 0; i < array->len; i++)
538 (*func) (array->pdata[i], user_data);
546 /* modified version of glib's hash function, copyright
547 * GLib Team and others 1997-2000. */
551 for (p = key; *p != '\0'; p++)
552 h = (h << 5) - h + (('_' == *p) ? '-' : g_ascii_tolower(*p));
562 const gchar *p1 = v1, *p2 = v2;
564 /* letting '-' == '_' */
565 if (!('-' == *p1 || '_' == *p1) || !('-' == *p2 || '_' == *p2))
566 if (g_ascii_tolower(*p1) != g_ascii_tolower(*p2))
573 /* p1 is at '\0' is p2 too? */
574 return *p2? FALSE : TRUE;