2 * Copyright (c) 2007, 2008, 2009, 2010 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>
37 static gboolean did_glib_init = FALSE;
38 if (did_glib_init) return;
41 /* set up libcurl (this must happen before threading
44 # ifdef G_THREADS_ENABLED
45 g_assert(!g_thread_supported()); /* assert threads aren't initialized yet */
47 g_assert(curl_global_init(CURL_GLOBAL_ALL) == 0);
50 /* do a version check */
51 #if GLIB_CHECK_VERSION(2,6,0)
53 const char *glib_err = glib_check_version(GLIB_MAJOR_VERSION,
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 */
64 /* Initialize glib's type system. On glib >= 2.24, this will initialize
65 * threads, so it must be done after curl is initialized. */
68 /* And set up glib's threads */
69 #if defined(G_THREADS_ENABLED) && !defined(G_THREADS_IMPL_NONE)
70 if (!g_thread_supported())
77 FLAG_STRING_SHORT_NAME,
81 static char ** g_flags_to_strv(int value, GType type, FlagString source);
84 _glib_util_foreach_glue(gpointer data, gpointer func)
86 void (*one_arg_fn)(gpointer) = (void (*)(gpointer))func;
90 GValue* g_value_unset_init(GValue* value, GType type) {
91 g_return_val_if_fail(value != NULL, NULL);
93 if (G_IS_VALUE(value)) {
96 g_value_init(value, type);
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);
104 g_value_unset_init(to, G_VALUE_TYPE(from));
105 g_value_copy(from, to);
109 #if (GLIB_MAJOR_VERSION < 2 || (GLIB_MAJOR_VERSION == 2 && GLIB_MINOR_VERSION < 28))
110 void slist_free_full(GSList * list, GDestroyNotify free_fn) {
113 while (cur != NULL) {
114 gpointer data = cur->data;
116 cur = g_slist_next(cur);
123 void g_queue_free_full(GQueue * queue) {
124 while (!g_queue_is_empty(queue)) {
126 data = g_queue_pop_head(queue);
132 void g_ptr_array_free_full(GPtrArray * array) {
135 for (i = 0; i < array->len; i ++) {
136 amfree(g_ptr_array_index(array, i));
138 g_ptr_array_free(array, TRUE);
141 gboolean g_value_compare(GValue * a, GValue * b) {
142 if (a == NULL && b == NULL)
144 if (a == NULL || b == NULL)
146 if (G_VALUE_TYPE(a) != G_VALUE_TYPE(b))
148 if (g_value_fits_pointer(a) && g_value_fits_pointer(b)) {
149 return g_value_peek_pointer(a) == g_value_peek_pointer(b);
151 /* Since there is no builtin comparison function, we resort to
152 comparing serialized strings. Yuck. */
156 a_str = g_strdup_value_contents(a);
157 b_str = g_strdup_value_contents(b);
158 rval = (0 == strcmp(a_str, b_str));
164 g_assert_not_reached();
168 g_value_set_boolean_from_string(
172 int b = string_to_boolean(str);
177 g_value_set_boolean(val, b);
181 static gboolean g_value_set_int_from_string(GValue * val, char * string) {
182 long int strto_result;
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);
191 g_value_set_int(val, G_MININT);
194 } else if (*string == '\0' || multiplier == 0
195 || strto_result < G_MININT / multiplier
196 || strto_result > G_MAXINT / multiplier) {
199 g_value_set_int(val, (int)(strto_result * multiplier));
204 static gboolean g_value_set_uint_from_string(GValue * val, char * string) {
205 unsigned long int strto_result;
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);
213 } else if (multiplier == 0 || *string == '\0' ||
214 strto_result > G_MAXUINT / multiplier) {
217 g_value_set_uint(val, (guint)(strto_result * multiplier));
222 static gboolean g_value_set_uint64_from_string(GValue * val, char * string) {
223 unsigned long long int strto_result;
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);
231 } else if (multiplier == 0 || *string == '\0' ||
232 strto_result > G_MAXUINT64 / multiplier) {
235 g_value_set_uint64(val, (guint64)(strto_result * multiplier));
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) {
246 char * strtok_saveptr;
248 char * strtok_first_arg;
249 const char delim[] = " \t,|";
250 GFlagsClass * flags_class;
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);
256 /* Don't let strtok stop on original. */
257 strtok_first_arg = string_copy = strdup(string);
260 GFlagsValue * flag_value;
261 char * token = strtok_r(strtok_first_arg, delim, &strtok_saveptr);
262 strtok_first_arg = NULL;
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);
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)));
278 value |= flag_value->value;
284 g_fprintf(stderr, _("No valid flags for type %s in string %s\n"),
285 g_type_name(G_VALUE_TYPE(val)), string);
289 g_value_set_flags(val, value);
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);
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);
312 } else if (G_VALUE_HOLDS_FLAGS(val)) {
313 return g_value_set_flags_from_string(val, string);
324 return strcmp((char *)a, (char *)b);
327 char * g_strjoinv_and_free(char ** strv, const char * seperator) {
328 char * rval = g_strjoinv(seperator, strv);
333 char ** g_flags_name_to_strv(int value, GType type) {
334 return g_flags_to_strv(value, type, FLAG_STRING_NAME);
337 char ** g_flags_short_name_to_strv(int value, GType type) {
338 return g_flags_to_strv(value, type, FLAG_STRING_SHORT_NAME);
341 char ** g_flags_nick_to_strv(int value, GType type) {
342 return g_flags_to_strv(value, type, FLAG_STRING_NICK);
345 static char * get_name_from_value(GFlagsValue * value, FlagString 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);
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;
364 if (notfreed == NULL) {
367 return strdup(notfreed);
369 } else if (notfreed == NULL) {
374 while (*freed_ptr == *notfreed_ptr) {
383 static char ** g_flags_to_strv(int value, GType type,
386 GFlagsValue * flagsvalue;
387 char * common_prefix = NULL;
388 int common_prefix_len;
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);
395 rval = g_ptr_array_new();
396 for (flagsvalue = class->values;
397 flagsvalue->value_name != NULL;
399 if (source == FLAG_STRING_SHORT_NAME) {
400 common_prefix = find_common_prefix(common_prefix,
401 flagsvalue->value_name);
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));
410 if (source == FLAG_STRING_SHORT_NAME && common_prefix != NULL &&
411 ((common_prefix_len = strlen(common_prefix))) > 0) {
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;
423 g_ptr_array_add(rval, NULL);
425 amfree(common_prefix);
426 return (char**)g_ptr_array_free(rval, FALSE);
429 char * g_english_strjoinv(char ** strv, const char * conjunction) {
434 strv = g_strdupv(strv);
436 length = g_strv_length(strv);
439 return stralloc(strv[0]);
441 last = strv[length - 1];
442 strv[length - 1] = NULL;
444 joined = g_strjoinv(", ", strv);
445 rval = g_strdup_printf("%s, %s %s", joined, conjunction, last);
453 char * g_english_strjoinv_and_free(char ** strv, const char * conjunction) {
454 char * rval = g_english_strjoinv(strv, conjunction);
459 #if !(GLIB_CHECK_VERSION(2,6,0))
460 guint g_strv_length(gchar ** strv) {
463 if (G_UNLIKELY(strv == NULL))
466 while (*strv != NULL) {
472 #endif /* GLIB_CHECK_VERSION(2.6.0) */
474 #if !GLIB_CHECK_VERSION(2,4,0)
476 g_ptr_array_foreach (GPtrArray *array,
482 g_return_if_fail (array);
484 for (i = 0; i < array->len; i++)
485 (*func) (array->pdata[i], user_data);
493 /* modified version of glib's hash function, copyright
494 * GLib Team and others 1997-2000. */
498 for (p = key; *p != '\0'; p++)
499 h = (h << 5) - h + (('_' == *p) ? '-' : g_ascii_tolower(*p));
509 const gchar *p1 = v1, *p2 = v2;
511 /* letting '-' == '_' */
512 if (!('-' == *p1 || '_' == *p1) || !('-' == *p2 || '_' == *p2))
513 if (g_ascii_tolower(*p1) != g_ascii_tolower(*p2))
520 /* p1 is at '\0' is p2 too? */
521 return *p2? FALSE : TRUE;