1 /* GDBus - GLib D-Bus Library
3 * Copyright (C) 2008-2009 Red Hat, Inc.
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.
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.
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.
20 * Author: David Zeuthen <davidz@redhat.com>
27 #include "gdbusutils.h"
28 #include "gdbusmessage.h"
29 #include "gdbuserror.h"
30 #include "gioenumtypes.h"
31 #include "ginputstream.h"
32 #include "gdatainputstream.h"
33 #include "gmemoryinputstream.h"
34 #include "goutputstream.h"
35 #include "gdataoutputstream.h"
36 #include "gmemoryoutputstream.h"
37 #include "gseekable.h"
41 #include <sys/types.h>
50 * SECTION:gdbusmessage
51 * @short_description: D-Bus Message
54 * A type for representing D-Bus messages that can be sent or received
55 * on a #GDBusConnection.
58 struct _GDBusMessagePrivate
60 GDBusMessageType type;
61 GDBusMessageFlags flags;
62 guchar major_protocol_version;
71 #define g_dbus_message_get_type g_dbus_message_get_gtype
72 G_DEFINE_TYPE (GDBusMessage, g_dbus_message, G_TYPE_OBJECT);
73 #undef g_dbus_message_get_type
76 g_dbus_message_finalize (GObject *object)
78 GDBusMessage *message = G_DBUS_MESSAGE (object);
80 if (message->priv->headers != NULL)
81 g_hash_table_unref (message->priv->headers);
82 if (message->priv->body != NULL)
83 g_variant_unref (message->priv->body);
85 if (message->priv->fd_list != NULL)
86 g_object_unref (message->priv->fd_list);
89 if (G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize != NULL)
90 G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize (object);
94 g_dbus_message_class_init (GDBusMessageClass *klass)
96 GObjectClass *gobject_class;
98 g_type_class_add_private (klass, sizeof (GDBusMessagePrivate));
100 gobject_class = G_OBJECT_CLASS (klass);
102 gobject_class->finalize = g_dbus_message_finalize;
106 g_dbus_message_init (GDBusMessage *message)
108 message->priv = G_TYPE_INSTANCE_GET_PRIVATE (message, G_TYPE_DBUS_MESSAGE, GDBusMessagePrivate);
110 message->priv->headers = g_hash_table_new_full (g_direct_hash,
113 (GDestroyNotify) g_variant_unref);
117 * g_dbus_message_new:
119 * Creates a new empty #GDBusMessage.
121 * Returns: A #GDBusMessage. Free with g_object_unref().
126 g_dbus_message_new (void)
128 return g_object_new (G_TYPE_DBUS_MESSAGE, NULL);
132 * g_dbus_message_new_method_call:
133 * @name: A valid D-Bus name or %NULL.
134 * @path: A valid object path.
135 * @interface: A valid D-Bus interface name or %NULL.
136 * @method: A valid method name.
138 * Creates a new #GDBusMessage for a method call.
140 * Returns: A #GDBusMessage. Free with g_object_unref().
145 g_dbus_message_new_method_call (const gchar *name,
147 const gchar *interface,
150 GDBusMessage *message;
152 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
153 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
154 g_return_val_if_fail (g_dbus_is_member_name (method), NULL);
155 g_return_val_if_fail (interface == NULL || g_dbus_is_interface_name (interface), NULL);
157 message = g_dbus_message_new ();
158 message->priv->type = G_DBUS_MESSAGE_TYPE_METHOD_CALL;
161 g_dbus_message_set_destination (message, name);
162 g_dbus_message_set_path (message, path);
163 g_dbus_message_set_member (message, method);
164 if (interface != NULL)
165 g_dbus_message_set_interface (message, interface);
171 * g_dbus_message_new_signal:
172 * @path: A valid object path.
173 * @interface: A valid D-Bus interface name or %NULL.
174 * @signal: A valid signal name.
176 * Creates a new #GDBusMessage for a signal emission.
178 * Returns: A #GDBusMessage. Free with g_object_unref().
183 g_dbus_message_new_signal (const gchar *path,
184 const gchar *interface,
187 GDBusMessage *message;
189 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
190 g_return_val_if_fail (g_dbus_is_member_name (signal), NULL);
191 g_return_val_if_fail (interface == NULL || g_dbus_is_interface_name (interface), NULL);
193 message = g_dbus_message_new ();
194 message->priv->type = G_DBUS_MESSAGE_TYPE_SIGNAL;
195 message->priv->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
197 g_dbus_message_set_path (message, path);
198 g_dbus_message_set_member (message, signal);
200 if (interface != NULL)
201 g_dbus_message_set_interface (message, interface);
208 * g_dbus_message_new_method_reply:
209 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
210 * create a reply message to.
212 * Creates a new #GDBusMessage that is a reply to @method_call_message.
214 * Returns: A #GDBusMessage. Free with g_object_unref().
219 g_dbus_message_new_method_reply (GDBusMessage *method_call_message)
221 GDBusMessage *message;
224 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
225 g_return_val_if_fail (g_dbus_message_get_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
226 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
228 message = g_dbus_message_new ();
229 message->priv->type = G_DBUS_MESSAGE_TYPE_METHOD_RETURN;
230 message->priv->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
232 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
233 sender = g_dbus_message_get_sender (method_call_message);
235 g_dbus_message_set_destination (message, sender);
241 * g_dbus_message_new_method_error:
242 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
243 * create a reply message to.
244 * @error_name: A valid D-Bus error name.
245 * @error_message_format: The D-Bus error message in a printf() format.
246 * @...: Arguments for @error_message_format.
248 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
250 * Returns: A #GDBusMessage. Free with g_object_unref().
255 g_dbus_message_new_method_error (GDBusMessage *method_call_message,
256 const gchar *error_name,
257 const gchar *error_message_format,
263 va_start (var_args, error_message_format);
264 ret = g_dbus_message_new_method_error_valist (method_call_message,
266 error_message_format,
274 * g_dbus_message_new_method_error_literal:
275 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
276 * create a reply message to.
277 * @error_name: A valid D-Bus error name.
278 * @error_message: The D-Bus error message.
280 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
282 * Returns: A #GDBusMessage. Free with g_object_unref().
287 g_dbus_message_new_method_error_literal (GDBusMessage *method_call_message,
288 const gchar *error_name,
289 const gchar *error_message)
291 GDBusMessage *message;
294 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
295 g_return_val_if_fail (g_dbus_message_get_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
296 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
297 g_return_val_if_fail (g_dbus_is_name (error_name), NULL);
298 g_return_val_if_fail (error_message != NULL, NULL);
300 message = g_dbus_message_new ();
301 message->priv->type = G_DBUS_MESSAGE_TYPE_ERROR;
302 message->priv->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
304 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
305 g_dbus_message_set_error_name (message, error_name);
306 g_dbus_message_set_body (message, g_variant_new ("(s)", error_message));
308 sender = g_dbus_message_get_sender (method_call_message);
310 g_dbus_message_set_destination (message, sender);
316 * g_dbus_message_new_method_error_valist:
317 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
318 * create a reply message to.
319 * @error_name: A valid D-Bus error name.
320 * @error_message_format: The D-Bus error message in a printf() format.
321 * @var_args: Arguments for @error_message_format.
323 * Like g_dbus_message_new_method_error() but intended for language bindings.
325 * Returns: A #GDBusMessage. Free with g_object_unref().
330 g_dbus_message_new_method_error_valist (GDBusMessage *method_call_message,
331 const gchar *error_name,
332 const gchar *error_message_format,
336 gchar *error_message;
337 error_message = g_strdup_vprintf (error_message_format, var_args);
338 ret = g_dbus_message_new_method_error_literal (method_call_message,
341 g_free (error_message);
345 /* ---------------------------------------------------------------------------------------------------- */
347 /* TODO: need GI annotations to specify that any guchar value goes for the type */
350 * g_dbus_message_get_type:
351 * @message: A #GDBusMessage.
353 * Gets the type of @message.
355 * Returns: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
360 g_dbus_message_get_type (GDBusMessage *message)
362 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_TYPE_INVALID);
363 return message->priv->type;
367 * g_dbus_message_set_type:
368 * @message: A #GDBusMessage.
369 * @type: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
371 * Sets @message to be of @type.
376 g_dbus_message_set_type (GDBusMessage *message,
377 GDBusMessageType type)
379 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
380 g_return_if_fail (type >=0 && type < 256);
381 message->priv->type = type;
384 /* ---------------------------------------------------------------------------------------------------- */
386 /* TODO: need GI annotations to specify that any guchar value goes for flags */
389 * g_dbus_message_get_flags:
390 * @message: A #GDBusMessage.
392 * Gets the flags for @message.
394 * Returns: Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).
399 g_dbus_message_get_flags (GDBusMessage *message)
401 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_FLAGS_NONE);
402 return message->priv->flags;
406 * g_dbus_message_set_flags:
407 * @message: A #GDBusMessage.
408 * @flags: Flags for @message that are set (typically values from the #GDBusMessageFlags
409 * enumeration bitwise ORed together).
411 * Sets the flags to set on @message.
416 g_dbus_message_set_flags (GDBusMessage *message,
417 GDBusMessageFlags flags)
419 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
420 g_return_if_fail (flags >=0 && flags < 256);
421 message->priv->flags = flags;
424 /* ---------------------------------------------------------------------------------------------------- */
427 * g_dbus_message_get_serial:
428 * @message: A #GDBusMessage.
430 * Gets the serial for @message.
432 * Returns: A #guint32.
437 g_dbus_message_get_serial (GDBusMessage *message)
439 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
440 return message->priv->serial;
444 * g_dbus_message_set_serial:
445 * @message: A #GDBusMessage.
446 * @serial: A #guint32.
448 * Sets the serial for @message.
453 g_dbus_message_set_serial (GDBusMessage *message,
456 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
457 message->priv->serial = serial;
460 /* ---------------------------------------------------------------------------------------------------- */
462 /* TODO: need GI annotations to specify that any guchar value goes for header_field */
465 * g_dbus_message_get_header:
466 * @message: A #GDBusMessage.
467 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
469 * Gets a header field on @message.
471 * Returns: A #GVariant with the value if the header was found, %NULL
472 * otherwise. Do not free, it is owned by @message.
477 g_dbus_message_get_header (GDBusMessage *message,
478 GDBusMessageHeaderField header_field)
480 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
481 g_return_val_if_fail (header_field >=0 && header_field < 256, NULL);
482 return g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
486 * g_dbus_message_set_header:
487 * @message: A #GDBusMessage.
488 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
489 * @value: A #GVariant to set the header field or %NULL to clear the header field.
491 * Sets a header field on @message.
493 * If @value is floating, @message assumes ownership of @value.
498 g_dbus_message_set_header (GDBusMessage *message,
499 GDBusMessageHeaderField header_field,
502 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
503 g_return_if_fail (header_field >=0 && header_field < 256);
506 g_hash_table_remove (message->priv->headers, GUINT_TO_POINTER (header_field));
510 g_hash_table_insert (message->priv->headers, GUINT_TO_POINTER (header_field), g_variant_ref_sink (value));
515 * g_dbus_message_get_header_fields:
516 * @message: A #GDBusMessage.
518 * Gets an array of all header fields on @message that are set.
520 * Returns: An array of header fields terminated by
521 * %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a
522 * #guchar. Free with g_free().
527 g_dbus_message_get_header_fields (GDBusMessage *message)
535 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
537 keys = g_hash_table_get_keys (message->priv->headers);
538 num_keys = g_list_length (keys);
539 ret = g_new (guchar, num_keys + 1);
540 for (l = keys, n = 0; l != NULL; l = l->next, n++)
541 ret[n] = GPOINTER_TO_UINT (l->data);
542 g_assert (n == num_keys);
543 ret[n] = G_DBUS_MESSAGE_HEADER_FIELD_INVALID;
549 /* ---------------------------------------------------------------------------------------------------- */
552 * g_dbus_message_get_body:
553 * @message: A #GDBusMessage.
555 * Gets the body of a message.
557 * Returns: A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message.
562 g_dbus_message_get_body (GDBusMessage *message)
564 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
565 return message->priv->body;
569 * g_dbus_message_set_body:
570 * @message: A #GDBusMessage.
571 * @body: Either %NULL or a #GVariant that is a tuple.
573 * Sets the body @message. As a side-effect the
574 * %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the
575 * type string of @body (or cleared if @body is %NULL).
577 * If @body is floating, @message assumes ownership of @body.
582 g_dbus_message_set_body (GDBusMessage *message,
585 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
586 g_return_if_fail ((body == NULL) || g_variant_is_of_type (body, G_VARIANT_TYPE_TUPLE));
588 if (message->priv->body != NULL)
589 g_variant_unref (message->priv->body);
592 message->priv->body = NULL;
593 g_dbus_message_set_signature (message, NULL);
597 const gchar *type_string;
598 gsize type_string_len;
601 message->priv->body = g_variant_ref_sink (body);
603 type_string = g_variant_get_type_string (body);
604 type_string_len = strlen (type_string);
605 g_assert (type_string_len >= 2);
606 signature = g_strndup (type_string + 1, type_string_len - 2);
607 g_dbus_message_set_signature (message, signature);
612 /* ---------------------------------------------------------------------------------------------------- */
616 * g_dbus_message_get_unix_fd_list:
617 * @message: A #GDBusMessage.
619 * Gets the UNIX file descriptors associated with @message, if any.
621 * This method is only available on UNIX.
623 * Returns: A #GUnixFDList or %NULL if no file descriptors are
624 * associated. Do not free, this object is owned by @message.
629 g_dbus_message_get_unix_fd_list (GDBusMessage *message)
631 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
632 return message->priv->fd_list;
636 * g_dbus_message_set_unix_fd_list:
637 * @message: A #GDBusMessage.
638 * @fd_list: A #GUnixFDList or %NULL.
640 * Sets the UNIX file descriptors associated with @message. As a
641 * side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header
642 * field is set to the number of fds in @fd_list (or cleared if
643 * @fd_list is %NULL).
645 * This method is only available on UNIX.
650 g_dbus_message_set_unix_fd_list (GDBusMessage *message,
651 GUnixFDList *fd_list)
653 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
654 g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
655 if (message->priv->fd_list != NULL)
656 g_object_unref (message->priv->fd_list);
659 message->priv->fd_list = g_object_ref (fd_list);
660 g_dbus_message_set_num_unix_fds (message, g_unix_fd_list_get_length (fd_list));
664 message->priv->fd_list = NULL;
665 g_dbus_message_set_num_unix_fds (message, 0);
670 /* ---------------------------------------------------------------------------------------------------- */
673 ensure_input_padding (GMemoryInputStream *mis,
680 offset = g_seekable_tell (G_SEEKABLE (mis));
681 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
683 return g_seekable_seek (G_SEEKABLE (mis), wanted_offset, G_SEEK_SET, NULL, error);
687 read_string (GMemoryInputStream *mis,
688 GDataInputStream *dis,
698 s = g_string_new (NULL);
701 while (remaining > 0)
706 to_read = MIN (remaining, sizeof (buf));
707 num_read = g_input_stream_read (G_INPUT_STREAM (mis),
718 G_IO_ERROR_INVALID_ARGUMENT,
719 _("Wanted to read %" G_GSIZE_FORMAT " bytes but got EOF"),
724 remaining -= num_read;
725 g_string_append_len (s, buf, num_read);
729 nul = g_data_input_stream_read_byte (dis, NULL, &local_error);
730 if (local_error != NULL)
732 g_propagate_error (error, local_error);
739 G_IO_ERROR_INVALID_ARGUMENT,
740 _("Expected NUL byte after the string `%s' but found `%c' (%d)"),
745 return g_string_free (s, FALSE);
748 g_string_free (s, TRUE);
753 parse_value_from_blob (GMemoryInputStream *mis,
754 GDataInputStream *dis,
755 const GVariantType *type,
762 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
765 if (!ensure_input_padding (mis, 4, &local_error))
767 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
768 if (local_error != NULL)
770 ret = g_variant_new_boolean (v);
772 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
775 v = g_data_input_stream_read_byte (dis, NULL, &local_error);
776 if (local_error != NULL)
778 ret = g_variant_new_byte (v);
780 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
783 if (!ensure_input_padding (mis, 2, &local_error))
785 v = g_data_input_stream_read_int16 (dis, NULL, &local_error);
786 if (local_error != NULL)
788 ret = g_variant_new_int16 (v);
790 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
793 if (!ensure_input_padding (mis, 2, &local_error))
795 v = g_data_input_stream_read_uint16 (dis, NULL, &local_error);
796 if (local_error != NULL)
798 ret = g_variant_new_uint16 (v);
800 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
803 if (!ensure_input_padding (mis, 4, &local_error))
805 v = g_data_input_stream_read_int32 (dis, NULL, &local_error);
806 if (local_error != NULL)
808 ret = g_variant_new_int32 (v);
810 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
813 if (!ensure_input_padding (mis, 4, &local_error))
815 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
816 if (local_error != NULL)
818 ret = g_variant_new_uint32 (v);
820 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
823 if (!ensure_input_padding (mis, 8, &local_error))
825 v = g_data_input_stream_read_int64 (dis, NULL, &local_error);
826 if (local_error != NULL)
828 ret = g_variant_new_int64 (v);
830 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
833 if (!ensure_input_padding (mis, 8, &local_error))
835 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
836 if (local_error != NULL)
838 ret = g_variant_new_uint64 (v);
840 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
844 if (!ensure_input_padding (mis, 8, &local_error))
846 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
847 if (local_error != NULL)
850 encoded = (gdouble *) &v;
851 ret = g_variant_new_double (*encoded);
853 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
857 if (!ensure_input_padding (mis, 4, &local_error))
859 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
860 if (local_error != NULL)
862 v = read_string (mis, dis, (gsize) len, &local_error);
865 ret = g_variant_new_string (v);
867 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
871 if (!ensure_input_padding (mis, 4, &local_error))
873 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
874 if (local_error != NULL)
876 v = read_string (mis, dis, (gsize) len, &local_error);
879 if (!g_variant_is_object_path (v))
881 g_set_error (&local_error,
883 G_IO_ERROR_INVALID_ARGUMENT,
884 _("Parsed value `%s' is not a valid D-Bus object path"),
888 ret = g_variant_new_object_path (v);
890 else if (g_variant_type_equal (type, G_VARIANT_TYPE_SIGNATURE))
894 len = g_data_input_stream_read_byte (dis, NULL, &local_error);
895 if (local_error != NULL)
897 v = read_string (mis, dis, (gsize) len, &local_error);
900 if (!g_variant_is_signature (v))
902 g_set_error (&local_error,
904 G_IO_ERROR_INVALID_ARGUMENT,
905 _("Parsed value `%s' is not a valid D-Bus signature"),
909 ret = g_variant_new_signature (v);
911 else if (g_variant_type_is_array (type))
916 const GVariantType *element_type;
917 GVariantBuilder *builder;
919 if (!ensure_input_padding (mis, 4, &local_error))
921 array_len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
923 if (array_len > (2<<26))
925 g_set_error (&local_error,
927 G_IO_ERROR_INVALID_ARGUMENT,
928 _("Encountered array of length %" G_GUINT32_FORMAT " bytes. Maximum length is 2<<26 bytes."),
933 builder = g_variant_builder_new (type);
934 element_type = g_variant_type_element (type);
936 /* TODO: optimize array of primitive types */
938 offset = g_seekable_tell (G_SEEKABLE (mis));
939 target = offset + array_len;
940 while (offset < target)
943 item = parse_value_from_blob (mis, dis, element_type, &local_error);
946 g_variant_builder_unref (builder);
949 g_variant_builder_add_value (builder, item);
950 offset = g_seekable_tell (G_SEEKABLE (mis));
953 ret = g_variant_builder_end (builder);
955 else if (g_variant_type_is_dict_entry (type))
957 const GVariantType *key_type;
958 const GVariantType *value_type;
962 if (!ensure_input_padding (mis, 8, &local_error))
965 key_type = g_variant_type_key (type);
966 key = parse_value_from_blob (mis, dis, key_type, &local_error);
970 value_type = g_variant_type_value (type);
971 value = parse_value_from_blob (mis, dis, value_type, &local_error);
974 g_variant_unref (key);
977 ret = g_variant_new_dict_entry (key, value);
979 else if (g_variant_type_is_tuple (type))
981 const GVariantType *element_type;
982 GVariantBuilder *builder;
984 if (!ensure_input_padding (mis, 8, &local_error))
987 builder = g_variant_builder_new (type);
988 element_type = g_variant_type_first (type);
989 while (element_type != NULL)
992 item = parse_value_from_blob (mis, dis, element_type, &local_error);
995 g_variant_builder_unref (builder);
998 g_variant_builder_add_value (builder, item);
1000 element_type = g_variant_type_next (element_type);
1002 ret = g_variant_builder_end (builder);
1004 else if (g_variant_type_is_variant (type))
1008 GVariantType *variant_type;
1011 siglen = g_data_input_stream_read_byte (dis, NULL, &local_error);
1012 if (local_error != NULL)
1014 sig = read_string (mis, dis, (gsize) siglen, &local_error);
1017 if (!g_variant_is_signature (sig))
1019 g_set_error (&local_error,
1021 G_IO_ERROR_INVALID_ARGUMENT,
1022 _("Parsed value `%s' for variant is not a valid D-Bus signature"),
1026 variant_type = g_variant_type_new (sig);
1027 value = parse_value_from_blob (mis, dis, variant_type, &local_error);
1028 g_variant_type_free (variant_type);
1031 ret = g_variant_new_variant (value);
1036 s = g_variant_type_dup_string (type);
1037 g_set_error (&local_error,
1039 G_IO_ERROR_INVALID_ARGUMENT,
1040 _("Error deserializing GVariant with type-string `%s' from the D-Bus wire format"),
1046 g_assert (ret != NULL);
1050 g_propagate_error (error, local_error);
1054 /* ---------------------------------------------------------------------------------------------------- */
1056 /* message_header must be at least 16 bytes */
1059 * g_dbus_message_bytes_needed:
1060 * @blob: A blob represent a binary D-Bus message.
1061 * @blob_len: The length of @blob (must be at least 16).
1062 * @error: Return location for error or %NULL.
1064 * Utility function to calculate how many bytes are needed to
1065 * completely deserialize the D-Bus message stored at @blob.
1067 * Returns: Number of bytes needed or -1 if @error is set (e.g. if
1068 * @blob contains invalid data or not enough data is available to
1069 * determine the size).
1074 g_dbus_message_bytes_needed (guchar *blob,
1082 g_return_val_if_fail (blob != NULL, -1);
1083 g_return_val_if_fail (error == NULL || *error == NULL, -1);
1084 g_return_val_if_fail (blob_len >= 16, -1);
1088 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1089 ret = 12 + 4 + GUINT32_FROM_LE (((guint32 *) blob)[3]);
1090 /* round up so it's a multiple of 8 */
1091 ret = 8 * ((ret + 7)/8);
1092 /* finally add the body size */
1093 ret += GUINT32_FROM_LE (((guint32 *) blob)[1]);
1095 else if (blob[0] == 'B')
1098 g_assert_not_reached ();
1104 G_IO_ERROR_INVALID_ARGUMENT,
1105 "Unable to determine message blob length - given blob is malformed");
1112 G_IO_ERROR_INVALID_ARGUMENT,
1113 "Blob indicates that message exceeds maximum message length (128MiB)");
1120 /* ---------------------------------------------------------------------------------------------------- */
1123 * g_dbus_message_new_from_blob:
1124 * @blob: A blob represent a binary D-Bus message.
1125 * @blob_len: The length of @blob.
1126 * @error: Return location for error or %NULL.
1128 * Creates a new #GDBusMessage from the data stored at @blob.
1130 * Returns: A new #GDBusMessage or %NULL if @error is set. Free with
1136 g_dbus_message_new_from_blob (guchar *blob,
1141 GMemoryInputStream *mis;
1142 GDataInputStream *dis;
1143 GDBusMessage *message;
1145 guchar major_protocol_version;
1146 GDataStreamByteOrder byte_order;
1147 guint32 message_body_len;
1151 GVariant *signature;
1155 g_return_val_if_fail (blob != NULL, NULL);
1156 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1157 g_return_val_if_fail (blob_len >= 12, NULL);
1159 message = g_dbus_message_new ();
1161 mis = G_MEMORY_INPUT_STREAM (g_memory_input_stream_new_from_data (blob, blob_len, NULL));
1162 dis = g_data_input_stream_new (G_INPUT_STREAM (mis));
1164 endianness = g_data_input_stream_read_byte (dis, NULL, NULL);
1168 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1171 byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
1176 G_IO_ERROR_INVALID_ARGUMENT,
1177 _("Invalid endianness value. Expected 'l' or 'B' but found '%c' (%d)"),
1178 endianness, endianness);
1181 g_data_input_stream_set_byte_order (dis, byte_order);
1183 message->priv->type = g_data_input_stream_read_byte (dis, NULL, NULL);
1184 message->priv->flags = g_data_input_stream_read_byte (dis, NULL, NULL);
1185 major_protocol_version = g_data_input_stream_read_byte (dis, NULL, NULL);
1186 if (major_protocol_version != 1)
1190 G_IO_ERROR_INVALID_ARGUMENT,
1191 _("Invalid major protocol version. Expected 1 but found %d"),
1192 major_protocol_version);
1195 message_body_len = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1196 message->priv->serial = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1198 headers = parse_value_from_blob (mis,
1200 G_VARIANT_TYPE ("a{yv}"),
1202 if (headers == NULL)
1204 g_variant_ref_sink (headers);
1205 g_variant_iter_init (&iter, headers);
1206 while ((item = g_variant_iter_next_value (&iter)))
1208 guchar header_field;
1210 g_variant_get (item,
1214 g_dbus_message_set_header (message, header_field, value);
1216 g_variant_unref (headers);
1218 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
1219 if (signature != NULL)
1221 const gchar *signature_str;
1222 gsize signature_str_len;
1224 signature_str = g_variant_get_string (signature, NULL);
1225 signature_str_len = strlen (signature_str);
1227 /* signature but no body */
1228 if (message_body_len == 0 && signature_str_len > 0)
1232 G_IO_ERROR_INVALID_ARGUMENT,
1233 _("Signature header with signature `%s' found but message body is empty"),
1237 else if (signature_str_len > 0)
1239 GVariantType *variant_type;
1240 gchar *tupled_signature_str;
1242 if (!g_variant_is_signature (signature_str))
1246 G_IO_ERROR_INVALID_ARGUMENT,
1247 _("Parsed value `%s' is not a valid D-Bus signature (for body)"),
1251 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
1252 variant_type = g_variant_type_new (tupled_signature_str);
1253 g_free (tupled_signature_str);
1254 message->priv->body = parse_value_from_blob (mis,
1258 if (message->priv->body == NULL)
1260 g_variant_type_free (variant_type);
1263 g_variant_ref_sink (message->priv->body);
1264 g_variant_type_free (variant_type);
1269 /* no signature, this is only OK if the body is empty */
1270 if (message_body_len != 0)
1274 G_IO_ERROR_INVALID_ARGUMENT,
1275 _("No signature header in message but the message body is %" G_GUINT32_FORMAT " bytes"),
1285 g_object_unref (dis);
1286 g_object_unref (mis);
1294 if (message != NULL)
1295 g_object_unref (message);
1300 /* ---------------------------------------------------------------------------------------------------- */
1303 ensure_output_padding (GMemoryOutputStream *mos,
1304 GDataOutputStream *dos,
1308 gsize wanted_offset;
1309 gsize padding_needed;
1312 offset = g_memory_output_stream_get_data_size (mos);
1313 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
1314 padding_needed = wanted_offset - offset;
1316 for (n = 0; n < padding_needed; n++)
1317 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1319 return padding_needed;
1323 append_value_to_blob (GVariant *value,
1324 GMemoryOutputStream *mos,
1325 GDataOutputStream *dos,
1326 gsize *out_padding_added,
1329 const GVariantType *type;
1330 gsize padding_added;
1334 type = g_variant_get_type (value);
1335 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
1337 gboolean v = g_variant_get_boolean (value);
1338 padding_added = ensure_output_padding (mos, dos, 4);
1339 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1341 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1343 guint8 v = g_variant_get_byte (value);
1344 g_data_output_stream_put_byte (dos, v, NULL, NULL);
1346 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
1348 gint16 v = g_variant_get_int16 (value);
1349 padding_added = ensure_output_padding (mos, dos, 2);
1350 g_data_output_stream_put_int16 (dos, v, NULL, NULL);
1352 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
1354 guint16 v = g_variant_get_uint16 (value);
1355 padding_added = ensure_output_padding (mos, dos, 2);
1356 g_data_output_stream_put_uint16 (dos, v, NULL, NULL);
1358 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
1360 gint32 v = g_variant_get_int32 (value);
1361 padding_added = ensure_output_padding (mos, dos, 4);
1362 g_data_output_stream_put_int32 (dos, v, NULL, NULL);
1364 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
1366 guint32 v = g_variant_get_uint32 (value);
1367 padding_added = ensure_output_padding (mos, dos, 4);
1368 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1370 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
1372 gint64 v = g_variant_get_int64 (value);
1373 padding_added = ensure_output_padding (mos, dos, 8);
1374 g_data_output_stream_put_int64 (dos, v, NULL, NULL);
1376 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
1378 guint64 v = g_variant_get_uint64 (value);
1379 padding_added = ensure_output_padding (mos, dos, 8);
1380 g_data_output_stream_put_uint64 (dos, v, NULL, NULL);
1382 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
1385 gdouble v = g_variant_get_double (value);
1386 padding_added = ensure_output_padding (mos, dos, 8);
1388 encoded = (guint64 *) &v;
1389 g_data_output_stream_put_uint64 (dos, *encoded, NULL, NULL);
1391 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
1393 const gchar *v = g_variant_get_string (value, NULL);
1395 padding_added = ensure_output_padding (mos, dos, 4);
1397 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1398 g_data_output_stream_put_string (dos, v, NULL, NULL);
1399 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1401 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
1403 /* TODO: validate object path */
1404 const gchar *v = g_variant_get_string (value, NULL);
1406 padding_added = ensure_output_padding (mos, dos, 4);
1408 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1409 g_data_output_stream_put_string (dos, v, NULL, NULL);
1410 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1412 else if (g_variant_type_equal (type, G_VARIANT_TYPE_SIGNATURE))
1414 /* TODO: validate signature (including max len being 255) */
1415 const gchar *v = g_variant_get_string (value, NULL);
1418 g_data_output_stream_put_byte (dos, len, NULL, NULL);
1419 g_data_output_stream_put_string (dos, v, NULL, NULL);
1420 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1422 else if (g_variant_type_is_array (type))
1426 goffset array_len_offset;
1427 goffset array_payload_begin_offset;
1432 padding_added = ensure_output_padding (mos, dos, 4);
1434 /* array length - will be filled in later */
1435 array_len_offset = g_memory_output_stream_get_data_size (mos);
1436 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
1438 /* From the D-Bus spec:
1440 * "A UINT32 giving the length of the array data in bytes,
1441 * followed by alignment padding to the alignment boundary of
1442 * the array element type, followed by each array element. The
1443 * array length is from the end of the alignment padding to
1444 * the end of the last element, i.e. it does not include the
1445 * padding after the length, or any padding after the last
1448 * Thus, we need to count how much padding the first element
1449 * contributes and subtract that from the array length.
1451 array_payload_begin_offset = g_memory_output_stream_get_data_size (mos);
1453 g_variant_iter_init (&iter, value);
1455 while ((item = g_variant_iter_next_value (&iter)))
1457 gsize padding_added_for_item;
1458 if (!append_value_to_blob (item, mos, dos, &padding_added_for_item, error))
1462 array_payload_begin_offset += padding_added_for_item;
1467 cur_offset = g_memory_output_stream_get_data_size (mos);
1469 array_len = cur_offset - array_payload_begin_offset;
1471 if (!g_seekable_seek (G_SEEKABLE (mos), array_len_offset, G_SEEK_SET, NULL, error))
1474 g_data_output_stream_put_uint32 (dos, array_len, NULL, NULL);
1476 if (!g_seekable_seek (G_SEEKABLE (mos), cur_offset, G_SEEK_SET, NULL, error))
1479 else if (g_variant_type_is_dict_entry (type) || g_variant_type_is_tuple (type))
1484 padding_added = ensure_output_padding (mos, dos, 8);
1486 g_variant_iter_init (&iter, value);
1488 while ((item = g_variant_iter_next_value (&iter)))
1490 if (!append_value_to_blob (item, mos, dos, NULL, error))
1494 else if (g_variant_type_is_variant (type))
1497 const gchar *signature;
1498 child = g_variant_get_child_value (value, 0);
1499 signature = g_variant_get_type_string (child);
1500 /* TODO: validate signature (including max len being 255) */
1501 g_data_output_stream_put_byte (dos, strlen (signature), NULL, NULL);
1502 g_data_output_stream_put_string (dos, signature, NULL, NULL);
1503 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1504 if (!append_value_to_blob (child, mos, dos, NULL, error))
1506 g_variant_unref (child);
1509 g_variant_unref (child);
1515 G_IO_ERROR_INVALID_ARGUMENT,
1516 _("Error serializing GVariant with type-string `%s' to the D-Bus wire format"),
1517 g_variant_get_type_string (value));
1521 if (out_padding_added != NULL)
1522 *out_padding_added = padding_added;
1531 append_body_to_blob (GVariant *value,
1532 GMemoryOutputStream *mos,
1533 GDataOutputStream *dos,
1542 if (!g_variant_is_of_type (value, G_VARIANT_TYPE_TUPLE))
1546 G_IO_ERROR_INVALID_ARGUMENT,
1547 "Expected a tuple for the body of the GDBusMessage.");
1551 g_variant_iter_init (&iter, value);
1552 while ((item = g_variant_iter_next_value (&iter)))
1554 if (!append_value_to_blob (item, mos, dos, NULL, error))
1563 /* ---------------------------------------------------------------------------------------------------- */
1566 * g_dbus_message_to_blob:
1567 * @message: A #GDBusMessage.
1568 * @out_size: Return location for size of generated blob.
1569 * @error: Return location for error.
1571 * Serializes @message to a blob.
1573 * Returns: A pointer to a valid binary D-Bus message of @out_size bytes
1574 * generated by @message or %NULL if @error is set. Free with g_free().
1579 g_dbus_message_to_blob (GDBusMessage *message,
1583 GMemoryOutputStream *mos;
1584 GDataOutputStream *dos;
1587 GDataStreamByteOrder byte_order;
1588 goffset body_len_offset;
1589 goffset body_start_offset;
1591 GVariant *header_fields;
1592 GVariantBuilder *builder;
1593 GHashTableIter hash_iter;
1595 GVariant *header_value;
1596 GVariant *signature;
1597 const gchar *signature_str;
1598 gint num_fds_in_message;
1599 gint num_fds_according_to_header;
1603 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1604 g_return_val_if_fail (out_size != NULL, NULL);
1605 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1607 mos = G_MEMORY_OUTPUT_STREAM (g_memory_output_stream_new (NULL, 0, g_realloc, g_free));
1608 dos = g_data_output_stream_new (G_OUTPUT_STREAM (mos));
1610 /* TODO: detect endianess... */
1611 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1612 g_data_output_stream_set_byte_order (dos, byte_order);
1615 g_data_output_stream_put_byte (dos, byte_order == G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN ? 'l' : 'B', NULL, NULL);
1616 g_data_output_stream_put_byte (dos, message->priv->type, NULL, NULL);
1617 g_data_output_stream_put_byte (dos, message->priv->flags, NULL, NULL);
1618 g_data_output_stream_put_byte (dos, 1, NULL, NULL); /* major protocol version */
1619 body_len_offset = g_memory_output_stream_get_data_size (mos);
1620 /* body length - will be filled in later */
1621 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
1622 g_data_output_stream_put_uint32 (dos, message->priv->serial, NULL, NULL);
1624 num_fds_in_message = 0;
1626 if (message->priv->fd_list != NULL)
1627 num_fds_in_message = g_unix_fd_list_get_length (message->priv->fd_list);
1629 num_fds_according_to_header = g_dbus_message_get_num_unix_fds (message);
1630 /* TODO: check we have all the right header fields and that they are the correct value etc etc */
1631 if (num_fds_in_message != num_fds_according_to_header)
1635 G_IO_ERROR_INVALID_ARGUMENT,
1636 _("Message has %d fds but the header field indicates %d fds"),
1638 num_fds_according_to_header);
1642 builder = g_variant_builder_new (G_VARIANT_TYPE ("a{yv}"));//G_VARIANT_TYPE_ARRAY);
1643 g_hash_table_iter_init (&hash_iter, message->priv->headers);
1644 while (g_hash_table_iter_next (&hash_iter, &key, (gpointer) &header_value))
1646 g_variant_builder_add (builder,
1648 (guchar) GPOINTER_TO_UINT (key),
1651 header_fields = g_variant_new ("a{yv}", builder);
1653 if (!append_value_to_blob (header_fields, mos, dos, NULL, error))
1655 g_variant_unref (header_fields);
1658 g_variant_unref (header_fields);
1660 /* header size must be a multiple of 8 */
1661 ensure_output_padding (mos, dos, 8);
1663 body_start_offset = g_memory_output_stream_get_data_size (mos);
1665 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
1666 signature_str = NULL;
1667 if (signature != NULL)
1668 signature_str = g_variant_get_string (signature, NULL);
1669 if (message->priv->body != NULL)
1671 gchar *tupled_signature_str;
1672 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
1673 if (signature == NULL)
1677 G_IO_ERROR_INVALID_ARGUMENT,
1678 _("Message body has signature `%s' but there is no signature header"),
1680 g_free (tupled_signature_str);
1683 else if (g_strcmp0 (tupled_signature_str, g_variant_get_type_string (message->priv->body)) != 0)
1687 G_IO_ERROR_INVALID_ARGUMENT,
1688 _("Message body has type signature `%s' but signature in the header field is `%s'"),
1689 tupled_signature_str, g_variant_get_type_string (message->priv->body));
1690 g_free (tupled_signature_str);
1693 g_free (tupled_signature_str);
1694 if (!append_body_to_blob (message->priv->body, mos, dos, error))
1699 if (signature != NULL)
1703 G_IO_ERROR_INVALID_ARGUMENT,
1704 _("Message body is empty but signature in the header field is `(%s)'"),
1710 /* OK, we're done writing the message - set the body length */
1711 size = g_memory_output_stream_get_data_size (mos);
1712 body_size = size - body_start_offset;
1714 if (!g_seekable_seek (G_SEEKABLE (mos), body_len_offset, G_SEEK_SET, NULL, error))
1717 g_data_output_stream_put_uint32 (dos, body_size, NULL, NULL);
1720 ret = g_memdup (g_memory_output_stream_get_data (mos), size);
1723 g_object_unref (dos);
1724 g_object_unref (mos);
1729 /* ---------------------------------------------------------------------------------------------------- */
1732 get_uint32_header (GDBusMessage *message,
1733 GDBusMessageHeaderField header_field)
1739 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
1740 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_UINT32))
1741 ret = g_variant_get_uint32 (value);
1746 static const gchar *
1747 get_string_header (GDBusMessage *message,
1748 GDBusMessageHeaderField header_field)
1754 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
1755 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
1756 ret = g_variant_get_string (value, NULL);
1761 static const gchar *
1762 get_object_path_header (GDBusMessage *message,
1763 GDBusMessageHeaderField header_field)
1769 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
1770 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_OBJECT_PATH))
1771 ret = g_variant_get_string (value, NULL);
1776 static const gchar *
1777 get_signature_header (GDBusMessage *message,
1778 GDBusMessageHeaderField header_field)
1784 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
1785 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_SIGNATURE))
1786 ret = g_variant_get_string (value, NULL);
1791 /* ---------------------------------------------------------------------------------------------------- */
1794 set_uint32_header (GDBusMessage *message,
1795 GDBusMessageHeaderField header_field,
1798 g_dbus_message_set_header (message,
1800 g_variant_new_uint32 (value));
1804 set_string_header (GDBusMessage *message,
1805 GDBusMessageHeaderField header_field,
1808 g_dbus_message_set_header (message,
1810 value == NULL ? NULL : g_variant_new_string (value));
1814 set_object_path_header (GDBusMessage *message,
1815 GDBusMessageHeaderField header_field,
1818 g_dbus_message_set_header (message,
1820 value == NULL ? NULL : g_variant_new_object_path (value));
1824 set_signature_header (GDBusMessage *message,
1825 GDBusMessageHeaderField header_field,
1828 g_dbus_message_set_header (message,
1830 value == NULL ? NULL : g_variant_new_signature (value));
1833 /* ---------------------------------------------------------------------------------------------------- */
1836 * g_dbus_message_get_reply_serial:
1837 * @message: A #GDBusMessage.
1839 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
1841 * Returns: The value.
1846 g_dbus_message_get_reply_serial (GDBusMessage *message)
1848 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
1849 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL);
1853 * g_dbus_message_set_reply_serial:
1854 * @message: A #GDBusMessage.
1855 * @value: The value to set.
1857 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
1862 g_dbus_message_set_reply_serial (GDBusMessage *message,
1865 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1866 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL, value);
1869 /* ---------------------------------------------------------------------------------------------------- */
1872 * g_dbus_message_get_interface:
1873 * @message: A #GDBusMessage.
1875 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
1877 * Returns: The value.
1882 g_dbus_message_get_interface (GDBusMessage *message)
1884 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1885 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE);
1889 * g_dbus_message_set_interface:
1890 * @message: A #GDBusMessage.
1891 * @value: The value to set.
1893 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
1898 g_dbus_message_set_interface (GDBusMessage *message,
1901 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1902 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
1903 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE, value);
1906 /* ---------------------------------------------------------------------------------------------------- */
1909 * g_dbus_message_get_member:
1910 * @message: A #GDBusMessage.
1912 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
1914 * Returns: The value.
1919 g_dbus_message_get_member (GDBusMessage *message)
1921 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1922 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER);
1926 * g_dbus_message_set_member:
1927 * @message: A #GDBusMessage.
1928 * @value: The value to set.
1930 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
1935 g_dbus_message_set_member (GDBusMessage *message,
1938 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1939 g_return_if_fail (value == NULL || g_dbus_is_member_name (value));
1940 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER, value);
1943 /* ---------------------------------------------------------------------------------------------------- */
1946 * g_dbus_message_get_path:
1947 * @message: A #GDBusMessage.
1949 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
1951 * Returns: The value.
1956 g_dbus_message_get_path (GDBusMessage *message)
1958 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1959 return get_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH);
1963 * g_dbus_message_set_path:
1964 * @message: A #GDBusMessage.
1965 * @value: The value to set.
1967 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
1972 g_dbus_message_set_path (GDBusMessage *message,
1975 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1976 g_return_if_fail (value == NULL || g_variant_is_object_path (value));
1977 set_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH, value);
1980 /* ---------------------------------------------------------------------------------------------------- */
1983 * g_dbus_message_get_sender:
1984 * @message: A #GDBusMessage.
1986 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
1988 * Returns: The value.
1993 g_dbus_message_get_sender (GDBusMessage *message)
1995 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1996 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER);
2000 * g_dbus_message_set_sender:
2001 * @message: A #GDBusMessage.
2002 * @value: The value to set.
2004 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2009 g_dbus_message_set_sender (GDBusMessage *message,
2012 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2013 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2014 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER, value);
2017 /* ---------------------------------------------------------------------------------------------------- */
2020 * g_dbus_message_get_destination:
2021 * @message: A #GDBusMessage.
2023 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2025 * Returns: The value.
2030 g_dbus_message_get_destination (GDBusMessage *message)
2032 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2033 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION);
2037 * g_dbus_message_set_destination:
2038 * @message: A #GDBusMessage.
2039 * @value: The value to set.
2041 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2046 g_dbus_message_set_destination (GDBusMessage *message,
2049 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2050 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2051 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION, value);
2054 /* ---------------------------------------------------------------------------------------------------- */
2057 * g_dbus_message_get_error_name:
2058 * @message: A #GDBusMessage.
2060 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2062 * Returns: The value.
2067 g_dbus_message_get_error_name (GDBusMessage *message)
2069 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2070 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME);
2074 * g_dbus_message_set_error_name:
2075 * @message: A #GDBusMessage.
2076 * @value: The value to set.
2078 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2083 g_dbus_message_set_error_name (GDBusMessage *message,
2086 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2087 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2088 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME, value);
2091 /* ---------------------------------------------------------------------------------------------------- */
2094 * g_dbus_message_get_signature:
2095 * @message: A #GDBusMessage.
2097 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2099 * Returns: The value.
2104 g_dbus_message_get_signature (GDBusMessage *message)
2107 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2108 ret = get_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2115 * g_dbus_message_set_signature:
2116 * @message: A #GDBusMessage.
2117 * @value: The value to set.
2119 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2124 g_dbus_message_set_signature (GDBusMessage *message,
2127 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2128 g_return_if_fail (value == NULL || g_variant_is_signature (value));
2129 set_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE, value);
2132 /* ---------------------------------------------------------------------------------------------------- */
2135 * g_dbus_message_get_arg0:
2136 * @message: A #GDBusMessage.
2138 * Convenience to get the first item in the body of @message.
2140 * Returns: The string item or %NULL if the first item in the body of
2141 * @message is not a string.
2146 g_dbus_message_get_arg0 (GDBusMessage *message)
2150 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2154 if (message->priv->body != NULL && g_variant_is_of_type (message->priv->body, G_VARIANT_TYPE_TUPLE))
2157 item = g_variant_get_child_value (message->priv->body, 0);
2158 if (g_variant_is_of_type (item, G_VARIANT_TYPE_STRING))
2159 ret = g_variant_get_string (item, NULL);
2165 /* ---------------------------------------------------------------------------------------------------- */
2168 * g_dbus_message_get_num_unix_fds:
2169 * @message: A #GDBusMessage.
2171 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2173 * Returns: The value.
2178 g_dbus_message_get_num_unix_fds (GDBusMessage *message)
2180 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2181 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS);
2185 * g_dbus_message_set_num_unix_fds:
2186 * @message: A #GDBusMessage.
2187 * @value: The value to set.
2189 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2194 g_dbus_message_set_num_unix_fds (GDBusMessage *message,
2197 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2198 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS, value);
2201 /* ---------------------------------------------------------------------------------------------------- */
2204 * g_dbus_message_to_gerror:
2205 * @message: A #GDBusMessage.
2206 * @error: The #GError to set.
2208 * If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does
2209 * nothing and returns %FALSE.
2211 * Otherwise this method encodes the error in @message as a #GError
2212 * using g_dbus_error_set_dbus_error() using the information in the
2213 * %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of @message as
2214 * well as the first string item in @message's body.
2216 * Returns: %TRUE if @error was set, %FALSE otherwise.
2221 g_dbus_message_to_gerror (GDBusMessage *message,
2225 const gchar *error_name;
2227 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2230 if (message->priv->type != G_DBUS_MESSAGE_TYPE_ERROR)
2233 error_name = g_dbus_message_get_error_name (message);
2234 if (error_name != NULL)
2238 body = g_dbus_message_get_body (message);
2240 if (body != NULL && g_variant_is_of_type (body, G_VARIANT_TYPE ("(s)")))
2242 const gchar *error_message;
2243 g_variant_get (body, "(s)", &error_message);
2244 g_dbus_error_set_dbus_error (error,
2251 /* these two situations are valid, yet pretty rare */
2254 g_dbus_error_set_dbus_error (error,
2257 _("Error return with body of type `%s'"),
2258 g_variant_get_type_string (body));
2262 g_dbus_error_set_dbus_error (error,
2265 _("Error return with empty body"));
2271 /* TOOD: this shouldn't happen - should check this at message serialization
2272 * time and disconnect the peer.
2277 "Error return without error-name header!");
2286 /* ---------------------------------------------------------------------------------------------------- */
2289 enum_to_string (GType enum_type, gint value)
2293 GEnumValue *enum_value;
2295 klass = g_type_class_ref (enum_type);
2296 enum_value = g_enum_get_value (klass, value);
2297 if (enum_value != NULL)
2298 ret = g_strdup (enum_value->value_nick);
2300 ret = g_strdup_printf ("unknown (value %d)", value);
2301 g_type_class_unref (klass);
2306 flags_to_string (GType flags_type, guint value)
2312 klass = g_type_class_ref (flags_type);
2313 s = g_string_new (NULL);
2314 for (n = 0; n < 32; n++)
2316 if ((value & (1<<n)) != 0)
2318 GFlagsValue *flags_value;
2319 flags_value = g_flags_get_first_value (klass, (1<<n));
2321 g_string_append_c (s, ',');
2322 if (flags_value != NULL)
2323 g_string_append (s, flags_value->value_nick);
2325 g_string_append_printf (s, "unknown (bit %d)", n);
2329 g_string_append (s, "none");
2330 g_type_class_unref (klass);
2331 return g_string_free (s, FALSE);;
2335 _sort_keys_func (gconstpointer a,
2341 ia = GPOINTER_TO_INT (a);
2342 ib = GPOINTER_TO_INT (b);
2348 * g_dbus_message_print:
2349 * @message: A #GDBusMessage.
2350 * @indent: Indentation level.
2352 * Produces a human-readable multi-line description of @message.
2354 * The contents of the description has no ABI guarantees, the contents
2355 * and formatting is subject to change at any time. Typical output
2356 * looks something like this:
2363 * path -> objectpath '/org/gtk/GDBus/TestObject'
2364 * interface -> 'org.gtk.GDBus.TestInterface'
2365 * member -> 'GimmeStdout'
2366 * destination -> ':1.146'
2368 * UNIX File Descriptors:
2373 * Type: method-return
2374 * Flags: no-reply-expected
2378 * reply-serial -> uint32 4
2379 * destination -> ':1.159'
2380 * sender -> ':1.146'
2381 * num-unix-fds -> uint32 1
2383 * UNIX File Descriptors:
2384 * fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635
2387 * Returns: A string that should be freed with g_free().
2392 g_dbus_message_print (GDBusMessage *message,
2400 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2402 str = g_string_new (NULL);
2404 s = enum_to_string (G_TYPE_DBUS_MESSAGE_TYPE, message->priv->type);
2405 g_string_append_printf (str, "%*sType: %s\n", indent, "", s);
2407 s = flags_to_string (G_TYPE_DBUS_MESSAGE_FLAGS, message->priv->flags);
2408 g_string_append_printf (str, "%*sFlags: %s\n", indent, "", s);
2410 g_string_append_printf (str, "%*sVersion: %d\n", indent, "", message->priv->major_protocol_version);
2411 g_string_append_printf (str, "%*sSerial: %d\n", indent, "", message->priv->serial);
2413 g_string_append_printf (str, "%*sHeaders:\n", indent, "");
2414 keys = g_hash_table_get_keys (message->priv->headers);
2415 keys = g_list_sort (keys, _sort_keys_func);
2418 for (l = keys; l != NULL; l = l->next)
2420 gint key = GPOINTER_TO_INT (l->data);
2424 value = g_hash_table_lookup (message->priv->headers, l->data);
2425 g_assert (value != NULL);
2427 s = enum_to_string (G_TYPE_DBUS_MESSAGE_HEADER_FIELD, key);
2428 value_str = g_variant_print (value, TRUE);
2429 g_string_append_printf (str, "%*s %s -> %s\n", indent, "", s, value_str);
2436 g_string_append_printf (str, "%*s (none)\n", indent, "");
2438 g_string_append_printf (str, "%*sBody: ", indent, "");
2439 if (message->priv->body != NULL)
2441 g_variant_print_string (message->priv->body,
2447 g_string_append (str, "()");
2449 g_string_append (str, "\n");
2451 g_string_append_printf (str, "%*sUNIX File Descriptors:\n", indent, "");
2452 if (message->priv->fd_list != NULL)
2458 fds = g_unix_fd_list_peek_fds (message->priv->fd_list, &num_fds);
2461 for (n = 0; n < num_fds; n++)
2464 struct stat statbuf;
2465 fs = g_string_new (NULL);
2466 if (fstat (fds[n], &statbuf) == 0)
2468 g_string_append_printf (fs, "%s" "dev=%d:%d", fs->len > 0 ? "," : "",
2469 major (statbuf.st_dev), minor (statbuf.st_dev));
2470 g_string_append_printf (fs, "%s" "mode=0%o", fs->len > 0 ? "," : "",
2472 g_string_append_printf (fs, "%s" "ino=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2473 (guint64) statbuf.st_ino);
2474 g_string_append_printf (fs, "%s" "uid=%d", fs->len > 0 ? "," : "",
2476 g_string_append_printf (fs, "%s" "gid=%d", fs->len > 0 ? "," : "",
2478 g_string_append_printf (fs, "%s" "rdev=%d:%d", fs->len > 0 ? "," : "",
2479 major (statbuf.st_rdev), minor (statbuf.st_rdev));
2480 g_string_append_printf (fs, "%s" "size=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2481 (guint64) statbuf.st_size);
2482 g_string_append_printf (fs, "%s" "atime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2483 (guint64) statbuf.st_atime);
2484 g_string_append_printf (fs, "%s" "mtime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2485 (guint64) statbuf.st_mtime);
2486 g_string_append_printf (fs, "%s" "ctime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2487 (guint64) statbuf.st_ctime);
2491 g_string_append_printf (fs, "(fstat failed: %s)", strerror (errno));
2493 g_string_append_printf (str, "%*s fd %d: %s\n", indent, "", fds[n], fs->str);
2494 g_string_free (fs, TRUE);
2499 g_string_append_printf (str, "%*s (empty)\n", indent, "");
2504 g_string_append_printf (str, "%*s (none)\n", indent, "");
2508 return g_string_free (str, FALSE);