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;
43 g_assert(curl_global_init(CURL_GLOBAL_ALL) == 0);
46 /* do a version check */
47 #if GLIB_CHECK_VERSION(2,6,0)
49 const char *glib_err = glib_check_version(GLIB_MAJOR_VERSION,
53 error(_("%s: Amanda was compiled with glib-%d.%d.%d"), glib_err,
54 GLIB_MAJOR_VERSION, GLIB_MINOR_VERSION, GLIB_MICRO_VERSION);
55 exit(1); /* glib_init may be called before error handling is set up */
60 /* Initialize glib's type system. On glib >= 2.24, this will initialize
61 * threads, so it must be done after curl is initialized. */
67 FLAG_STRING_SHORT_NAME,
71 static char ** g_flags_to_strv(int value, GType type, FlagString source);
74 _glib_util_foreach_glue(gpointer data, gpointer func)
76 void (*one_arg_fn)(gpointer) = (void (*)(gpointer))func;
80 GValue* g_value_unset_init(GValue* value, GType type) {
81 g_return_val_if_fail(value != NULL, NULL);
83 if (G_IS_VALUE(value)) {
86 g_value_init(value, type);
90 GValue* g_value_unset_copy(const GValue * from, GValue * to) {
91 g_return_val_if_fail(from != NULL, NULL);
92 g_return_val_if_fail(to != NULL, NULL);
94 g_value_unset_init(to, G_VALUE_TYPE(from));
95 g_value_copy(from, to);
99 #if (GLIB_MAJOR_VERSION < 2 || (GLIB_MAJOR_VERSION == 2 && GLIB_MINOR_VERSION < 28))
100 void slist_free_full(GSList * list, GDestroyNotify free_fn) {
103 while (cur != NULL) {
104 gpointer data = cur->data;
106 cur = g_slist_next(cur);
113 void g_ptr_array_free_full(GPtrArray * array) {
116 for (i = 0; i < array->len; i ++) {
117 amfree(g_ptr_array_index(array, i));
119 g_ptr_array_free(array, TRUE);
122 gboolean g_value_compare(GValue * a, GValue * b) {
123 if (a == NULL && b == NULL)
125 if (a == NULL || b == NULL)
127 if (G_VALUE_TYPE(a) != G_VALUE_TYPE(b))
129 if (g_value_fits_pointer(a) && g_value_fits_pointer(b)) {
130 return g_value_peek_pointer(a) == g_value_peek_pointer(b);
132 /* Since there is no builtin comparison function, we resort to
133 comparing serialized strings. Yuck. */
137 a_str = g_strdup_value_contents(a);
138 b_str = g_strdup_value_contents(b);
139 rval = (0 == strcmp(a_str, b_str));
145 g_assert_not_reached();
149 g_value_set_boolean_from_string(
153 int b = string_to_boolean(str);
158 g_value_set_boolean(val, b);
162 static gboolean g_value_set_int_from_string(GValue * val, char * string) {
163 long int strto_result;
166 strto_result = strtol(string, &strto_end, 0);
167 multiplier = find_multiplier(strto_end);
168 if (multiplier == G_MAXINT64) {
169 if (strto_result >= 0) {
170 g_value_set_int(val, G_MAXINT);
172 g_value_set_int(val, G_MININT);
175 } else if (*string == '\0' || multiplier == 0
176 || strto_result < G_MININT / multiplier
177 || strto_result > G_MAXINT / multiplier) {
180 g_value_set_int(val, (int)(strto_result * multiplier));
185 static gboolean g_value_set_uint_from_string(GValue * val, char * string) {
186 unsigned long int strto_result;
189 strto_result = strtoul(string, &strto_end, 0);
190 multiplier = find_multiplier(strto_end); /* casts */
191 if (multiplier == G_MAXINT64) {
192 g_value_set_uint(val, G_MAXUINT);
194 } else if (multiplier == 0 || *string == '\0' ||
195 strto_result > G_MAXUINT / multiplier) {
198 g_value_set_uint(val, (guint)(strto_result * multiplier));
203 static gboolean g_value_set_uint64_from_string(GValue * val, char * string) {
204 unsigned long long int strto_result;
207 strto_result = strtoull(string, &strto_end, 0);
208 multiplier = find_multiplier(strto_end); /* casts */
209 if (multiplier == G_MAXINT64) {
210 g_value_set_uint64(val, G_MAXUINT64);
212 } else if (multiplier == 0 || *string == '\0' ||
213 strto_result > G_MAXUINT64 / multiplier) {
216 g_value_set_uint64(val, (guint64)(strto_result * multiplier));
221 /* Flags can contain multiple values. We assume here that values are like
222 * C identifiers (that is, they match /[A-Za-z_][A-Za-z0-9_]+/), although
223 * that doesn't seem to be a requirement of GLib. With that assumption in
224 * mind, we look for the format "FLAG_1 | FLAG_2 | ... | FLAG_N". */
225 static gboolean g_value_set_flags_from_string(GValue * val, char * string) {
227 char * strtok_saveptr;
229 char * strtok_first_arg;
230 const char delim[] = " \t,|";
231 GFlagsClass * flags_class;
233 flags_class = (GFlagsClass*) g_type_class_ref(G_VALUE_TYPE(val));
234 g_return_val_if_fail(flags_class != NULL, FALSE);
235 g_return_val_if_fail(G_IS_FLAGS_CLASS(flags_class), FALSE);
237 /* Don't let strtok stop on original. */
238 strtok_first_arg = string_copy = strdup(string);
241 GFlagsValue * flag_value;
242 char * token = strtok_r(strtok_first_arg, delim, &strtok_saveptr);
243 strtok_first_arg = NULL;
249 flag_value = g_flags_get_value_by_name(flags_class, token);
250 if (flag_value == NULL) {
251 flag_value = g_flags_get_value_by_nick(flags_class, token);
253 if (flag_value == NULL) {
254 g_fprintf(stderr, _("Invalid flag %s for type %s\n"), token,
255 g_type_name(G_VALUE_TYPE(val)));
259 value |= flag_value->value;
265 g_fprintf(stderr, _("No valid flags for type %s in string %s\n"),
266 g_type_name(G_VALUE_TYPE(val)), string);
270 g_value_set_flags(val, value);
275 /* This function really ought not to be part of Amanda. In my (Ian's) opinion,
276 serialization and deserialization should be a part of the GValue
277 interface. But it's not, and here we are. */
278 gboolean g_value_set_from_string(GValue * val, char * string) {
279 g_return_val_if_fail(val != NULL, FALSE);
280 g_return_val_if_fail(G_IS_VALUE(val), FALSE);
282 if (G_VALUE_HOLDS_BOOLEAN(val)) {
283 return g_value_set_boolean_from_string(val, string);
284 } else if (G_VALUE_HOLDS_INT(val)) {
285 return g_value_set_int_from_string(val, string);
286 } else if (G_VALUE_HOLDS_UINT(val)) {
287 return g_value_set_uint_from_string(val, string);
288 } else if (G_VALUE_HOLDS_UINT64(val)) {
289 return g_value_set_uint64_from_string(val, string);
290 } else if (G_VALUE_HOLDS_STRING(val)) {
291 g_value_set_string(val, string);
293 } else if (G_VALUE_HOLDS_FLAGS(val)) {
294 return g_value_set_flags_from_string(val, string);
305 return strcmp((char *)a, (char *)b);
308 char * g_strjoinv_and_free(char ** strv, const char * seperator) {
309 char * rval = g_strjoinv(seperator, strv);
314 char ** g_flags_name_to_strv(int value, GType type) {
315 return g_flags_to_strv(value, type, FLAG_STRING_NAME);
318 char ** g_flags_short_name_to_strv(int value, GType type) {
319 return g_flags_to_strv(value, type, FLAG_STRING_SHORT_NAME);
322 char ** g_flags_nick_to_strv(int value, GType type) {
323 return g_flags_to_strv(value, type, FLAG_STRING_NICK);
326 static char * get_name_from_value(GFlagsValue * value, FlagString source) {
328 case FLAG_STRING_NAME:
329 case FLAG_STRING_SHORT_NAME:
330 return strdup(value->value_name);
331 case FLAG_STRING_NICK:
332 return strdup(value->value_nick);
338 /* If freed and notfreed have a common prefix that is different from freed,
339 then return that and free freed. Otherwise, return freed. */
340 static char * find_common_prefix(char * freed, const char * notfreed) {
341 char * freed_ptr = freed;
342 const char * notfreed_ptr = notfreed;
345 if (notfreed == NULL) {
348 return strdup(notfreed);
350 } else if (notfreed == NULL) {
355 while (*freed_ptr == *notfreed_ptr) {
364 static char ** g_flags_to_strv(int value, GType type,
367 GFlagsValue * flagsvalue;
368 char * common_prefix = NULL;
369 int common_prefix_len;
372 g_return_val_if_fail(G_TYPE_IS_FLAGS(type), NULL);
373 g_return_val_if_fail((class = g_type_class_ref(type)) != NULL, NULL);
374 g_return_val_if_fail(G_IS_FLAGS_CLASS(class), NULL);
376 rval = g_ptr_array_new();
377 for (flagsvalue = class->values;
378 flagsvalue->value_name != NULL;
380 if (source == FLAG_STRING_SHORT_NAME) {
381 common_prefix = find_common_prefix(common_prefix,
382 flagsvalue->value_name);
385 if ((flagsvalue->value == 0 && value == 0) ||
386 (flagsvalue->value != 0 && (value & flagsvalue->value))) {
387 g_ptr_array_add(rval, get_name_from_value(flagsvalue, source));
391 if (source == FLAG_STRING_SHORT_NAME && common_prefix != NULL &&
392 ((common_prefix_len = strlen(common_prefix))) > 0) {
396 for (i = 0; i < rval->len; i ++) {
397 old = g_ptr_array_index(rval, i);
398 new = strdup(old + common_prefix_len);
399 g_ptr_array_index(rval, i) = new;
404 g_ptr_array_add(rval, NULL);
406 amfree(common_prefix);
407 return (char**)g_ptr_array_free(rval, FALSE);
410 char * g_english_strjoinv(char ** strv, const char * conjunction) {
415 strv = g_strdupv(strv);
417 length = g_strv_length(strv);
420 return stralloc(strv[0]);
422 last = strv[length - 1];
423 strv[length - 1] = NULL;
425 joined = g_strjoinv(", ", strv);
426 rval = g_strdup_printf("%s, %s %s", joined, conjunction, last);
434 char * g_english_strjoinv_and_free(char ** strv, const char * conjunction) {
435 char * rval = g_english_strjoinv(strv, conjunction);
440 #if !(GLIB_CHECK_VERSION(2,6,0))
441 guint g_strv_length(gchar ** strv) {
444 if (G_UNLIKELY(strv == NULL))
447 while (*strv != NULL) {
453 #endif /* GLIB_CHECK_VERSION(2.6.0) */
455 #if !GLIB_CHECK_VERSION(2,4,0)
457 g_ptr_array_foreach (GPtrArray *array,
463 g_return_if_fail (array);
465 for (i = 0; i < array->len; i++)
466 (*func) (array->pdata[i], user_data);
474 /* modified version of glib's hash function, copyright
475 * GLib Team and others 1997-2000. */
479 for (p = key; *p != '\0'; p++)
480 h = (h << 5) - h + (('_' == *p) ? '-' : g_ascii_tolower(*p));
490 const gchar *p1 = v1, *p2 = v2;
492 /* letting '-' == '_' */
493 if (!('-' == *p1 || '_' == *p1) || !('-' == *p2 || '_' == *p2))
494 if (g_ascii_tolower(*p1) != g_ascii_tolower(*p2))
501 /* p1 is at '\0' is p2 too? */
502 return *p2? FALSE : TRUE;