GDBus: Document GVariant/GValue conversion routines and move to them to utils
[platform/upstream/glib.git] / gio / gdbusutils.c
1 /* GDBus - GLib D-Bus Library
2  *
3  * Copyright (C) 2008-2010 Red Hat, Inc.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General
16  * Public License along with this library; if not, write to the
17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18  * Boston, MA 02111-1307, USA.
19  *
20  * Author: David Zeuthen <davidz@redhat.com>
21  */
22
23 #include "config.h"
24
25 #include <stdlib.h>
26 #include <string.h>
27
28 #include "gdbusutils.h"
29
30 #include "glibintl.h"
31
32 /**
33  * SECTION:gdbusutils
34  * @title: D-Bus Utilities
35  * @short_description: Various utilities related to D-Bus.
36  * @include: gio/gio.h
37  *
38  * Various utility routines related to D-Bus.
39  */
40
41 static gboolean
42 is_valid_bus_name_character (gint c,
43                              gboolean allow_hyphen)
44 {
45   return
46     (c >= '0' && c <= '9') ||
47     (c >= 'A' && c <= 'Z') ||
48     (c >= 'a' && c <= 'z') ||
49     (c == '_') ||
50     (allow_hyphen && c == '-');
51 }
52
53 static gboolean
54 is_valid_initial_bus_name_character (gint c,
55                                      gboolean allow_initial_digit,
56                                      gboolean allow_hyphen)
57 {
58   if (allow_initial_digit)
59     return is_valid_bus_name_character (c, allow_hyphen);
60   else
61     return
62       (c >= 'A' && c <= 'Z') ||
63       (c >= 'a' && c <= 'z') ||
64       (c == '_') ||
65       (allow_hyphen && c == '-');
66 }
67
68 static gboolean
69 is_valid_name (const gchar *start,
70                guint len,
71                gboolean allow_initial_digit,
72                gboolean allow_hyphen)
73 {
74   gboolean ret;
75   const gchar *s;
76   const gchar *end;
77   gboolean has_dot;
78
79   ret = FALSE;
80
81   if (len == 0)
82     goto out;
83
84   s = start;
85   end = s + len;
86   has_dot = FALSE;
87   while (s != end)
88     {
89       if (*s == '.')
90         {
91           s += 1;
92           if (G_UNLIKELY (!is_valid_initial_bus_name_character (*s, allow_initial_digit, allow_hyphen)))
93             goto out;
94           has_dot = TRUE;
95         }
96       else if (G_UNLIKELY (!is_valid_bus_name_character (*s, allow_hyphen)))
97         {
98           goto out;
99         }
100       s += 1;
101     }
102
103   if (G_UNLIKELY (!has_dot))
104     goto out;
105
106   ret = TRUE;
107
108  out:
109   return ret;
110 }
111
112 /**
113  * g_dbus_is_name:
114  * @string: The string to check.
115  *
116  * Checks if @string is a valid D-Bus bus name (either unique or well-known).
117  *
118  * Returns: %TRUE if valid, %FALSE otherwise.
119  *
120  * Since: 2.26
121  */
122 gboolean
123 g_dbus_is_name (const gchar *string)
124 {
125   guint len;
126   gboolean ret;
127   const gchar *s;
128
129   g_return_val_if_fail (string != NULL, FALSE);
130
131   ret = FALSE;
132
133   len = strlen (string);
134   if (G_UNLIKELY (len == 0 || len > 255))
135     goto out;
136
137   s = string;
138   if (*s == ':')
139     {
140       /* handle unique name */
141       if (!is_valid_name (s + 1, len - 1, TRUE, TRUE))
142         goto out;
143       ret = TRUE;
144       goto out;
145     }
146   else if (G_UNLIKELY (*s == '.'))
147     {
148       /* can't start with a . */
149       goto out;
150     }
151   else if (G_UNLIKELY (!is_valid_initial_bus_name_character (*s, FALSE, TRUE)))
152     goto out;
153
154   ret = is_valid_name (s + 1, len - 1, FALSE, TRUE);
155
156  out:
157   return ret;
158 }
159
160 /**
161  * g_dbus_is_unique_name:
162  * @string: The string to check.
163  *
164  * Checks if @string is a valid D-Bus unique bus name.
165  *
166  * Returns: %TRUE if valid, %FALSE otherwise.
167  *
168  * Since: 2.26
169  */
170 gboolean
171 g_dbus_is_unique_name (const gchar *string)
172 {
173   gboolean ret;
174   guint len;
175
176   g_return_val_if_fail (string != NULL, FALSE);
177
178   ret = FALSE;
179
180   len = strlen (string);
181   if (G_UNLIKELY (len == 0 || len > 255))
182     goto out;
183
184   if (G_UNLIKELY (*string != ':'))
185     goto out;
186
187   if (G_UNLIKELY (!is_valid_name (string + 1, len - 1, TRUE, TRUE)))
188     goto out;
189
190   ret = TRUE;
191
192  out:
193   return ret;
194 }
195
196 /**
197  * g_dbus_is_member_name:
198  * @string: The string to check.
199  *
200  * Checks if @string is a valid D-Bus member (e.g. signal or method) name.
201  *
202  * Returns: %TRUE if valid, %FALSE otherwise.
203  *
204  * Since: 2.26
205  */
206 gboolean
207 g_dbus_is_member_name (const gchar *string)
208 {
209   gboolean ret;
210   guint n;
211
212   ret = FALSE;
213   if (G_UNLIKELY (string == NULL))
214     goto out;
215
216   if (G_UNLIKELY (!is_valid_initial_bus_name_character (string[0], FALSE, FALSE)))
217     goto out;
218
219   for (n = 1; string[n] != '\0'; n++)
220     {
221       if (G_UNLIKELY (!is_valid_bus_name_character (string[n], FALSE)))
222         {
223           goto out;
224         }
225     }
226
227   ret = TRUE;
228
229  out:
230   return ret;
231 }
232
233 /**
234  * g_dbus_is_interface_name:
235  * @string: The string to check.
236  *
237  * Checks if @string is a valid D-Bus interface name.
238  *
239  * Returns: %TRUE if valid, %FALSE otherwise.
240  *
241  * Since: 2.26
242  */
243 gboolean
244 g_dbus_is_interface_name (const gchar *string)
245 {
246   guint len;
247   gboolean ret;
248   const gchar *s;
249
250   g_return_val_if_fail (string != NULL, FALSE);
251
252   ret = FALSE;
253
254   len = strlen (string);
255   if (G_UNLIKELY (len == 0 || len > 255))
256     goto out;
257
258   s = string;
259   if (G_UNLIKELY (*s == '.'))
260     {
261       /* can't start with a . */
262       goto out;
263     }
264   else if (G_UNLIKELY (!is_valid_initial_bus_name_character (*s, FALSE, FALSE)))
265     goto out;
266
267   ret = is_valid_name (s + 1, len - 1, FALSE, FALSE);
268
269  out:
270   return ret;
271 }
272
273 /* ---------------------------------------------------------------------------------------------------- */
274
275 /* TODO: maybe move to glib? if so, it should conform to http://en.wikipedia.org/wiki/Guid and/or
276  *       http://tools.ietf.org/html/rfc4122 - specifically it should have hyphens then.
277  */
278
279 /**
280  * g_dbus_generate_guid:
281  *
282  * Generate a D-Bus GUID that can be used with
283  * e.g. g_dbus_connection_new().
284  *
285  * See the D-Bus specification regarding what strings are valid D-Bus
286  * GUID (for example, D-Bus GUIDs are not RFC-4122 compliant).
287  *
288  * Returns: A valid D-Bus GUID. Free with g_free().
289  *
290  * Since: 2.26
291  */
292 gchar *
293 g_dbus_generate_guid (void)
294 {
295   GString *s;
296   GTimeVal now;
297   guint32 r1;
298   guint32 r2;
299   guint32 r3;
300
301   s = g_string_new (NULL);
302
303   r1 = g_random_int ();
304   r2 = g_random_int ();
305   r3 = g_random_int ();
306   g_get_current_time (&now);
307
308   g_string_append_printf (s, "%08x", r1);
309   g_string_append_printf (s, "%08x", r2);
310   g_string_append_printf (s, "%08x", r3);
311   g_string_append_printf (s, "%08x", (guint32) now.tv_sec);
312
313   return g_string_free (s, FALSE);
314 }
315
316 /**
317  * g_dbus_is_guid:
318  * @string: The string to check.
319  *
320  * Checks if @string is a D-Bus GUID.
321  *
322  * See the D-Bus specification regarding what strings are valid D-Bus
323  * GUID (for example, D-Bus GUIDs are not RFC-4122 compliant).
324  *
325  * Returns: %TRUE if @string is a guid, %FALSE otherwise.
326  *
327  * Since: 2.26
328  */
329 gboolean
330 g_dbus_is_guid (const gchar *string)
331 {
332   gboolean ret;
333   guint n;
334
335   g_return_val_if_fail (string != NULL, FALSE);
336
337   ret = FALSE;
338
339   for (n = 0; n < 32; n++)
340     {
341       if (!g_ascii_isxdigit (string[n]))
342         goto out;
343     }
344   if (string[32] != '\0')
345     goto out;
346
347   ret = TRUE;
348
349  out:
350   return ret;
351 }
352
353 /* ---------------------------------------------------------------------------------------------------- */
354
355 /**
356  * g_dbus_gvariant_to_gvalue:
357  * @value: A #GVariant.
358  * @out_gvalue: Return location for the #GValue.
359  *
360  * Convert a #GVariant to a #GValue. If @value is floating, it is consumed.
361  *
362  * The rules specified in g_dbus_gvalue_to_gvariant() are used.
363  *
364  * Note that the passed @out_gvalue does not have to have a #GType
365  * set, as it will be initialized to the #GType corresponding to
366  * @value.
367  *
368  * This conversion can never fail.
369  *
370  * Since: 2.30
371  */
372 void
373 g_dbus_gvariant_to_gvalue (GVariant  *value,
374                            GValue    *out_gvalue)
375 {
376   const GVariantType *type;
377   gchar **array;
378
379   g_return_if_fail (value != NULL);
380   g_return_if_fail (out_gvalue != NULL);
381
382   memset (out_gvalue, '\0', sizeof (GValue));
383
384   switch (g_variant_classify (value))
385     {
386     case G_VARIANT_CLASS_BOOLEAN:
387       g_value_init (out_gvalue, G_TYPE_BOOLEAN);
388       g_value_set_boolean (out_gvalue, g_variant_get_boolean (value));
389       break;
390
391     case G_VARIANT_CLASS_BYTE:
392       g_value_init (out_gvalue, G_TYPE_UCHAR);
393       g_value_set_uchar (out_gvalue, g_variant_get_byte (value));
394       break;
395
396     case G_VARIANT_CLASS_INT16:
397       g_value_init (out_gvalue, G_TYPE_INT);
398       g_value_set_int (out_gvalue, g_variant_get_int16 (value));
399       break;
400
401     case G_VARIANT_CLASS_UINT16:
402       g_value_init (out_gvalue, G_TYPE_UINT);
403       g_value_set_uint (out_gvalue, g_variant_get_uint16 (value));
404       break;
405
406     case G_VARIANT_CLASS_INT32:
407       g_value_init (out_gvalue, G_TYPE_INT);
408       g_value_set_int (out_gvalue, g_variant_get_int32 (value));
409       break;
410
411     case G_VARIANT_CLASS_UINT32:
412       g_value_init (out_gvalue, G_TYPE_UINT);
413       g_value_set_uint (out_gvalue, g_variant_get_uint32 (value));
414       break;
415
416     case G_VARIANT_CLASS_INT64:
417       g_value_init (out_gvalue, G_TYPE_INT64);
418       g_value_set_int64 (out_gvalue, g_variant_get_int64 (value));
419       break;
420
421     case G_VARIANT_CLASS_UINT64:
422       g_value_init (out_gvalue, G_TYPE_UINT64);
423       g_value_set_uint64 (out_gvalue, g_variant_get_uint64 (value));
424       break;
425
426     case G_VARIANT_CLASS_HANDLE:
427       g_value_init (out_gvalue, G_TYPE_INT);
428       g_value_set_int (out_gvalue, g_variant_get_int32 (value));
429       break;
430
431     case G_VARIANT_CLASS_DOUBLE:
432       g_value_init (out_gvalue, G_TYPE_DOUBLE);
433       g_value_set_double (out_gvalue, g_variant_get_double (value));
434       break;
435
436     case G_VARIANT_CLASS_STRING:
437       g_value_init (out_gvalue, G_TYPE_STRING);
438       g_value_set_string (out_gvalue, g_variant_get_string (value, NULL));
439       break;
440
441     case G_VARIANT_CLASS_OBJECT_PATH:
442       g_value_init (out_gvalue, G_TYPE_STRING);
443       g_value_set_string (out_gvalue, g_variant_get_string (value, NULL));
444       break;
445
446     case G_VARIANT_CLASS_SIGNATURE:
447       g_value_init (out_gvalue, G_TYPE_STRING);
448       g_value_set_string (out_gvalue, g_variant_get_string (value, NULL));
449       break;
450
451     case G_VARIANT_CLASS_ARRAY:
452       type = g_variant_get_type (value);
453       switch (g_variant_type_peek_string (type)[1])
454         {
455         case G_VARIANT_CLASS_BYTE:
456           g_value_init (out_gvalue, G_TYPE_STRING);
457           g_value_set_string (out_gvalue, g_variant_get_bytestring (value));
458           break;
459
460         case G_VARIANT_CLASS_STRING:
461           g_value_init (out_gvalue, G_TYPE_STRV);
462           array = g_variant_dup_strv (value, NULL);
463           g_value_take_boxed (out_gvalue, array);
464           break;
465
466         case G_VARIANT_CLASS_ARRAY:
467           switch (g_variant_type_peek_string (type)[2])
468             {
469             case G_VARIANT_CLASS_BYTE:
470               g_value_init (out_gvalue, G_TYPE_STRV);
471               array = g_variant_dup_bytestring_array (value, NULL);
472               g_value_take_boxed (out_gvalue, array);
473               break;
474
475             default:
476               g_value_init (out_gvalue, G_TYPE_VARIANT);
477               g_value_set_variant (out_gvalue, value);
478               break;
479             }
480           break;
481
482         default:
483           g_value_init (out_gvalue, G_TYPE_VARIANT);
484           g_value_set_variant (out_gvalue, value);
485           break;
486         }
487       break;
488
489     case G_VARIANT_CLASS_VARIANT:
490     case G_VARIANT_CLASS_MAYBE:
491     case G_VARIANT_CLASS_TUPLE:
492     case G_VARIANT_CLASS_DICT_ENTRY:
493       g_value_init (out_gvalue, G_TYPE_VARIANT);
494       g_value_set_variant (out_gvalue, value);
495       break;
496     }
497 }
498
499
500 /**
501  * g_dbus_gvalue_to_gvariant:
502  * @gvalue: A #GValue to convert to a #GVariant.
503  * @expected_type: The #GVariantType to create.
504  *
505  * Convert a #GValue to #GVariant.
506  *
507  * The conversion is using the following rules:
508  * <table frame='all'>
509  *   <title>#GValue / #GVariant Conversion rules</title>
510  *   <tgroup cols='2' align='left' colsep='1' rowsep='1'>
511  *     <thead>
512  *       <row>
513  *         <entry>If the #GType for @gvalue is...</entry>
514  *         <entry>... then @expected_type must be</entry>
515  *       </row>
516  *     </thead>
517  *     <tbody>
518  *       <row>
519  *         <entry>#G_TYPE_STRING</entry>
520  *         <entry>s, o, g, ay</entry>
521  *       </row>
522  *       <row>
523  *         <entry>#G_TYPE_STRV</entry>
524  *         <entry>as, ao, ag, aay</entry>
525  *       </row>
526  *       <row>
527  *         <entry>#G_TYPE_BOOLEAN</entry>
528  *         <entry>b</entry>
529  *       </row>
530  *       <row>
531  *         <entry>#G_TYPE_UCHAR</entry>
532  *         <entry>y</entry>
533  *       </row>
534  *       <row>
535  *         <entry>#G_TYPE_INT</entry>
536  *         <entry>n</entry>
537  *       </row>
538  *       <row>
539  *         <entry>#G_TYPE_UINT</entry>
540  *         <entry>q</entry>
541  *       </row>
542  *       <row>
543  *         <entry>#G_TYPE_INT</entry>
544  *         <entry>i</entry>
545  *       </row>
546  *       <row>
547  *         <entry>#G_TYPE_UINT</entry>
548  *         <entry>u</entry>
549  *       </row>
550  *       <row>
551  *         <entry>#G_TYPE_INT64</entry>
552  *         <entry>x</entry>
553  *       </row>
554  *       <row>
555  *         <entry>#G_TYPE_UINT64</entry>
556  *         <entry>t</entry>
557  *       </row>
558  *       <row>
559  *         <entry>#G_TYPE_INT</entry>
560  *         <entry>h</entry>
561  *       </row>
562  *       <row>
563  *         <entry>#G_TYPE_DOUBLE</entry>
564  *         <entry>d</entry>
565  *       </row>
566  *       <row>
567  *         <entry>#G_TYPE_VARIANT</entry>
568  *         <entry>Any #GVariantType</entry>
569  *       </row>
570  *     </tbody>
571  *   </tgroup>
572  * </table>
573  * This can fail if e.g. @gvalue is of type #G_TYPE_STRING and
574  * @expected_type is <literal>'i'</literal>. It will also fail for any
575  * #GType (including e.g. #G_TYPE_OBJECT and #G_TYPE_BOXED
576  * derived-types) not in the table above.
577  *
578  * Note that if @gvalue is of type #G_TYPE_VARIANT and its value is
579  * %NULL, the <emphasis>empty</emphasis> #GVariant instance (never
580  * %NULL) for @expected_type is returned (e.g. 0 for scalar types, the
581  * empty string for string types and so on).
582  *
583  * Returns: A #GVariant (never floating) of #GVariantType
584  * @expected_type holding the data from @gvalue or %NULL in case of
585  * failure. Free with g_variant_unref().
586  *
587  * Since: 2.30
588  */
589 GVariant *
590 g_dbus_gvalue_to_gvariant (const GValue         *gvalue,
591                            const GVariantType   *expected_type)
592 {
593   GVariant *ret;
594   const gchar *s;
595   const gchar * const *as;
596   const gchar *empty_strv[1] = {NULL};
597
598   g_return_val_if_fail (gvalue != NULL, NULL);
599   g_return_val_if_fail (expected_type != NULL, NULL);
600
601   ret = NULL;
602
603   /* The expected type could easily be e.g. "s" with the GValue holding a string.
604    * because of the UseGVariant annotation
605    */
606   if (G_VALUE_TYPE (gvalue) == G_TYPE_VARIANT)
607     {
608       ret = g_value_dup_variant (gvalue);
609     }
610   else
611     {
612       switch (g_variant_type_peek_string (expected_type)[0])
613         {
614         case G_VARIANT_CLASS_BOOLEAN:
615           ret = g_variant_ref_sink (g_variant_new_boolean (g_value_get_boolean (gvalue)));
616           break;
617
618         case G_VARIANT_CLASS_BYTE:
619           ret = g_variant_ref_sink (g_variant_new_byte (g_value_get_uchar (gvalue)));
620           break;
621
622         case G_VARIANT_CLASS_INT16:
623           ret = g_variant_ref_sink (g_variant_new_int16 (g_value_get_int (gvalue)));
624           break;
625
626         case G_VARIANT_CLASS_UINT16:
627           ret = g_variant_ref_sink (g_variant_new_uint16 (g_value_get_uint (gvalue)));
628           break;
629
630         case G_VARIANT_CLASS_INT32:
631           ret = g_variant_ref_sink (g_variant_new_int32 (g_value_get_int (gvalue)));
632           break;
633
634         case G_VARIANT_CLASS_UINT32:
635           ret = g_variant_ref_sink (g_variant_new_uint32 (g_value_get_uint (gvalue)));
636           break;
637
638         case G_VARIANT_CLASS_INT64:
639           ret = g_variant_ref_sink (g_variant_new_int64 (g_value_get_int64 (gvalue)));
640           break;
641
642         case G_VARIANT_CLASS_UINT64:
643           ret = g_variant_ref_sink (g_variant_new_uint64 (g_value_get_uint64 (gvalue)));
644           break;
645
646         case G_VARIANT_CLASS_HANDLE:
647           ret = g_variant_ref_sink (g_variant_new_handle (g_value_get_int (gvalue)));
648           break;
649
650         case G_VARIANT_CLASS_DOUBLE:
651           ret = g_variant_ref_sink (g_variant_new_double (g_value_get_double (gvalue)));
652           break;
653
654         case G_VARIANT_CLASS_STRING:
655           s = g_value_get_string (gvalue);
656           if (s == NULL)
657             s = "";
658           ret = g_variant_ref_sink (g_variant_new_string (s));
659           break;
660
661         case G_VARIANT_CLASS_OBJECT_PATH:
662           s = g_value_get_string (gvalue);
663           if (s == NULL)
664             s = "/";
665           ret = g_variant_ref_sink (g_variant_new_object_path (s));
666           break;
667
668         case G_VARIANT_CLASS_SIGNATURE:
669           s = g_value_get_string (gvalue);
670           if (s == NULL)
671             s = "";
672           ret = g_variant_ref_sink (g_variant_new_signature (s));
673           break;
674
675         case G_VARIANT_CLASS_ARRAY:
676           switch (g_variant_type_peek_string (expected_type)[1])
677             {
678             case G_VARIANT_CLASS_BYTE:
679               s = g_value_get_string (gvalue);
680               if (s == NULL)
681                 s = "";
682               ret = g_variant_ref_sink (g_variant_new_bytestring (s));
683               break;
684
685             case G_VARIANT_CLASS_STRING:
686               as = g_value_get_boxed (gvalue);
687               if (as == NULL)
688                 as = empty_strv;
689               ret = g_variant_ref_sink (g_variant_new_strv (as, -1));
690               break;
691
692             case G_VARIANT_CLASS_ARRAY:
693               switch (g_variant_type_peek_string (expected_type)[2])
694                 {
695                 case G_VARIANT_CLASS_BYTE:
696                   as = g_value_get_boxed (gvalue);
697                   if (as == NULL)
698                     as = empty_strv;
699                   ret = g_variant_ref_sink (g_variant_new_bytestring_array (as, -1));
700                   break;
701
702                 default:
703                   ret = g_value_dup_variant (gvalue);
704                   break;
705                 }
706               break;
707
708             default:
709               ret = g_value_dup_variant (gvalue);
710               break;
711             }
712           break;
713
714         default:
715         case G_VARIANT_CLASS_VARIANT:
716         case G_VARIANT_CLASS_MAYBE:
717         case G_VARIANT_CLASS_TUPLE:
718         case G_VARIANT_CLASS_DICT_ENTRY:
719           ret = g_value_dup_variant (gvalue);
720           break;
721         }
722     }
723
724   /* Could be that the GValue is holding a NULL GVariant - in that case,
725    * we return an "empty" GVariant instead of a NULL GVariant
726    */
727   if (ret == NULL)
728     {
729       GVariant *untrusted_empty;
730       untrusted_empty = g_variant_new_from_data (expected_type, NULL, 0, FALSE, NULL, NULL);
731       ret = g_variant_ref_sink (g_variant_get_normal_form (untrusted_empty));
732       g_variant_unref (untrusted_empty);
733     }
734
735   g_assert (!g_variant_is_floating (ret));
736
737   return ret;
738 }