1 /* GDBus - GLib D-Bus Library
3 * Copyright (C) 2008-2010 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>
23 /* Uncomment to debug serializer code */
24 /* #define DEBUG_SERIALIZER */
30 #include <sys/types.h>
36 #include "gdbusutils.h"
37 #include "gdbusmessage.h"
38 #include "gdbuserror.h"
39 #include "gioenumtypes.h"
40 #include "ginputstream.h"
41 #include "gdatainputstream.h"
42 #include "gmemoryinputstream.h"
43 #include "goutputstream.h"
44 #include "gdataoutputstream.h"
45 #include "gmemoryoutputstream.h"
46 #include "gseekable.h"
48 #include "gdbusprivate.h"
51 #include "gunixfdlist.h"
58 * SECTION:gdbusmessage
59 * @short_description: D-Bus Message
62 * A type for representing D-Bus messages that can be sent or received
63 * on a #GDBusConnection.
70 * Class structure for #GDBusMessage.
74 struct _GDBusMessageClass
77 GObjectClass parent_class;
80 struct _GDBusMessagePrivate
82 GDBusMessageType type;
83 GDBusMessageFlags flags;
84 guchar major_protocol_version;
93 G_DEFINE_TYPE (GDBusMessage, g_dbus_message, G_TYPE_OBJECT);
96 g_dbus_message_finalize (GObject *object)
98 GDBusMessage *message = G_DBUS_MESSAGE (object);
100 if (message->priv->headers != NULL)
101 g_hash_table_unref (message->priv->headers);
102 if (message->priv->body != NULL)
103 g_variant_unref (message->priv->body);
105 if (message->priv->fd_list != NULL)
106 g_object_unref (message->priv->fd_list);
109 if (G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize != NULL)
110 G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize (object);
114 g_dbus_message_class_init (GDBusMessageClass *klass)
116 GObjectClass *gobject_class;
118 g_type_class_add_private (klass, sizeof (GDBusMessagePrivate));
120 gobject_class = G_OBJECT_CLASS (klass);
122 gobject_class->finalize = g_dbus_message_finalize;
126 g_dbus_message_init (GDBusMessage *message)
128 message->priv = G_TYPE_INSTANCE_GET_PRIVATE (message, G_TYPE_DBUS_MESSAGE, GDBusMessagePrivate);
130 message->priv->headers = g_hash_table_new_full (g_direct_hash,
133 (GDestroyNotify) g_variant_unref);
137 * g_dbus_message_new:
139 * Creates a new empty #GDBusMessage.
141 * Returns: A #GDBusMessage. Free with g_object_unref().
146 g_dbus_message_new (void)
148 return g_object_new (G_TYPE_DBUS_MESSAGE, NULL);
152 * g_dbus_message_new_method_call:
153 * @name: A valid D-Bus name or %NULL.
154 * @path: A valid object path.
155 * @interface_: A valid D-Bus interface name or %NULL.
156 * @method: A valid method name.
158 * Creates a new #GDBusMessage for a method call.
160 * Returns: A #GDBusMessage. Free with g_object_unref().
165 g_dbus_message_new_method_call (const gchar *name,
167 const gchar *interface_,
170 GDBusMessage *message;
172 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
173 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
174 g_return_val_if_fail (g_dbus_is_member_name (method), NULL);
175 g_return_val_if_fail (interface_ == NULL || g_dbus_is_interface_name (interface_), NULL);
177 message = g_dbus_message_new ();
178 message->priv->type = G_DBUS_MESSAGE_TYPE_METHOD_CALL;
181 g_dbus_message_set_destination (message, name);
182 g_dbus_message_set_path (message, path);
183 g_dbus_message_set_member (message, method);
184 if (interface_ != NULL)
185 g_dbus_message_set_interface (message, interface_);
191 * g_dbus_message_new_signal:
192 * @path: A valid object path.
193 * @interface_: A valid D-Bus interface name or %NULL.
194 * @signal: A valid signal name.
196 * Creates a new #GDBusMessage for a signal emission.
198 * Returns: A #GDBusMessage. Free with g_object_unref().
203 g_dbus_message_new_signal (const gchar *path,
204 const gchar *interface_,
207 GDBusMessage *message;
209 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
210 g_return_val_if_fail (g_dbus_is_member_name (signal), NULL);
211 g_return_val_if_fail (interface_ == NULL || g_dbus_is_interface_name (interface_), NULL);
213 message = g_dbus_message_new ();
214 message->priv->type = G_DBUS_MESSAGE_TYPE_SIGNAL;
215 message->priv->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
217 g_dbus_message_set_path (message, path);
218 g_dbus_message_set_member (message, signal);
220 if (interface_ != NULL)
221 g_dbus_message_set_interface (message, interface_);
228 * g_dbus_message_new_method_reply:
229 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
230 * create a reply message to.
232 * Creates a new #GDBusMessage that is a reply to @method_call_message.
234 * Returns: A #GDBusMessage. Free with g_object_unref().
239 g_dbus_message_new_method_reply (GDBusMessage *method_call_message)
241 GDBusMessage *message;
244 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
245 g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
246 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
248 message = g_dbus_message_new ();
249 message->priv->type = G_DBUS_MESSAGE_TYPE_METHOD_RETURN;
250 message->priv->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
252 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
253 sender = g_dbus_message_get_sender (method_call_message);
255 g_dbus_message_set_destination (message, sender);
261 * g_dbus_message_new_method_error:
262 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
263 * create a reply message to.
264 * @error_name: A valid D-Bus error name.
265 * @error_message_format: The D-Bus error message in a printf() format.
266 * @...: Arguments for @error_message_format.
268 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
270 * Returns: A #GDBusMessage. Free with g_object_unref().
275 g_dbus_message_new_method_error (GDBusMessage *method_call_message,
276 const gchar *error_name,
277 const gchar *error_message_format,
283 va_start (var_args, error_message_format);
284 ret = g_dbus_message_new_method_error_valist (method_call_message,
286 error_message_format,
294 * g_dbus_message_new_method_error_literal:
295 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
296 * create a reply message to.
297 * @error_name: A valid D-Bus error name.
298 * @error_message: The D-Bus error message.
300 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
302 * Returns: A #GDBusMessage. Free with g_object_unref().
307 g_dbus_message_new_method_error_literal (GDBusMessage *method_call_message,
308 const gchar *error_name,
309 const gchar *error_message)
311 GDBusMessage *message;
314 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
315 g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
316 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
317 g_return_val_if_fail (g_dbus_is_name (error_name), NULL);
318 g_return_val_if_fail (error_message != NULL, NULL);
320 message = g_dbus_message_new ();
321 message->priv->type = G_DBUS_MESSAGE_TYPE_ERROR;
322 message->priv->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
324 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
325 g_dbus_message_set_error_name (message, error_name);
326 g_dbus_message_set_body (message, g_variant_new ("(s)", error_message));
328 sender = g_dbus_message_get_sender (method_call_message);
330 g_dbus_message_set_destination (message, sender);
336 * g_dbus_message_new_method_error_valist:
337 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
338 * create a reply message to.
339 * @error_name: A valid D-Bus error name.
340 * @error_message_format: The D-Bus error message in a printf() format.
341 * @var_args: Arguments for @error_message_format.
343 * Like g_dbus_message_new_method_error() but intended for language bindings.
345 * Returns: A #GDBusMessage. Free with g_object_unref().
350 g_dbus_message_new_method_error_valist (GDBusMessage *method_call_message,
351 const gchar *error_name,
352 const gchar *error_message_format,
356 gchar *error_message;
357 error_message = g_strdup_vprintf (error_message_format, var_args);
358 ret = g_dbus_message_new_method_error_literal (method_call_message,
361 g_free (error_message);
365 /* ---------------------------------------------------------------------------------------------------- */
367 /* TODO: need GI annotations to specify that any guchar value goes for the type */
370 * g_dbus_message_get_message_type:
371 * @message: A #GDBusMessage.
373 * Gets the type of @message.
375 * Returns: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
380 g_dbus_message_get_message_type (GDBusMessage *message)
382 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_TYPE_INVALID);
383 return message->priv->type;
387 * g_dbus_message_set_message_type:
388 * @message: A #GDBusMessage.
389 * @type: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
391 * Sets @message to be of @type.
396 g_dbus_message_set_message_type (GDBusMessage *message,
397 GDBusMessageType type)
399 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
400 g_return_if_fail (type >=0 && type < 256);
401 message->priv->type = type;
404 /* ---------------------------------------------------------------------------------------------------- */
406 /* TODO: need GI annotations to specify that any guchar value goes for flags */
409 * g_dbus_message_get_flags:
410 * @message: A #GDBusMessage.
412 * Gets the flags for @message.
414 * Returns: Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).
419 g_dbus_message_get_flags (GDBusMessage *message)
421 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_FLAGS_NONE);
422 return message->priv->flags;
426 * g_dbus_message_set_flags:
427 * @message: A #GDBusMessage.
428 * @flags: Flags for @message that are set (typically values from the #GDBusMessageFlags
429 * enumeration bitwise ORed together).
431 * Sets the flags to set on @message.
436 g_dbus_message_set_flags (GDBusMessage *message,
437 GDBusMessageFlags flags)
439 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
440 g_return_if_fail (flags >=0 && flags < 256);
441 message->priv->flags = flags;
444 /* ---------------------------------------------------------------------------------------------------- */
447 * g_dbus_message_get_serial:
448 * @message: A #GDBusMessage.
450 * Gets the serial for @message.
452 * Returns: A #guint32.
457 g_dbus_message_get_serial (GDBusMessage *message)
459 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
460 return message->priv->serial;
464 * g_dbus_message_set_serial:
465 * @message: A #GDBusMessage.
466 * @serial: A #guint32.
468 * Sets the serial for @message.
473 g_dbus_message_set_serial (GDBusMessage *message,
476 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
477 message->priv->serial = serial;
480 /* ---------------------------------------------------------------------------------------------------- */
482 /* TODO: need GI annotations to specify that any guchar value goes for header_field */
485 * g_dbus_message_get_header:
486 * @message: A #GDBusMessage.
487 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
489 * Gets a header field on @message.
491 * Returns: A #GVariant with the value if the header was found, %NULL
492 * otherwise. Do not free, it is owned by @message.
497 g_dbus_message_get_header (GDBusMessage *message,
498 GDBusMessageHeaderField header_field)
500 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
501 g_return_val_if_fail (header_field >=0 && header_field < 256, NULL);
502 return g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
506 * g_dbus_message_set_header:
507 * @message: A #GDBusMessage.
508 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
509 * @value: A #GVariant to set the header field or %NULL to clear the header field.
511 * Sets a header field on @message.
513 * If @value is floating, @message assumes ownership of @value.
518 g_dbus_message_set_header (GDBusMessage *message,
519 GDBusMessageHeaderField header_field,
522 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
523 g_return_if_fail (header_field >=0 && header_field < 256);
526 g_hash_table_remove (message->priv->headers, GUINT_TO_POINTER (header_field));
530 g_hash_table_insert (message->priv->headers, GUINT_TO_POINTER (header_field), g_variant_ref_sink (value));
535 * g_dbus_message_get_header_fields:
536 * @message: A #GDBusMessage.
538 * Gets an array of all header fields on @message that are set.
540 * Returns: An array of header fields terminated by
541 * %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a
542 * #guchar. Free with g_free().
547 g_dbus_message_get_header_fields (GDBusMessage *message)
555 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
557 keys = g_hash_table_get_keys (message->priv->headers);
558 num_keys = g_list_length (keys);
559 ret = g_new (guchar, num_keys + 1);
560 for (l = keys, n = 0; l != NULL; l = l->next, n++)
561 ret[n] = GPOINTER_TO_UINT (l->data);
562 g_assert (n == num_keys);
563 ret[n] = G_DBUS_MESSAGE_HEADER_FIELD_INVALID;
569 /* ---------------------------------------------------------------------------------------------------- */
572 * g_dbus_message_get_body:
573 * @message: A #GDBusMessage.
575 * Gets the body of a message.
577 * Returns: A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message.
582 g_dbus_message_get_body (GDBusMessage *message)
584 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
585 return message->priv->body;
589 * g_dbus_message_set_body:
590 * @message: A #GDBusMessage.
591 * @body: Either %NULL or a #GVariant that is a tuple.
593 * Sets the body @message. As a side-effect the
594 * %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the
595 * type string of @body (or cleared if @body is %NULL).
597 * If @body is floating, @message assumes ownership of @body.
602 g_dbus_message_set_body (GDBusMessage *message,
605 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
606 g_return_if_fail ((body == NULL) || g_variant_is_of_type (body, G_VARIANT_TYPE_TUPLE));
608 if (message->priv->body != NULL)
609 g_variant_unref (message->priv->body);
612 message->priv->body = NULL;
613 g_dbus_message_set_signature (message, NULL);
617 const gchar *type_string;
618 gsize type_string_len;
621 message->priv->body = g_variant_ref_sink (body);
623 type_string = g_variant_get_type_string (body);
624 type_string_len = strlen (type_string);
625 g_assert (type_string_len >= 2);
626 signature = g_strndup (type_string + 1, type_string_len - 2);
627 g_dbus_message_set_signature (message, signature);
632 /* ---------------------------------------------------------------------------------------------------- */
636 * g_dbus_message_get_unix_fd_list:
637 * @message: A #GDBusMessage.
639 * Gets the UNIX file descriptors associated with @message, if any.
641 * This method is only available on UNIX.
643 * Returns: A #GUnixFDList or %NULL if no file descriptors are
644 * associated. Do not free, this object is owned by @message.
649 g_dbus_message_get_unix_fd_list (GDBusMessage *message)
651 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
652 return message->priv->fd_list;
656 * g_dbus_message_set_unix_fd_list:
657 * @message: A #GDBusMessage.
658 * @fd_list: A #GUnixFDList or %NULL.
660 * Sets the UNIX file descriptors associated with @message. As a
661 * side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header
662 * field is set to the number of fds in @fd_list (or cleared if
663 * @fd_list is %NULL).
665 * This method is only available on UNIX.
670 g_dbus_message_set_unix_fd_list (GDBusMessage *message,
671 GUnixFDList *fd_list)
673 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
674 g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
675 if (message->priv->fd_list != NULL)
676 g_object_unref (message->priv->fd_list);
679 message->priv->fd_list = g_object_ref (fd_list);
680 g_dbus_message_set_num_unix_fds (message, g_unix_fd_list_get_length (fd_list));
684 message->priv->fd_list = NULL;
685 g_dbus_message_set_num_unix_fds (message, 0);
690 /* ---------------------------------------------------------------------------------------------------- */
693 ensure_input_padding (GMemoryInputStream *mis,
700 offset = g_seekable_tell (G_SEEKABLE (mis));
701 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
703 if (offset != wanted_offset)
705 return g_seekable_seek (G_SEEKABLE (mis), wanted_offset, G_SEEK_SET, NULL, error);
714 read_string (GMemoryInputStream *mis,
715 GDataInputStream *dis,
725 s = g_string_new (NULL);
728 while (remaining > 0)
733 to_read = MIN (remaining, sizeof (buf));
734 num_read = g_input_stream_read (G_INPUT_STREAM (mis),
743 /* G_GSIZE_FORMAT doesn't work with gettext, so we use %lu */
746 G_IO_ERROR_INVALID_ARGUMENT,
747 _("Wanted to read %lu bytes but got EOF"),
752 remaining -= num_read;
753 g_string_append_len (s, buf, num_read);
757 nul = g_data_input_stream_read_byte (dis, NULL, &local_error);
758 if (local_error != NULL)
760 g_propagate_error (error, local_error);
767 G_IO_ERROR_INVALID_ARGUMENT,
768 _("Expected NUL byte after the string `%s' but found `%c' (%d)"),
773 return g_string_free (s, FALSE);
776 g_string_free (s, TRUE);
780 /* if just_align==TRUE, don't read a value, just align the input stream wrt padding */
782 /* returns a non-floating GVariant! */
784 parse_value_from_blob (GMemoryInputStream *mis,
785 GDataInputStream *dis,
786 const GVariantType *type,
795 #ifdef DEBUG_SERIALIZER
799 s = g_variant_type_dup_string (type);
800 g_print ("%*sReading type %s from offset 0x%04x",
803 (gint) g_seekable_tell (G_SEEKABLE (mis)));
806 #endif /* DEBUG_SERIALIZER */
812 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
814 if (!ensure_input_padding (mis, 4, &local_error))
819 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
820 if (local_error != NULL)
822 ret = g_variant_new_boolean (v);
825 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
830 v = g_data_input_stream_read_byte (dis, NULL, &local_error);
831 if (local_error != NULL)
833 ret = g_variant_new_byte (v);
836 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
838 if (!ensure_input_padding (mis, 2, &local_error))
843 v = g_data_input_stream_read_int16 (dis, NULL, &local_error);
844 if (local_error != NULL)
846 ret = g_variant_new_int16 (v);
849 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
851 if (!ensure_input_padding (mis, 2, &local_error))
856 v = g_data_input_stream_read_uint16 (dis, NULL, &local_error);
857 if (local_error != NULL)
859 ret = g_variant_new_uint16 (v);
862 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
864 if (!ensure_input_padding (mis, 4, &local_error))
869 v = g_data_input_stream_read_int32 (dis, NULL, &local_error);
870 if (local_error != NULL)
872 ret = g_variant_new_int32 (v);
875 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
877 if (!ensure_input_padding (mis, 4, &local_error))
882 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
883 if (local_error != NULL)
885 ret = g_variant_new_uint32 (v);
888 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
890 if (!ensure_input_padding (mis, 8, &local_error))
895 v = g_data_input_stream_read_int64 (dis, NULL, &local_error);
896 if (local_error != NULL)
898 ret = g_variant_new_int64 (v);
901 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
903 if (!ensure_input_padding (mis, 8, &local_error))
908 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
909 if (local_error != NULL)
911 ret = g_variant_new_uint64 (v);
914 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
916 if (!ensure_input_padding (mis, 8, &local_error))
922 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
923 if (local_error != NULL)
926 encoded = (gdouble *) &v;
927 ret = g_variant_new_double (*encoded);
930 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
932 if (!ensure_input_padding (mis, 4, &local_error))
938 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
939 if (local_error != NULL)
941 v = read_string (mis, dis, (gsize) len, &local_error);
944 ret = g_variant_new_string (v);
948 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
950 if (!ensure_input_padding (mis, 4, &local_error))
956 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
957 if (local_error != NULL)
959 v = read_string (mis, dis, (gsize) len, &local_error);
962 if (!g_variant_is_object_path (v))
964 g_set_error (&local_error,
966 G_IO_ERROR_INVALID_ARGUMENT,
967 _("Parsed value `%s' is not a valid D-Bus object path"),
972 ret = g_variant_new_object_path (v);
976 else if (g_variant_type_equal (type, G_VARIANT_TYPE_SIGNATURE))
982 len = g_data_input_stream_read_byte (dis, NULL, &local_error);
983 if (local_error != NULL)
985 v = read_string (mis, dis, (gsize) len, &local_error);
988 if (!g_variant_is_signature (v))
990 g_set_error (&local_error,
992 G_IO_ERROR_INVALID_ARGUMENT,
993 _("Parsed value `%s' is not a valid D-Bus signature"),
998 ret = g_variant_new_signature (v);
1002 else if (g_variant_type_is_array (type))
1007 const GVariantType *element_type;
1008 GVariantBuilder builder;
1010 if (!ensure_input_padding (mis, 4, &local_error))
1019 array_len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1020 if (local_error != NULL)
1024 #ifdef DEBUG_SERIALIZER
1025 g_print (": array spans 0x%04x bytes\n", array_len);
1026 #endif /* DEBUG_SERIALIZER */
1028 if (array_len > (2<<26))
1030 /* G_GUINT32_FORMAT doesn't work with gettext, so use u */
1031 g_set_error (&local_error,
1033 G_IO_ERROR_INVALID_ARGUMENT,
1034 _("Encountered array of length %u bytes. Maximum length is 2<<26 bytes."),
1040 g_variant_builder_init (&builder, type);
1041 element_type = g_variant_type_element (type);
1046 item = parse_value_from_blob (mis,
1052 g_assert (item == NULL);
1056 /* TODO: optimize array of primitive types */
1057 offset = g_seekable_tell (G_SEEKABLE (mis));
1058 target = offset + array_len;
1059 while (offset < target)
1062 item = parse_value_from_blob (mis,
1070 g_variant_builder_clear (&builder);
1073 g_variant_builder_add_value (&builder, item);
1074 g_variant_unref (item);
1075 offset = g_seekable_tell (G_SEEKABLE (mis));
1081 ret = g_variant_builder_end (&builder);
1085 g_variant_builder_clear (&builder);
1088 else if (g_variant_type_is_dict_entry (type))
1090 const GVariantType *key_type;
1091 const GVariantType *value_type;
1095 if (!ensure_input_padding (mis, 8, &local_error))
1099 #ifdef DEBUG_SERIALIZER
1101 #endif /* DEBUG_SERIALIZER */
1105 key_type = g_variant_type_key (type);
1106 key = parse_value_from_blob (mis,
1114 value_type = g_variant_type_value (type);
1115 value = parse_value_from_blob (mis,
1123 g_variant_unref (key);
1126 ret = g_variant_new_dict_entry (key, value);
1127 g_variant_unref (key);
1128 g_variant_unref (value);
1131 else if (g_variant_type_is_tuple (type))
1133 if (!ensure_input_padding (mis, 8, &local_error))
1137 #ifdef DEBUG_SERIALIZER
1139 #endif /* DEBUG_SERIALIZER */
1143 const GVariantType *element_type;
1144 GVariantBuilder builder;
1146 g_variant_builder_init (&builder, type);
1147 element_type = g_variant_type_first (type);
1148 while (element_type != NULL)
1151 item = parse_value_from_blob (mis,
1159 g_variant_builder_clear (&builder);
1162 g_variant_builder_add_value (&builder, item);
1163 g_variant_unref (item);
1165 element_type = g_variant_type_next (element_type);
1167 ret = g_variant_builder_end (&builder);
1170 else if (g_variant_type_is_variant (type))
1173 #ifdef DEBUG_SERIALIZER
1175 #endif /* DEBUG_SERIALIZER */
1181 GVariantType *variant_type;
1184 siglen = g_data_input_stream_read_byte (dis, NULL, &local_error);
1185 if (local_error != NULL)
1187 sig = read_string (mis, dis, (gsize) siglen, &local_error);
1190 if (!g_variant_is_signature (sig))
1192 g_set_error (&local_error,
1194 G_IO_ERROR_INVALID_ARGUMENT,
1195 _("Parsed value `%s' for variant is not a valid D-Bus signature"),
1200 variant_type = g_variant_type_new (sig);
1202 value = parse_value_from_blob (mis,
1208 g_variant_type_free (variant_type);
1211 ret = g_variant_new_variant (value);
1212 g_variant_unref (value);
1218 s = g_variant_type_dup_string (type);
1219 g_set_error (&local_error,
1221 G_IO_ERROR_INVALID_ARGUMENT,
1222 _("Error deserializing GVariant with type-string `%s' from the D-Bus wire format"),
1228 g_assert ((just_align && ret == NULL) || (!just_align && ret != NULL));
1230 #ifdef DEBUG_SERIALIZER
1236 if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1238 s = g_strdup_printf ("0x%02x '%c'", g_variant_get_byte (ret), g_variant_get_byte (ret));
1242 s = g_variant_print (ret, FALSE);
1244 g_print (": %s\n", s);
1248 #endif /* DEBUG_SERIALIZER */
1250 /* sink the reference */
1253 g_assert (g_variant_is_floating (ret));
1254 g_variant_ref_sink (ret);
1259 #ifdef DEBUG_SERIALIZER
1261 "%*sFAILURE: %s (%s, %d)\n",
1263 local_error->message,
1264 g_quark_to_string (local_error->domain),
1266 #endif /* DEBUG_SERIALIZER */
1267 g_propagate_error (error, local_error);
1271 /* ---------------------------------------------------------------------------------------------------- */
1273 /* message_header must be at least 16 bytes */
1276 * g_dbus_message_bytes_needed:
1277 * @blob: A blob represent a binary D-Bus message.
1278 * @blob_len: The length of @blob (must be at least 16).
1279 * @error: Return location for error or %NULL.
1281 * Utility function to calculate how many bytes are needed to
1282 * completely deserialize the D-Bus message stored at @blob.
1284 * Returns: Number of bytes needed or -1 if @error is set (e.g. if
1285 * @blob contains invalid data or not enough data is available to
1286 * determine the size).
1291 g_dbus_message_bytes_needed (guchar *blob,
1299 g_return_val_if_fail (blob != NULL, -1);
1300 g_return_val_if_fail (error == NULL || *error == NULL, -1);
1301 g_return_val_if_fail (blob_len >= 16, -1);
1305 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1306 ret = 12 + 4 + GUINT32_FROM_LE (((guint32 *) blob)[3]);
1307 /* round up so it's a multiple of 8 */
1308 ret = 8 * ((ret + 7)/8);
1309 /* finally add the body size */
1310 ret += GUINT32_FROM_LE (((guint32 *) blob)[1]);
1312 else if (blob[0] == 'B')
1314 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1315 ret = 12 + 4 + GUINT32_FROM_BE (((guint32 *) blob)[3]);
1316 /* round up so it's a multiple of 8 */
1317 ret = 8 * ((ret + 7)/8);
1318 /* finally add the body size */
1319 ret += GUINT32_FROM_BE (((guint32 *) blob)[1]);
1325 G_IO_ERROR_INVALID_ARGUMENT,
1326 "Unable to determine message blob length - given blob is malformed");
1333 G_IO_ERROR_INVALID_ARGUMENT,
1334 "Blob indicates that message exceeds maximum message length (128MiB)");
1341 /* ---------------------------------------------------------------------------------------------------- */
1344 * g_dbus_message_new_from_blob:
1345 * @blob: A blob represent a binary D-Bus message.
1346 * @blob_len: The length of @blob.
1347 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
1348 * @error: Return location for error or %NULL.
1350 * Creates a new #GDBusMessage from the data stored at @blob.
1352 * Returns: A new #GDBusMessage or %NULL if @error is set. Free with
1358 g_dbus_message_new_from_blob (guchar *blob,
1360 GDBusCapabilityFlags capabilities,
1364 GMemoryInputStream *mis;
1365 GDataInputStream *dis;
1366 GDBusMessage *message;
1368 guchar major_protocol_version;
1369 GDataStreamByteOrder byte_order;
1370 guint32 message_body_len;
1374 GVariant *signature;
1376 /* TODO: check against @capabilities */
1380 g_return_val_if_fail (blob != NULL, NULL);
1381 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1382 g_return_val_if_fail (blob_len >= 12, NULL);
1384 message = g_dbus_message_new ();
1386 mis = G_MEMORY_INPUT_STREAM (g_memory_input_stream_new_from_data (blob, blob_len, NULL));
1387 dis = g_data_input_stream_new (G_INPUT_STREAM (mis));
1389 endianness = g_data_input_stream_read_byte (dis, NULL, NULL);
1393 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1396 byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
1401 G_IO_ERROR_INVALID_ARGUMENT,
1402 _("Invalid endianness value. Expected 'l' or 'B' but found '%c' (%d)"),
1403 endianness, endianness);
1406 g_data_input_stream_set_byte_order (dis, byte_order);
1408 message->priv->type = g_data_input_stream_read_byte (dis, NULL, NULL);
1409 message->priv->flags = g_data_input_stream_read_byte (dis, NULL, NULL);
1410 major_protocol_version = g_data_input_stream_read_byte (dis, NULL, NULL);
1411 if (major_protocol_version != 1)
1415 G_IO_ERROR_INVALID_ARGUMENT,
1416 _("Invalid major protocol version. Expected 1 but found %d"),
1417 major_protocol_version);
1420 message_body_len = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1421 message->priv->serial = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1423 #ifdef DEBUG_SERIALIZER
1424 g_print ("Parsing blob (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1427 s = _g_dbus_hexdump ((const gchar *) blob, blob_len, 2);
1428 g_print ("%s\n", s);
1431 #endif /* DEBUG_SERIALIZER */
1433 #ifdef DEBUG_SERIALIZER
1434 g_print ("Parsing headers (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1435 #endif /* DEBUG_SERIALIZER */
1436 headers = parse_value_from_blob (mis,
1438 G_VARIANT_TYPE ("a{yv}"),
1442 if (headers == NULL)
1444 g_variant_iter_init (&iter, headers);
1445 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1447 guchar header_field;
1449 g_variant_get (item,
1453 g_dbus_message_set_header (message, header_field, value);
1454 g_variant_unref (value);
1455 g_variant_unref (item);
1457 g_variant_unref (headers);
1459 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
1460 if (signature != NULL)
1462 const gchar *signature_str;
1463 gsize signature_str_len;
1465 signature_str = g_variant_get_string (signature, &signature_str_len);
1467 /* signature but no body */
1468 if (message_body_len == 0 && signature_str_len > 0)
1472 G_IO_ERROR_INVALID_ARGUMENT,
1473 _("Signature header with signature `%s' found but message body is empty"),
1477 else if (signature_str_len > 0)
1479 GVariantType *variant_type;
1480 gchar *tupled_signature_str;
1482 if (!g_variant_is_signature (signature_str))
1486 G_IO_ERROR_INVALID_ARGUMENT,
1487 _("Parsed value `%s' is not a valid D-Bus signature (for body)"),
1491 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
1492 variant_type = g_variant_type_new (tupled_signature_str);
1493 g_free (tupled_signature_str);
1494 #ifdef DEBUG_SERIALIZER
1495 g_print ("Parsing body (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1496 #endif /* DEBUG_SERIALIZER */
1497 message->priv->body = parse_value_from_blob (mis,
1503 g_variant_type_free (variant_type);
1504 if (message->priv->body == NULL)
1510 /* no signature, this is only OK if the body is empty */
1511 if (message_body_len != 0)
1513 /* G_GUINT32_FORMAT doesn't work with gettext, just use %u */
1516 G_IO_ERROR_INVALID_ARGUMENT,
1517 _("No signature header in message but the message body is %u bytes"),
1527 g_object_unref (dis);
1528 g_object_unref (mis);
1536 if (message != NULL)
1537 g_object_unref (message);
1542 /* ---------------------------------------------------------------------------------------------------- */
1545 ensure_output_padding (GMemoryOutputStream *mos,
1546 GDataOutputStream *dos,
1550 gsize wanted_offset;
1551 gsize padding_needed;
1554 offset = g_memory_output_stream_get_data_size (mos);
1555 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
1556 padding_needed = wanted_offset - offset;
1558 for (n = 0; n < padding_needed; n++)
1559 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1561 return padding_needed;
1564 /* note that value can be NULL for e.g. empty arrays - type is never NULL */
1566 append_value_to_blob (GVariant *value,
1567 const GVariantType *type,
1568 GMemoryOutputStream *mos,
1569 GDataOutputStream *dos,
1570 gsize *out_padding_added,
1573 gsize padding_added;
1577 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
1579 padding_added = ensure_output_padding (mos, dos, 4);
1582 gboolean v = g_variant_get_boolean (value);
1583 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1586 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1590 guint8 v = g_variant_get_byte (value);
1591 g_data_output_stream_put_byte (dos, v, NULL, NULL);
1594 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
1596 padding_added = ensure_output_padding (mos, dos, 2);
1599 gint16 v = g_variant_get_int16 (value);
1600 g_data_output_stream_put_int16 (dos, v, NULL, NULL);
1603 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
1605 padding_added = ensure_output_padding (mos, dos, 2);
1608 guint16 v = g_variant_get_uint16 (value);
1609 g_data_output_stream_put_uint16 (dos, v, NULL, NULL);
1612 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
1614 padding_added = ensure_output_padding (mos, dos, 4);
1617 gint32 v = g_variant_get_int32 (value);
1618 g_data_output_stream_put_int32 (dos, v, NULL, NULL);
1621 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
1623 padding_added = ensure_output_padding (mos, dos, 4);
1626 guint32 v = g_variant_get_uint32 (value);
1627 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1630 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
1632 padding_added = ensure_output_padding (mos, dos, 8);
1635 gint64 v = g_variant_get_int64 (value);
1636 g_data_output_stream_put_int64 (dos, v, NULL, NULL);
1639 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
1641 padding_added = ensure_output_padding (mos, dos, 8);
1644 guint64 v = g_variant_get_uint64 (value);
1645 g_data_output_stream_put_uint64 (dos, v, NULL, NULL);
1648 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
1650 padding_added = ensure_output_padding (mos, dos, 8);
1654 gdouble v = g_variant_get_double (value);
1656 encoded = (guint64 *) &v;
1657 g_data_output_stream_put_uint64 (dos, *encoded, NULL, NULL);
1660 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
1662 padding_added = ensure_output_padding (mos, dos, 4);
1666 const gchar *v = g_variant_get_string (value, &len);
1667 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1668 g_data_output_stream_put_string (dos, v, NULL, NULL);
1669 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1672 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
1674 padding_added = ensure_output_padding (mos, dos, 4);
1677 /* TODO: validate object path */
1679 const gchar *v = g_variant_get_string (value, &len);
1680 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1681 g_data_output_stream_put_string (dos, v, NULL, NULL);
1682 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1685 else if (g_variant_type_equal (type, G_VARIANT_TYPE_SIGNATURE))
1689 /* TODO: validate signature (including max len being 255) */
1691 const gchar *v = g_variant_get_string (value, &len);
1692 g_data_output_stream_put_byte (dos, len, NULL, NULL);
1693 g_data_output_stream_put_string (dos, v, NULL, NULL);
1694 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1697 else if (g_variant_type_is_array (type))
1701 goffset array_len_offset;
1702 goffset array_payload_begin_offset;
1706 padding_added = ensure_output_padding (mos, dos, 4);
1709 /* array length - will be filled in later */
1710 array_len_offset = g_memory_output_stream_get_data_size (mos);
1711 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
1713 /* From the D-Bus spec:
1715 * "A UINT32 giving the length of the array data in bytes,
1716 * followed by alignment padding to the alignment boundary of
1717 * the array element type, followed by each array element. The
1718 * array length is from the end of the alignment padding to
1719 * the end of the last element, i.e. it does not include the
1720 * padding after the length, or any padding after the last
1723 * Thus, we need to count how much padding the first element
1724 * contributes and subtract that from the array length.
1726 array_payload_begin_offset = g_memory_output_stream_get_data_size (mos);
1728 if (g_variant_n_children (value) == 0)
1730 gsize padding_added_for_item;
1731 if (!append_value_to_blob (NULL,
1732 g_variant_type_element (type),
1735 &padding_added_for_item,
1738 array_payload_begin_offset += padding_added_for_item;
1744 g_variant_iter_init (&iter, value);
1745 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1747 gsize padding_added_for_item;
1748 if (!append_value_to_blob (item,
1749 g_variant_get_type (item),
1752 &padding_added_for_item,
1755 g_variant_unref (item);
1758 g_variant_unref (item);
1761 array_payload_begin_offset += padding_added_for_item;
1767 cur_offset = g_memory_output_stream_get_data_size (mos);
1769 array_len = cur_offset - array_payload_begin_offset;
1771 if (!g_seekable_seek (G_SEEKABLE (mos), array_len_offset, G_SEEK_SET, NULL, error))
1774 g_data_output_stream_put_uint32 (dos, array_len, NULL, NULL);
1776 if (!g_seekable_seek (G_SEEKABLE (mos), cur_offset, G_SEEK_SET, NULL, error))
1780 else if (g_variant_type_is_dict_entry (type) || g_variant_type_is_tuple (type))
1782 padding_added = ensure_output_padding (mos, dos, 8);
1787 g_variant_iter_init (&iter, value);
1788 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1790 if (!append_value_to_blob (item,
1791 g_variant_get_type (item),
1797 g_variant_unref (item);
1800 g_variant_unref (item);
1804 else if (g_variant_type_is_variant (type))
1809 const gchar *signature;
1810 child = g_variant_get_child_value (value, 0);
1811 signature = g_variant_get_type_string (child);
1812 /* TODO: validate signature (including max len being 255) */
1813 g_data_output_stream_put_byte (dos, strlen (signature), NULL, NULL);
1814 g_data_output_stream_put_string (dos, signature, NULL, NULL);
1815 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1816 if (!append_value_to_blob (child,
1817 g_variant_get_type (child),
1823 g_variant_unref (child);
1826 g_variant_unref (child);
1833 G_IO_ERROR_INVALID_ARGUMENT,
1834 _("Error serializing GVariant with type-string `%s' to the D-Bus wire format"),
1835 g_variant_get_type_string (value));
1839 if (out_padding_added != NULL)
1840 *out_padding_added = padding_added;
1849 append_body_to_blob (GVariant *value,
1850 GMemoryOutputStream *mos,
1851 GDataOutputStream *dos,
1860 if (!g_variant_is_of_type (value, G_VARIANT_TYPE_TUPLE))
1864 G_IO_ERROR_INVALID_ARGUMENT,
1865 "Expected a tuple for the body of the GDBusMessage.");
1869 g_variant_iter_init (&iter, value);
1870 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1872 if (!append_value_to_blob (item,
1873 g_variant_get_type (item),
1879 g_variant_unref (item);
1882 g_variant_unref (item);
1890 /* ---------------------------------------------------------------------------------------------------- */
1893 * g_dbus_message_to_blob:
1894 * @message: A #GDBusMessage.
1895 * @out_size: Return location for size of generated blob.
1896 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
1897 * @error: Return location for error.
1899 * Serializes @message to a blob.
1901 * Returns: A pointer to a valid binary D-Bus message of @out_size bytes
1902 * generated by @message or %NULL if @error is set. Free with g_free().
1907 g_dbus_message_to_blob (GDBusMessage *message,
1909 GDBusCapabilityFlags capabilities,
1912 GMemoryOutputStream *mos;
1913 GDataOutputStream *dos;
1916 GDataStreamByteOrder byte_order;
1917 goffset body_len_offset;
1918 goffset body_start_offset;
1920 GVariant *header_fields;
1921 GVariantBuilder builder;
1922 GHashTableIter hash_iter;
1924 GVariant *header_value;
1925 GVariant *signature;
1926 const gchar *signature_str;
1927 gint num_fds_in_message;
1928 gint num_fds_according_to_header;
1930 /* TODO: check against @capabilities */
1934 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1935 g_return_val_if_fail (out_size != NULL, NULL);
1936 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1938 mos = G_MEMORY_OUTPUT_STREAM (g_memory_output_stream_new (NULL, 0, g_realloc, g_free));
1939 dos = g_data_output_stream_new (G_OUTPUT_STREAM (mos));
1941 /* TODO: detect endianess... */
1942 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1943 g_data_output_stream_set_byte_order (dos, byte_order);
1946 g_data_output_stream_put_byte (dos, byte_order == G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN ? 'l' : 'B', NULL, NULL);
1947 g_data_output_stream_put_byte (dos, message->priv->type, NULL, NULL);
1948 g_data_output_stream_put_byte (dos, message->priv->flags, NULL, NULL);
1949 g_data_output_stream_put_byte (dos, 1, NULL, NULL); /* major protocol version */
1950 body_len_offset = g_memory_output_stream_get_data_size (mos);
1951 /* body length - will be filled in later */
1952 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
1953 g_data_output_stream_put_uint32 (dos, message->priv->serial, NULL, NULL);
1955 num_fds_in_message = 0;
1957 if (message->priv->fd_list != NULL)
1958 num_fds_in_message = g_unix_fd_list_get_length (message->priv->fd_list);
1960 num_fds_according_to_header = g_dbus_message_get_num_unix_fds (message);
1961 /* TODO: check we have all the right header fields and that they are the correct value etc etc */
1962 if (num_fds_in_message != num_fds_according_to_header)
1966 G_IO_ERROR_INVALID_ARGUMENT,
1967 _("Message has %d fds but the header field indicates %d fds"),
1969 num_fds_according_to_header);
1973 g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{yv}"));
1974 g_hash_table_iter_init (&hash_iter, message->priv->headers);
1975 while (g_hash_table_iter_next (&hash_iter, &key, (gpointer) &header_value))
1977 g_variant_builder_add (&builder,
1979 (guchar) GPOINTER_TO_UINT (key),
1982 header_fields = g_variant_builder_end (&builder);
1984 if (!append_value_to_blob (header_fields,
1985 g_variant_get_type (header_fields),
1990 g_variant_unref (header_fields);
1993 g_variant_unref (header_fields);
1995 /* header size must be a multiple of 8 */
1996 ensure_output_padding (mos, dos, 8);
1998 body_start_offset = g_memory_output_stream_get_data_size (mos);
2000 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2001 signature_str = NULL;
2002 if (signature != NULL)
2003 signature_str = g_variant_get_string (signature, NULL);
2004 if (message->priv->body != NULL)
2006 gchar *tupled_signature_str;
2007 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
2008 if (signature == NULL)
2012 G_IO_ERROR_INVALID_ARGUMENT,
2013 _("Message body has signature `%s' but there is no signature header"),
2015 g_free (tupled_signature_str);
2018 else if (g_strcmp0 (tupled_signature_str, g_variant_get_type_string (message->priv->body)) != 0)
2022 G_IO_ERROR_INVALID_ARGUMENT,
2023 _("Message body has type signature `%s' but signature in the header field is `%s'"),
2024 tupled_signature_str, g_variant_get_type_string (message->priv->body));
2025 g_free (tupled_signature_str);
2028 g_free (tupled_signature_str);
2029 if (!append_body_to_blob (message->priv->body, mos, dos, error))
2034 if (signature != NULL)
2038 G_IO_ERROR_INVALID_ARGUMENT,
2039 _("Message body is empty but signature in the header field is `(%s)'"),
2045 /* OK, we're done writing the message - set the body length */
2046 size = g_memory_output_stream_get_data_size (mos);
2047 body_size = size - body_start_offset;
2049 if (!g_seekable_seek (G_SEEKABLE (mos), body_len_offset, G_SEEK_SET, NULL, error))
2052 g_data_output_stream_put_uint32 (dos, body_size, NULL, NULL);
2055 ret = g_memdup (g_memory_output_stream_get_data (mos), size);
2058 g_object_unref (dos);
2059 g_object_unref (mos);
2064 /* ---------------------------------------------------------------------------------------------------- */
2067 get_uint32_header (GDBusMessage *message,
2068 GDBusMessageHeaderField header_field)
2074 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
2075 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_UINT32))
2076 ret = g_variant_get_uint32 (value);
2081 static const gchar *
2082 get_string_header (GDBusMessage *message,
2083 GDBusMessageHeaderField header_field)
2089 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
2090 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
2091 ret = g_variant_get_string (value, NULL);
2096 static const gchar *
2097 get_object_path_header (GDBusMessage *message,
2098 GDBusMessageHeaderField header_field)
2104 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
2105 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_OBJECT_PATH))
2106 ret = g_variant_get_string (value, NULL);
2111 static const gchar *
2112 get_signature_header (GDBusMessage *message,
2113 GDBusMessageHeaderField header_field)
2119 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
2120 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_SIGNATURE))
2121 ret = g_variant_get_string (value, NULL);
2126 /* ---------------------------------------------------------------------------------------------------- */
2129 set_uint32_header (GDBusMessage *message,
2130 GDBusMessageHeaderField header_field,
2133 g_dbus_message_set_header (message,
2135 g_variant_new_uint32 (value));
2139 set_string_header (GDBusMessage *message,
2140 GDBusMessageHeaderField header_field,
2143 g_dbus_message_set_header (message,
2145 value == NULL ? NULL : g_variant_new_string (value));
2149 set_object_path_header (GDBusMessage *message,
2150 GDBusMessageHeaderField header_field,
2153 g_dbus_message_set_header (message,
2155 value == NULL ? NULL : g_variant_new_object_path (value));
2159 set_signature_header (GDBusMessage *message,
2160 GDBusMessageHeaderField header_field,
2163 g_dbus_message_set_header (message,
2165 value == NULL ? NULL : g_variant_new_signature (value));
2168 /* ---------------------------------------------------------------------------------------------------- */
2171 * g_dbus_message_get_reply_serial:
2172 * @message: A #GDBusMessage.
2174 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2176 * Returns: The value.
2181 g_dbus_message_get_reply_serial (GDBusMessage *message)
2183 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2184 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL);
2188 * g_dbus_message_set_reply_serial:
2189 * @message: A #GDBusMessage.
2190 * @value: The value to set.
2192 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2197 g_dbus_message_set_reply_serial (GDBusMessage *message,
2200 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2201 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL, value);
2204 /* ---------------------------------------------------------------------------------------------------- */
2207 * g_dbus_message_get_interface:
2208 * @message: A #GDBusMessage.
2210 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2212 * Returns: The value.
2217 g_dbus_message_get_interface (GDBusMessage *message)
2219 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2220 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE);
2224 * g_dbus_message_set_interface:
2225 * @message: A #GDBusMessage.
2226 * @value: The value to set.
2228 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2233 g_dbus_message_set_interface (GDBusMessage *message,
2236 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2237 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2238 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE, value);
2241 /* ---------------------------------------------------------------------------------------------------- */
2244 * g_dbus_message_get_member:
2245 * @message: A #GDBusMessage.
2247 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2249 * Returns: The value.
2254 g_dbus_message_get_member (GDBusMessage *message)
2256 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2257 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER);
2261 * g_dbus_message_set_member:
2262 * @message: A #GDBusMessage.
2263 * @value: The value to set.
2265 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2270 g_dbus_message_set_member (GDBusMessage *message,
2273 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2274 g_return_if_fail (value == NULL || g_dbus_is_member_name (value));
2275 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER, value);
2278 /* ---------------------------------------------------------------------------------------------------- */
2281 * g_dbus_message_get_path:
2282 * @message: A #GDBusMessage.
2284 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2286 * Returns: The value.
2291 g_dbus_message_get_path (GDBusMessage *message)
2293 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2294 return get_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH);
2298 * g_dbus_message_set_path:
2299 * @message: A #GDBusMessage.
2300 * @value: The value to set.
2302 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2307 g_dbus_message_set_path (GDBusMessage *message,
2310 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2311 g_return_if_fail (value == NULL || g_variant_is_object_path (value));
2312 set_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH, value);
2315 /* ---------------------------------------------------------------------------------------------------- */
2318 * g_dbus_message_get_sender:
2319 * @message: A #GDBusMessage.
2321 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2323 * Returns: The value.
2328 g_dbus_message_get_sender (GDBusMessage *message)
2330 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2331 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER);
2335 * g_dbus_message_set_sender:
2336 * @message: A #GDBusMessage.
2337 * @value: The value to set.
2339 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2344 g_dbus_message_set_sender (GDBusMessage *message,
2347 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2348 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2349 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER, value);
2352 /* ---------------------------------------------------------------------------------------------------- */
2355 * g_dbus_message_get_destination:
2356 * @message: A #GDBusMessage.
2358 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2360 * Returns: The value.
2365 g_dbus_message_get_destination (GDBusMessage *message)
2367 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2368 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION);
2372 * g_dbus_message_set_destination:
2373 * @message: A #GDBusMessage.
2374 * @value: The value to set.
2376 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2381 g_dbus_message_set_destination (GDBusMessage *message,
2384 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2385 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2386 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION, value);
2389 /* ---------------------------------------------------------------------------------------------------- */
2392 * g_dbus_message_get_error_name:
2393 * @message: A #GDBusMessage.
2395 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2397 * Returns: The value.
2402 g_dbus_message_get_error_name (GDBusMessage *message)
2404 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2405 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME);
2409 * g_dbus_message_set_error_name:
2410 * @message: A #GDBusMessage.
2411 * @value: The value to set.
2413 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2418 g_dbus_message_set_error_name (GDBusMessage *message,
2421 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2422 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2423 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME, value);
2426 /* ---------------------------------------------------------------------------------------------------- */
2429 * g_dbus_message_get_signature:
2430 * @message: A #GDBusMessage.
2432 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2434 * Returns: The value.
2439 g_dbus_message_get_signature (GDBusMessage *message)
2442 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2443 ret = get_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2450 * g_dbus_message_set_signature:
2451 * @message: A #GDBusMessage.
2452 * @value: The value to set.
2454 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2459 g_dbus_message_set_signature (GDBusMessage *message,
2462 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2463 g_return_if_fail (value == NULL || g_variant_is_signature (value));
2464 set_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE, value);
2467 /* ---------------------------------------------------------------------------------------------------- */
2470 * g_dbus_message_get_arg0:
2471 * @message: A #GDBusMessage.
2473 * Convenience to get the first item in the body of @message.
2475 * Returns: The string item or %NULL if the first item in the body of
2476 * @message is not a string.
2481 g_dbus_message_get_arg0 (GDBusMessage *message)
2485 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2489 if (message->priv->body != NULL && g_variant_is_of_type (message->priv->body, G_VARIANT_TYPE_TUPLE))
2492 item = g_variant_get_child_value (message->priv->body, 0);
2493 if (g_variant_is_of_type (item, G_VARIANT_TYPE_STRING))
2494 ret = g_variant_get_string (item, NULL);
2495 g_variant_unref (item);
2501 /* ---------------------------------------------------------------------------------------------------- */
2504 * g_dbus_message_get_num_unix_fds:
2505 * @message: A #GDBusMessage.
2507 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2509 * Returns: The value.
2514 g_dbus_message_get_num_unix_fds (GDBusMessage *message)
2516 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2517 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS);
2521 * g_dbus_message_set_num_unix_fds:
2522 * @message: A #GDBusMessage.
2523 * @value: The value to set.
2525 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2530 g_dbus_message_set_num_unix_fds (GDBusMessage *message,
2533 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2534 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS, value);
2537 /* ---------------------------------------------------------------------------------------------------- */
2540 * g_dbus_message_to_gerror:
2541 * @message: A #GDBusMessage.
2542 * @error: The #GError to set.
2544 * If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does
2545 * nothing and returns %FALSE.
2547 * Otherwise this method encodes the error in @message as a #GError
2548 * using g_dbus_error_set_dbus_error() using the information in the
2549 * %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of @message as
2550 * well as the first string item in @message's body.
2552 * Returns: %TRUE if @error was set, %FALSE otherwise.
2557 g_dbus_message_to_gerror (GDBusMessage *message,
2561 const gchar *error_name;
2563 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2566 if (message->priv->type != G_DBUS_MESSAGE_TYPE_ERROR)
2569 error_name = g_dbus_message_get_error_name (message);
2570 if (error_name != NULL)
2574 body = g_dbus_message_get_body (message);
2576 if (body != NULL && g_variant_is_of_type (body, G_VARIANT_TYPE ("(s)")))
2578 const gchar *error_message;
2579 g_variant_get (body, "(&s)", &error_message);
2580 g_dbus_error_set_dbus_error (error,
2587 /* these two situations are valid, yet pretty rare */
2590 g_dbus_error_set_dbus_error (error,
2593 _("Error return with body of type `%s'"),
2594 g_variant_get_type_string (body));
2598 g_dbus_error_set_dbus_error (error,
2601 _("Error return with empty body"));
2607 /* TOOD: this shouldn't happen - should check this at message serialization
2608 * time and disconnect the peer.
2613 "Error return without error-name header!");
2622 /* ---------------------------------------------------------------------------------------------------- */
2625 flags_to_string (GType flags_type, guint value)
2631 klass = g_type_class_ref (flags_type);
2632 s = g_string_new (NULL);
2633 for (n = 0; n < 32; n++)
2635 if ((value & (1<<n)) != 0)
2637 GFlagsValue *flags_value;
2638 flags_value = g_flags_get_first_value (klass, (1<<n));
2640 g_string_append_c (s, ',');
2641 if (flags_value != NULL)
2642 g_string_append (s, flags_value->value_nick);
2644 g_string_append_printf (s, "unknown (bit %d)", n);
2648 g_string_append (s, "none");
2649 g_type_class_unref (klass);
2650 return g_string_free (s, FALSE);
2654 _sort_keys_func (gconstpointer a,
2660 ia = GPOINTER_TO_INT (a);
2661 ib = GPOINTER_TO_INT (b);
2667 * g_dbus_message_print:
2668 * @message: A #GDBusMessage.
2669 * @indent: Indentation level.
2671 * Produces a human-readable multi-line description of @message.
2673 * The contents of the description has no ABI guarantees, the contents
2674 * and formatting is subject to change at any time. Typical output
2675 * looks something like this:
2682 * path -> objectpath '/org/gtk/GDBus/TestObject'
2683 * interface -> 'org.gtk.GDBus.TestInterface'
2684 * member -> 'GimmeStdout'
2685 * destination -> ':1.146'
2687 * UNIX File Descriptors:
2692 * Type: method-return
2693 * Flags: no-reply-expected
2697 * reply-serial -> uint32 4
2698 * destination -> ':1.159'
2699 * sender -> ':1.146'
2700 * num-unix-fds -> uint32 1
2702 * UNIX File Descriptors:
2703 * fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635
2706 * Returns: A string that should be freed with g_free().
2711 g_dbus_message_print (GDBusMessage *message,
2719 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2721 str = g_string_new (NULL);
2723 s = _g_dbus_enum_to_string (G_TYPE_DBUS_MESSAGE_TYPE, message->priv->type);
2724 g_string_append_printf (str, "%*sType: %s\n", indent, "", s);
2726 s = flags_to_string (G_TYPE_DBUS_MESSAGE_FLAGS, message->priv->flags);
2727 g_string_append_printf (str, "%*sFlags: %s\n", indent, "", s);
2729 g_string_append_printf (str, "%*sVersion: %d\n", indent, "", message->priv->major_protocol_version);
2730 g_string_append_printf (str, "%*sSerial: %d\n", indent, "", message->priv->serial);
2732 g_string_append_printf (str, "%*sHeaders:\n", indent, "");
2733 keys = g_hash_table_get_keys (message->priv->headers);
2734 keys = g_list_sort (keys, _sort_keys_func);
2737 for (l = keys; l != NULL; l = l->next)
2739 gint key = GPOINTER_TO_INT (l->data);
2743 value = g_hash_table_lookup (message->priv->headers, l->data);
2744 g_assert (value != NULL);
2746 s = _g_dbus_enum_to_string (G_TYPE_DBUS_MESSAGE_HEADER_FIELD, key);
2747 value_str = g_variant_print (value, TRUE);
2748 g_string_append_printf (str, "%*s %s -> %s\n", indent, "", s, value_str);
2755 g_string_append_printf (str, "%*s (none)\n", indent, "");
2757 g_string_append_printf (str, "%*sBody: ", indent, "");
2758 if (message->priv->body != NULL)
2760 g_variant_print_string (message->priv->body,
2766 g_string_append (str, "()");
2768 g_string_append (str, "\n");
2770 g_string_append_printf (str, "%*sUNIX File Descriptors:\n", indent, "");
2771 if (message->priv->fd_list != NULL)
2777 fds = g_unix_fd_list_peek_fds (message->priv->fd_list, &num_fds);
2780 for (n = 0; n < num_fds; n++)
2783 struct stat statbuf;
2784 fs = g_string_new (NULL);
2785 if (fstat (fds[n], &statbuf) == 0)
2787 g_string_append_printf (fs, "%s" "dev=%d:%d", fs->len > 0 ? "," : "",
2788 major (statbuf.st_dev), minor (statbuf.st_dev));
2789 g_string_append_printf (fs, "%s" "mode=0%o", fs->len > 0 ? "," : "",
2791 g_string_append_printf (fs, "%s" "ino=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2792 (guint64) statbuf.st_ino);
2793 g_string_append_printf (fs, "%s" "uid=%d", fs->len > 0 ? "," : "",
2795 g_string_append_printf (fs, "%s" "gid=%d", fs->len > 0 ? "," : "",
2797 g_string_append_printf (fs, "%s" "rdev=%d:%d", fs->len > 0 ? "," : "",
2798 major (statbuf.st_rdev), minor (statbuf.st_rdev));
2799 g_string_append_printf (fs, "%s" "size=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2800 (guint64) statbuf.st_size);
2801 g_string_append_printf (fs, "%s" "atime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2802 (guint64) statbuf.st_atime);
2803 g_string_append_printf (fs, "%s" "mtime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2804 (guint64) statbuf.st_mtime);
2805 g_string_append_printf (fs, "%s" "ctime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2806 (guint64) statbuf.st_ctime);
2810 g_string_append_printf (fs, "(fstat failed: %s)", strerror (errno));
2812 g_string_append_printf (str, "%*s fd %d: %s\n", indent, "", fds[n], fs->str);
2813 g_string_free (fs, TRUE);
2818 g_string_append_printf (str, "%*s (empty)\n", indent, "");
2823 g_string_append_printf (str, "%*s (none)\n", indent, "");
2827 return g_string_free (str, FALSE);
2831 #define __G_DBUS_MESSAGE_C__
2832 #include "gioaliasdef.c"