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.
66 struct _GDBusMessagePrivate
68 GDBusMessageType type;
69 GDBusMessageFlags flags;
70 guchar major_protocol_version;
79 G_DEFINE_TYPE (GDBusMessage, g_dbus_message, G_TYPE_OBJECT);
82 g_dbus_message_finalize (GObject *object)
84 GDBusMessage *message = G_DBUS_MESSAGE (object);
86 if (message->priv->headers != NULL)
87 g_hash_table_unref (message->priv->headers);
88 if (message->priv->body != NULL)
89 g_variant_unref (message->priv->body);
91 if (message->priv->fd_list != NULL)
92 g_object_unref (message->priv->fd_list);
95 if (G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize != NULL)
96 G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize (object);
100 g_dbus_message_class_init (GDBusMessageClass *klass)
102 GObjectClass *gobject_class;
104 g_type_class_add_private (klass, sizeof (GDBusMessagePrivate));
106 gobject_class = G_OBJECT_CLASS (klass);
108 gobject_class->finalize = g_dbus_message_finalize;
112 g_dbus_message_init (GDBusMessage *message)
114 message->priv = G_TYPE_INSTANCE_GET_PRIVATE (message, G_TYPE_DBUS_MESSAGE, GDBusMessagePrivate);
116 message->priv->headers = g_hash_table_new_full (g_direct_hash,
119 (GDestroyNotify) g_variant_unref);
123 * g_dbus_message_new:
125 * Creates a new empty #GDBusMessage.
127 * Returns: A #GDBusMessage. Free with g_object_unref().
132 g_dbus_message_new (void)
134 return g_object_new (G_TYPE_DBUS_MESSAGE, NULL);
138 * g_dbus_message_new_method_call:
139 * @name: A valid D-Bus name or %NULL.
140 * @path: A valid object path.
141 * @interface_: A valid D-Bus interface name or %NULL.
142 * @method: A valid method name.
144 * Creates a new #GDBusMessage for a method call.
146 * Returns: A #GDBusMessage. Free with g_object_unref().
151 g_dbus_message_new_method_call (const gchar *name,
153 const gchar *interface_,
156 GDBusMessage *message;
158 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
159 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
160 g_return_val_if_fail (g_dbus_is_member_name (method), NULL);
161 g_return_val_if_fail (interface_ == NULL || g_dbus_is_interface_name (interface_), NULL);
163 message = g_dbus_message_new ();
164 message->priv->type = G_DBUS_MESSAGE_TYPE_METHOD_CALL;
167 g_dbus_message_set_destination (message, name);
168 g_dbus_message_set_path (message, path);
169 g_dbus_message_set_member (message, method);
170 if (interface_ != NULL)
171 g_dbus_message_set_interface (message, interface_);
177 * g_dbus_message_new_signal:
178 * @path: A valid object path.
179 * @interface_: A valid D-Bus interface name or %NULL.
180 * @signal: A valid signal name.
182 * Creates a new #GDBusMessage for a signal emission.
184 * Returns: A #GDBusMessage. Free with g_object_unref().
189 g_dbus_message_new_signal (const gchar *path,
190 const gchar *interface_,
193 GDBusMessage *message;
195 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
196 g_return_val_if_fail (g_dbus_is_member_name (signal), NULL);
197 g_return_val_if_fail (interface_ == NULL || g_dbus_is_interface_name (interface_), NULL);
199 message = g_dbus_message_new ();
200 message->priv->type = G_DBUS_MESSAGE_TYPE_SIGNAL;
201 message->priv->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
203 g_dbus_message_set_path (message, path);
204 g_dbus_message_set_member (message, signal);
206 if (interface_ != NULL)
207 g_dbus_message_set_interface (message, interface_);
214 * g_dbus_message_new_method_reply:
215 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
216 * create a reply message to.
218 * Creates a new #GDBusMessage that is a reply to @method_call_message.
220 * Returns: A #GDBusMessage. Free with g_object_unref().
225 g_dbus_message_new_method_reply (GDBusMessage *method_call_message)
227 GDBusMessage *message;
230 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
231 g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
232 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
234 message = g_dbus_message_new ();
235 message->priv->type = G_DBUS_MESSAGE_TYPE_METHOD_RETURN;
236 message->priv->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
238 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
239 sender = g_dbus_message_get_sender (method_call_message);
241 g_dbus_message_set_destination (message, sender);
247 * g_dbus_message_new_method_error:
248 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
249 * create a reply message to.
250 * @error_name: A valid D-Bus error name.
251 * @error_message_format: The D-Bus error message in a printf() format.
252 * @...: Arguments for @error_message_format.
254 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
256 * Returns: A #GDBusMessage. Free with g_object_unref().
261 g_dbus_message_new_method_error (GDBusMessage *method_call_message,
262 const gchar *error_name,
263 const gchar *error_message_format,
269 va_start (var_args, error_message_format);
270 ret = g_dbus_message_new_method_error_valist (method_call_message,
272 error_message_format,
280 * g_dbus_message_new_method_error_literal:
281 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
282 * create a reply message to.
283 * @error_name: A valid D-Bus error name.
284 * @error_message: The D-Bus error message.
286 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
288 * Returns: A #GDBusMessage. Free with g_object_unref().
293 g_dbus_message_new_method_error_literal (GDBusMessage *method_call_message,
294 const gchar *error_name,
295 const gchar *error_message)
297 GDBusMessage *message;
300 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
301 g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
302 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
303 g_return_val_if_fail (g_dbus_is_name (error_name), NULL);
304 g_return_val_if_fail (error_message != NULL, NULL);
306 message = g_dbus_message_new ();
307 message->priv->type = G_DBUS_MESSAGE_TYPE_ERROR;
308 message->priv->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
310 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
311 g_dbus_message_set_error_name (message, error_name);
312 g_dbus_message_set_body (message, g_variant_new ("(s)", error_message));
314 sender = g_dbus_message_get_sender (method_call_message);
316 g_dbus_message_set_destination (message, sender);
322 * g_dbus_message_new_method_error_valist:
323 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
324 * create a reply message to.
325 * @error_name: A valid D-Bus error name.
326 * @error_message_format: The D-Bus error message in a printf() format.
327 * @var_args: Arguments for @error_message_format.
329 * Like g_dbus_message_new_method_error() but intended for language bindings.
331 * Returns: A #GDBusMessage. Free with g_object_unref().
336 g_dbus_message_new_method_error_valist (GDBusMessage *method_call_message,
337 const gchar *error_name,
338 const gchar *error_message_format,
342 gchar *error_message;
343 error_message = g_strdup_vprintf (error_message_format, var_args);
344 ret = g_dbus_message_new_method_error_literal (method_call_message,
347 g_free (error_message);
351 /* ---------------------------------------------------------------------------------------------------- */
353 /* TODO: need GI annotations to specify that any guchar value goes for the type */
356 * g_dbus_message_get_message_type:
357 * @message: A #GDBusMessage.
359 * Gets the type of @message.
361 * Returns: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
366 g_dbus_message_get_message_type (GDBusMessage *message)
368 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_TYPE_INVALID);
369 return message->priv->type;
373 * g_dbus_message_set_message_type:
374 * @message: A #GDBusMessage.
375 * @type: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
377 * Sets @message to be of @type.
382 g_dbus_message_set_message_type (GDBusMessage *message,
383 GDBusMessageType type)
385 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
386 g_return_if_fail (type >=0 && type < 256);
387 message->priv->type = type;
390 /* ---------------------------------------------------------------------------------------------------- */
392 /* TODO: need GI annotations to specify that any guchar value goes for flags */
395 * g_dbus_message_get_flags:
396 * @message: A #GDBusMessage.
398 * Gets the flags for @message.
400 * Returns: Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).
405 g_dbus_message_get_flags (GDBusMessage *message)
407 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_FLAGS_NONE);
408 return message->priv->flags;
412 * g_dbus_message_set_flags:
413 * @message: A #GDBusMessage.
414 * @flags: Flags for @message that are set (typically values from the #GDBusMessageFlags
415 * enumeration bitwise ORed together).
417 * Sets the flags to set on @message.
422 g_dbus_message_set_flags (GDBusMessage *message,
423 GDBusMessageFlags flags)
425 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
426 g_return_if_fail (flags >=0 && flags < 256);
427 message->priv->flags = flags;
430 /* ---------------------------------------------------------------------------------------------------- */
433 * g_dbus_message_get_serial:
434 * @message: A #GDBusMessage.
436 * Gets the serial for @message.
438 * Returns: A #guint32.
443 g_dbus_message_get_serial (GDBusMessage *message)
445 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
446 return message->priv->serial;
450 * g_dbus_message_set_serial:
451 * @message: A #GDBusMessage.
452 * @serial: A #guint32.
454 * Sets the serial for @message.
459 g_dbus_message_set_serial (GDBusMessage *message,
462 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
463 message->priv->serial = serial;
466 /* ---------------------------------------------------------------------------------------------------- */
468 /* TODO: need GI annotations to specify that any guchar value goes for header_field */
471 * g_dbus_message_get_header:
472 * @message: A #GDBusMessage.
473 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
475 * Gets a header field on @message.
477 * Returns: A #GVariant with the value if the header was found, %NULL
478 * otherwise. Do not free, it is owned by @message.
483 g_dbus_message_get_header (GDBusMessage *message,
484 GDBusMessageHeaderField header_field)
486 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
487 g_return_val_if_fail (header_field >=0 && header_field < 256, NULL);
488 return g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
492 * g_dbus_message_set_header:
493 * @message: A #GDBusMessage.
494 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
495 * @value: A #GVariant to set the header field or %NULL to clear the header field.
497 * Sets a header field on @message.
499 * If @value is floating, @message assumes ownership of @value.
504 g_dbus_message_set_header (GDBusMessage *message,
505 GDBusMessageHeaderField header_field,
508 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
509 g_return_if_fail (header_field >=0 && header_field < 256);
512 g_hash_table_remove (message->priv->headers, GUINT_TO_POINTER (header_field));
516 g_hash_table_insert (message->priv->headers, GUINT_TO_POINTER (header_field), g_variant_ref_sink (value));
521 * g_dbus_message_get_header_fields:
522 * @message: A #GDBusMessage.
524 * Gets an array of all header fields on @message that are set.
526 * Returns: An array of header fields terminated by
527 * %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a
528 * #guchar. Free with g_free().
533 g_dbus_message_get_header_fields (GDBusMessage *message)
541 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
543 keys = g_hash_table_get_keys (message->priv->headers);
544 num_keys = g_list_length (keys);
545 ret = g_new (guchar, num_keys + 1);
546 for (l = keys, n = 0; l != NULL; l = l->next, n++)
547 ret[n] = GPOINTER_TO_UINT (l->data);
548 g_assert (n == num_keys);
549 ret[n] = G_DBUS_MESSAGE_HEADER_FIELD_INVALID;
555 /* ---------------------------------------------------------------------------------------------------- */
558 * g_dbus_message_get_body:
559 * @message: A #GDBusMessage.
561 * Gets the body of a message.
563 * Returns: A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message.
568 g_dbus_message_get_body (GDBusMessage *message)
570 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
571 return message->priv->body;
575 * g_dbus_message_set_body:
576 * @message: A #GDBusMessage.
577 * @body: Either %NULL or a #GVariant that is a tuple.
579 * Sets the body @message. As a side-effect the
580 * %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the
581 * type string of @body (or cleared if @body is %NULL).
583 * If @body is floating, @message assumes ownership of @body.
588 g_dbus_message_set_body (GDBusMessage *message,
591 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
592 g_return_if_fail ((body == NULL) || g_variant_is_of_type (body, G_VARIANT_TYPE_TUPLE));
594 if (message->priv->body != NULL)
595 g_variant_unref (message->priv->body);
598 message->priv->body = NULL;
599 g_dbus_message_set_signature (message, NULL);
603 const gchar *type_string;
604 gsize type_string_len;
607 message->priv->body = g_variant_ref_sink (body);
609 type_string = g_variant_get_type_string (body);
610 type_string_len = strlen (type_string);
611 g_assert (type_string_len >= 2);
612 signature = g_strndup (type_string + 1, type_string_len - 2);
613 g_dbus_message_set_signature (message, signature);
618 /* ---------------------------------------------------------------------------------------------------- */
622 * g_dbus_message_get_unix_fd_list:
623 * @message: A #GDBusMessage.
625 * Gets the UNIX file descriptors associated with @message, if any.
627 * This method is only available on UNIX.
629 * Returns: A #GUnixFDList or %NULL if no file descriptors are
630 * associated. Do not free, this object is owned by @message.
635 g_dbus_message_get_unix_fd_list (GDBusMessage *message)
637 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
638 return message->priv->fd_list;
642 * g_dbus_message_set_unix_fd_list:
643 * @message: A #GDBusMessage.
644 * @fd_list: A #GUnixFDList or %NULL.
646 * Sets the UNIX file descriptors associated with @message. As a
647 * side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header
648 * field is set to the number of fds in @fd_list (or cleared if
649 * @fd_list is %NULL).
651 * This method is only available on UNIX.
656 g_dbus_message_set_unix_fd_list (GDBusMessage *message,
657 GUnixFDList *fd_list)
659 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
660 g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
661 if (message->priv->fd_list != NULL)
662 g_object_unref (message->priv->fd_list);
665 message->priv->fd_list = g_object_ref (fd_list);
666 g_dbus_message_set_num_unix_fds (message, g_unix_fd_list_get_length (fd_list));
670 message->priv->fd_list = NULL;
671 g_dbus_message_set_num_unix_fds (message, 0);
676 /* ---------------------------------------------------------------------------------------------------- */
679 ensure_input_padding (GMemoryInputStream *mis,
686 offset = g_seekable_tell (G_SEEKABLE (mis));
687 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
689 if (offset != wanted_offset)
691 return g_seekable_seek (G_SEEKABLE (mis), wanted_offset, G_SEEK_SET, NULL, error);
700 read_string (GMemoryInputStream *mis,
701 GDataInputStream *dis,
711 s = g_string_new (NULL);
714 while (remaining > 0)
719 to_read = MIN (remaining, sizeof (buf));
720 num_read = g_input_stream_read (G_INPUT_STREAM (mis),
731 G_IO_ERROR_INVALID_ARGUMENT,
732 _("Wanted to read %" G_GSIZE_FORMAT " bytes but got EOF"),
737 remaining -= num_read;
738 g_string_append_len (s, buf, num_read);
742 nul = g_data_input_stream_read_byte (dis, NULL, &local_error);
743 if (local_error != NULL)
745 g_propagate_error (error, local_error);
752 G_IO_ERROR_INVALID_ARGUMENT,
753 _("Expected NUL byte after the string `%s' but found `%c' (%d)"),
758 return g_string_free (s, FALSE);
761 g_string_free (s, TRUE);
765 /* if just_align==TRUE, don't read a value, just align the input stream wrt padding */
767 parse_value_from_blob (GMemoryInputStream *mis,
768 GDataInputStream *dis,
769 const GVariantType *type,
778 #ifdef DEBUG_SERIALIZER
782 s = g_variant_type_dup_string (type);
783 g_print ("%*sReading type %s from offset 0x%04x",
786 (gint) g_seekable_tell (G_SEEKABLE (mis)));
789 #endif /* DEBUG_SERIALIZER */
795 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
797 if (!ensure_input_padding (mis, 4, &local_error))
802 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
803 if (local_error != NULL)
805 ret = g_variant_new_boolean (v);
808 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
813 v = g_data_input_stream_read_byte (dis, NULL, &local_error);
814 if (local_error != NULL)
816 ret = g_variant_new_byte (v);
819 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
821 if (!ensure_input_padding (mis, 2, &local_error))
826 v = g_data_input_stream_read_int16 (dis, NULL, &local_error);
827 if (local_error != NULL)
829 ret = g_variant_new_int16 (v);
832 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
834 if (!ensure_input_padding (mis, 2, &local_error))
839 v = g_data_input_stream_read_uint16 (dis, NULL, &local_error);
840 if (local_error != NULL)
842 ret = g_variant_new_uint16 (v);
845 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
847 if (!ensure_input_padding (mis, 4, &local_error))
852 v = g_data_input_stream_read_int32 (dis, NULL, &local_error);
853 if (local_error != NULL)
855 ret = g_variant_new_int32 (v);
858 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
860 if (!ensure_input_padding (mis, 4, &local_error))
865 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
866 if (local_error != NULL)
868 ret = g_variant_new_uint32 (v);
871 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
873 if (!ensure_input_padding (mis, 8, &local_error))
878 v = g_data_input_stream_read_int64 (dis, NULL, &local_error);
879 if (local_error != NULL)
881 ret = g_variant_new_int64 (v);
884 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
886 if (!ensure_input_padding (mis, 8, &local_error))
891 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
892 if (local_error != NULL)
894 ret = g_variant_new_uint64 (v);
897 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
899 if (!ensure_input_padding (mis, 8, &local_error))
905 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
906 if (local_error != NULL)
909 encoded = (gdouble *) &v;
910 ret = g_variant_new_double (*encoded);
913 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
915 if (!ensure_input_padding (mis, 4, &local_error))
921 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
922 if (local_error != NULL)
924 v = read_string (mis, dis, (gsize) len, &local_error);
927 ret = g_variant_new_string (v);
931 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
933 if (!ensure_input_padding (mis, 4, &local_error))
939 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
940 if (local_error != NULL)
942 v = read_string (mis, dis, (gsize) len, &local_error);
945 if (!g_variant_is_object_path (v))
947 g_set_error (&local_error,
949 G_IO_ERROR_INVALID_ARGUMENT,
950 _("Parsed value `%s' is not a valid D-Bus object path"),
955 ret = g_variant_new_object_path (v);
959 else if (g_variant_type_equal (type, G_VARIANT_TYPE_SIGNATURE))
965 len = g_data_input_stream_read_byte (dis, NULL, &local_error);
966 if (local_error != NULL)
968 v = read_string (mis, dis, (gsize) len, &local_error);
971 if (!g_variant_is_signature (v))
973 g_set_error (&local_error,
975 G_IO_ERROR_INVALID_ARGUMENT,
976 _("Parsed value `%s' is not a valid D-Bus signature"),
981 ret = g_variant_new_signature (v);
985 else if (g_variant_type_is_array (type))
990 const GVariantType *element_type;
991 GVariantBuilder builder;
993 if (!ensure_input_padding (mis, 4, &local_error))
1002 array_len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1003 if (local_error != NULL)
1007 #ifdef DEBUG_SERIALIZER
1008 g_print (": array spans 0x%04x bytes\n", array_len);
1009 #endif /* DEBUG_SERIALIZER */
1011 if (array_len > (2<<26))
1013 g_set_error (&local_error,
1015 G_IO_ERROR_INVALID_ARGUMENT,
1016 _("Encountered array of length %" G_GUINT32_FORMAT " bytes. Maximum length is 2<<26 bytes."),
1022 g_variant_builder_init (&builder, type);
1023 element_type = g_variant_type_element (type);
1028 item = parse_value_from_blob (mis,
1034 g_assert (item == NULL);
1038 /* TODO: optimize array of primitive types */
1039 offset = g_seekable_tell (G_SEEKABLE (mis));
1040 target = offset + array_len;
1041 while (offset < target)
1044 item = parse_value_from_blob (mis,
1052 g_variant_builder_clear (&builder);
1055 g_variant_builder_add_value (&builder, item);
1056 offset = g_seekable_tell (G_SEEKABLE (mis));
1062 ret = g_variant_builder_end (&builder);
1066 g_variant_builder_clear (&builder);
1069 else if (g_variant_type_is_dict_entry (type))
1071 const GVariantType *key_type;
1072 const GVariantType *value_type;
1076 if (!ensure_input_padding (mis, 8, &local_error))
1080 #ifdef DEBUG_SERIALIZER
1082 #endif /* DEBUG_SERIALIZER */
1086 key_type = g_variant_type_key (type);
1087 key = parse_value_from_blob (mis,
1096 value_type = g_variant_type_value (type);
1097 value = parse_value_from_blob (mis,
1105 g_variant_unref (key);
1108 ret = g_variant_new_dict_entry (key, value);
1111 else if (g_variant_type_is_tuple (type))
1113 if (!ensure_input_padding (mis, 8, &local_error))
1117 #ifdef DEBUG_SERIALIZER
1119 #endif /* DEBUG_SERIALIZER */
1123 const GVariantType *element_type;
1124 GVariantBuilder builder;
1126 g_variant_builder_init (&builder, type);
1127 element_type = g_variant_type_first (type);
1128 while (element_type != NULL)
1131 item = parse_value_from_blob (mis,
1139 g_variant_builder_clear (&builder);
1142 g_variant_builder_add_value (&builder, item);
1144 element_type = g_variant_type_next (element_type);
1146 ret = g_variant_builder_end (&builder);
1149 else if (g_variant_type_is_variant (type))
1152 #ifdef DEBUG_SERIALIZER
1154 #endif /* DEBUG_SERIALIZER */
1160 GVariantType *variant_type;
1163 siglen = g_data_input_stream_read_byte (dis, NULL, &local_error);
1164 if (local_error != NULL)
1166 sig = read_string (mis, dis, (gsize) siglen, &local_error);
1169 if (!g_variant_is_signature (sig))
1171 g_set_error (&local_error,
1173 G_IO_ERROR_INVALID_ARGUMENT,
1174 _("Parsed value `%s' for variant is not a valid D-Bus signature"),
1179 variant_type = g_variant_type_new (sig);
1181 value = parse_value_from_blob (mis,
1187 g_variant_type_free (variant_type);
1190 ret = g_variant_new_variant (value);
1196 s = g_variant_type_dup_string (type);
1197 g_set_error (&local_error,
1199 G_IO_ERROR_INVALID_ARGUMENT,
1200 _("Error deserializing GVariant with type-string `%s' from the D-Bus wire format"),
1206 g_assert ((just_align && ret == NULL) || (!just_align && ret != NULL));
1208 #ifdef DEBUG_SERIALIZER
1214 if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1216 s = g_strdup_printf ("0x%02x '%c'", g_variant_get_byte (ret), g_variant_get_byte (ret));
1220 s = g_variant_print (ret, FALSE);
1222 g_print (": %s\n", s);
1226 #endif /* DEBUG_SERIALIZER */
1231 #ifdef DEBUG_SERIALIZER
1233 "%*sFAILURE: %s (%s, %d)\n",
1235 local_error->message,
1236 g_quark_to_string (local_error->domain),
1238 #endif /* DEBUG_SERIALIZER */
1239 g_propagate_error (error, local_error);
1243 /* ---------------------------------------------------------------------------------------------------- */
1245 /* message_header must be at least 16 bytes */
1248 * g_dbus_message_bytes_needed:
1249 * @blob: A blob represent a binary D-Bus message.
1250 * @blob_len: The length of @blob (must be at least 16).
1251 * @error: Return location for error or %NULL.
1253 * Utility function to calculate how many bytes are needed to
1254 * completely deserialize the D-Bus message stored at @blob.
1256 * Returns: Number of bytes needed or -1 if @error is set (e.g. if
1257 * @blob contains invalid data or not enough data is available to
1258 * determine the size).
1263 g_dbus_message_bytes_needed (guchar *blob,
1271 g_return_val_if_fail (blob != NULL, -1);
1272 g_return_val_if_fail (error == NULL || *error == NULL, -1);
1273 g_return_val_if_fail (blob_len >= 16, -1);
1277 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1278 ret = 12 + 4 + GUINT32_FROM_LE (((guint32 *) blob)[3]);
1279 /* round up so it's a multiple of 8 */
1280 ret = 8 * ((ret + 7)/8);
1281 /* finally add the body size */
1282 ret += GUINT32_FROM_LE (((guint32 *) blob)[1]);
1284 else if (blob[0] == 'B')
1286 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1287 ret = 12 + 4 + GUINT32_FROM_BE (((guint32 *) blob)[3]);
1288 /* round up so it's a multiple of 8 */
1289 ret = 8 * ((ret + 7)/8);
1290 /* finally add the body size */
1291 ret += GUINT32_FROM_BE (((guint32 *) blob)[1]);
1297 G_IO_ERROR_INVALID_ARGUMENT,
1298 "Unable to determine message blob length - given blob is malformed");
1305 G_IO_ERROR_INVALID_ARGUMENT,
1306 "Blob indicates that message exceeds maximum message length (128MiB)");
1313 /* ---------------------------------------------------------------------------------------------------- */
1316 * g_dbus_message_new_from_blob:
1317 * @blob: A blob represent a binary D-Bus message.
1318 * @blob_len: The length of @blob.
1319 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
1320 * @error: Return location for error or %NULL.
1322 * Creates a new #GDBusMessage from the data stored at @blob.
1324 * Returns: A new #GDBusMessage or %NULL if @error is set. Free with
1330 g_dbus_message_new_from_blob (guchar *blob,
1332 GDBusCapabilityFlags capabilities,
1336 GMemoryInputStream *mis;
1337 GDataInputStream *dis;
1338 GDBusMessage *message;
1340 guchar major_protocol_version;
1341 GDataStreamByteOrder byte_order;
1342 guint32 message_body_len;
1346 GVariant *signature;
1348 /* TODO: check against @capabilities */
1352 g_return_val_if_fail (blob != NULL, NULL);
1353 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1354 g_return_val_if_fail (blob_len >= 12, NULL);
1356 message = g_dbus_message_new ();
1358 mis = G_MEMORY_INPUT_STREAM (g_memory_input_stream_new_from_data (blob, blob_len, NULL));
1359 dis = g_data_input_stream_new (G_INPUT_STREAM (mis));
1361 endianness = g_data_input_stream_read_byte (dis, NULL, NULL);
1365 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1368 byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
1373 G_IO_ERROR_INVALID_ARGUMENT,
1374 _("Invalid endianness value. Expected 'l' or 'B' but found '%c' (%d)"),
1375 endianness, endianness);
1378 g_data_input_stream_set_byte_order (dis, byte_order);
1380 message->priv->type = g_data_input_stream_read_byte (dis, NULL, NULL);
1381 message->priv->flags = g_data_input_stream_read_byte (dis, NULL, NULL);
1382 major_protocol_version = g_data_input_stream_read_byte (dis, NULL, NULL);
1383 if (major_protocol_version != 1)
1387 G_IO_ERROR_INVALID_ARGUMENT,
1388 _("Invalid major protocol version. Expected 1 but found %d"),
1389 major_protocol_version);
1392 message_body_len = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1393 message->priv->serial = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1395 #ifdef DEBUG_SERIALIZER
1396 g_print ("Parsing blob (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1399 s = _g_dbus_hexdump ((const gchar *) blob, blob_len, 2);
1400 g_print ("%s\n", s);
1403 #endif /* DEBUG_SERIALIZER */
1405 #ifdef DEBUG_SERIALIZER
1406 g_print ("Parsing headers (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1407 #endif /* DEBUG_SERIALIZER */
1408 headers = parse_value_from_blob (mis,
1410 G_VARIANT_TYPE ("a{yv}"),
1414 if (headers == NULL)
1416 g_variant_ref_sink (headers);
1417 g_variant_iter_init (&iter, headers);
1418 while ((item = g_variant_iter_next_value (&iter)))
1420 guchar header_field;
1422 g_variant_get (item,
1426 g_dbus_message_set_header (message, header_field, value);
1428 g_variant_unref (headers);
1430 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
1431 if (signature != NULL)
1433 const gchar *signature_str;
1434 gsize signature_str_len;
1436 signature_str = g_variant_get_string (signature, &signature_str_len);
1438 /* signature but no body */
1439 if (message_body_len == 0 && signature_str_len > 0)
1443 G_IO_ERROR_INVALID_ARGUMENT,
1444 _("Signature header with signature `%s' found but message body is empty"),
1448 else if (signature_str_len > 0)
1450 GVariantType *variant_type;
1451 gchar *tupled_signature_str;
1453 if (!g_variant_is_signature (signature_str))
1457 G_IO_ERROR_INVALID_ARGUMENT,
1458 _("Parsed value `%s' is not a valid D-Bus signature (for body)"),
1462 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
1463 variant_type = g_variant_type_new (tupled_signature_str);
1464 g_free (tupled_signature_str);
1465 #ifdef DEBUG_SERIALIZER
1466 g_print ("Parsing body (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1467 #endif /* DEBUG_SERIALIZER */
1468 message->priv->body = parse_value_from_blob (mis,
1474 if (message->priv->body == NULL)
1476 g_variant_type_free (variant_type);
1479 g_variant_ref_sink (message->priv->body);
1480 g_variant_type_free (variant_type);
1485 /* no signature, this is only OK if the body is empty */
1486 if (message_body_len != 0)
1490 G_IO_ERROR_INVALID_ARGUMENT,
1491 _("No signature header in message but the message body is %" G_GUINT32_FORMAT " bytes"),
1501 g_object_unref (dis);
1502 g_object_unref (mis);
1510 if (message != NULL)
1511 g_object_unref (message);
1516 /* ---------------------------------------------------------------------------------------------------- */
1519 ensure_output_padding (GMemoryOutputStream *mos,
1520 GDataOutputStream *dos,
1524 gsize wanted_offset;
1525 gsize padding_needed;
1528 offset = g_memory_output_stream_get_data_size (mos);
1529 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
1530 padding_needed = wanted_offset - offset;
1532 for (n = 0; n < padding_needed; n++)
1533 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1535 return padding_needed;
1538 /* note that value can be NULL for e.g. empty arrays - type is never NULL */
1540 append_value_to_blob (GVariant *value,
1541 const GVariantType *type,
1542 GMemoryOutputStream *mos,
1543 GDataOutputStream *dos,
1544 gsize *out_padding_added,
1547 gsize padding_added;
1551 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
1553 padding_added = ensure_output_padding (mos, dos, 4);
1556 gboolean v = g_variant_get_boolean (value);
1557 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1560 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1564 guint8 v = g_variant_get_byte (value);
1565 g_data_output_stream_put_byte (dos, v, NULL, NULL);
1568 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
1570 padding_added = ensure_output_padding (mos, dos, 2);
1573 gint16 v = g_variant_get_int16 (value);
1574 g_data_output_stream_put_int16 (dos, v, NULL, NULL);
1577 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
1579 padding_added = ensure_output_padding (mos, dos, 2);
1582 guint16 v = g_variant_get_uint16 (value);
1583 g_data_output_stream_put_uint16 (dos, v, NULL, NULL);
1586 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
1588 padding_added = ensure_output_padding (mos, dos, 4);
1591 gint32 v = g_variant_get_int32 (value);
1592 g_data_output_stream_put_int32 (dos, v, NULL, NULL);
1595 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
1597 padding_added = ensure_output_padding (mos, dos, 4);
1600 guint32 v = g_variant_get_uint32 (value);
1601 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1604 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
1606 padding_added = ensure_output_padding (mos, dos, 8);
1609 gint64 v = g_variant_get_int64 (value);
1610 g_data_output_stream_put_int64 (dos, v, NULL, NULL);
1613 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
1615 padding_added = ensure_output_padding (mos, dos, 8);
1618 guint64 v = g_variant_get_uint64 (value);
1619 g_data_output_stream_put_uint64 (dos, v, NULL, NULL);
1622 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
1624 padding_added = ensure_output_padding (mos, dos, 8);
1628 gdouble v = g_variant_get_double (value);
1630 encoded = (guint64 *) &v;
1631 g_data_output_stream_put_uint64 (dos, *encoded, NULL, NULL);
1634 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
1636 padding_added = ensure_output_padding (mos, dos, 4);
1640 const gchar *v = g_variant_get_string (value, &len);
1641 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1642 g_data_output_stream_put_string (dos, v, NULL, NULL);
1643 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1646 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
1648 padding_added = ensure_output_padding (mos, dos, 4);
1651 /* TODO: validate object path */
1653 const gchar *v = g_variant_get_string (value, &len);
1654 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1655 g_data_output_stream_put_string (dos, v, NULL, NULL);
1656 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1659 else if (g_variant_type_equal (type, G_VARIANT_TYPE_SIGNATURE))
1663 /* TODO: validate signature (including max len being 255) */
1665 const gchar *v = g_variant_get_string (value, &len);
1666 g_data_output_stream_put_byte (dos, len, NULL, NULL);
1667 g_data_output_stream_put_string (dos, v, NULL, NULL);
1668 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1671 else if (g_variant_type_is_array (type))
1675 goffset array_len_offset;
1676 goffset array_payload_begin_offset;
1680 padding_added = ensure_output_padding (mos, dos, 4);
1683 /* array length - will be filled in later */
1684 array_len_offset = g_memory_output_stream_get_data_size (mos);
1685 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
1687 /* From the D-Bus spec:
1689 * "A UINT32 giving the length of the array data in bytes,
1690 * followed by alignment padding to the alignment boundary of
1691 * the array element type, followed by each array element. The
1692 * array length is from the end of the alignment padding to
1693 * the end of the last element, i.e. it does not include the
1694 * padding after the length, or any padding after the last
1697 * Thus, we need to count how much padding the first element
1698 * contributes and subtract that from the array length.
1700 array_payload_begin_offset = g_memory_output_stream_get_data_size (mos);
1702 if (g_variant_n_children (value) == 0)
1704 gsize padding_added_for_item;
1705 if (!append_value_to_blob (NULL,
1706 g_variant_type_element (type),
1709 &padding_added_for_item,
1712 array_payload_begin_offset += padding_added_for_item;
1718 g_variant_iter_init (&iter, value);
1719 while ((item = g_variant_iter_next_value (&iter)))
1721 gsize padding_added_for_item;
1722 if (!append_value_to_blob (item,
1723 g_variant_get_type (item),
1726 &padding_added_for_item,
1731 array_payload_begin_offset += padding_added_for_item;
1737 cur_offset = g_memory_output_stream_get_data_size (mos);
1739 array_len = cur_offset - array_payload_begin_offset;
1741 if (!g_seekable_seek (G_SEEKABLE (mos), array_len_offset, G_SEEK_SET, NULL, error))
1744 g_data_output_stream_put_uint32 (dos, array_len, NULL, NULL);
1746 if (!g_seekable_seek (G_SEEKABLE (mos), cur_offset, G_SEEK_SET, NULL, error))
1750 else if (g_variant_type_is_dict_entry (type) || g_variant_type_is_tuple (type))
1752 padding_added = ensure_output_padding (mos, dos, 8);
1757 g_variant_iter_init (&iter, value);
1758 while ((item = g_variant_iter_next_value (&iter)))
1760 if (!append_value_to_blob (item,
1761 g_variant_get_type (item),
1770 else if (g_variant_type_is_variant (type))
1775 const gchar *signature;
1776 child = g_variant_get_child_value (value, 0);
1777 signature = g_variant_get_type_string (child);
1778 /* TODO: validate signature (including max len being 255) */
1779 g_data_output_stream_put_byte (dos, strlen (signature), NULL, NULL);
1780 g_data_output_stream_put_string (dos, signature, NULL, NULL);
1781 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1782 if (!append_value_to_blob (child,
1783 g_variant_get_type (child),
1789 g_variant_unref (child);
1792 g_variant_unref (child);
1799 G_IO_ERROR_INVALID_ARGUMENT,
1800 _("Error serializing GVariant with type-string `%s' to the D-Bus wire format"),
1801 g_variant_get_type_string (value));
1805 if (out_padding_added != NULL)
1806 *out_padding_added = padding_added;
1815 append_body_to_blob (GVariant *value,
1816 GMemoryOutputStream *mos,
1817 GDataOutputStream *dos,
1826 if (!g_variant_is_of_type (value, G_VARIANT_TYPE_TUPLE))
1830 G_IO_ERROR_INVALID_ARGUMENT,
1831 "Expected a tuple for the body of the GDBusMessage.");
1835 g_variant_iter_init (&iter, value);
1836 while ((item = g_variant_iter_next_value (&iter)))
1838 if (!append_value_to_blob (item,
1839 g_variant_get_type (item),
1852 /* ---------------------------------------------------------------------------------------------------- */
1855 * g_dbus_message_to_blob:
1856 * @message: A #GDBusMessage.
1857 * @out_size: Return location for size of generated blob.
1858 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
1859 * @error: Return location for error.
1861 * Serializes @message to a blob.
1863 * Returns: A pointer to a valid binary D-Bus message of @out_size bytes
1864 * generated by @message or %NULL if @error is set. Free with g_free().
1869 g_dbus_message_to_blob (GDBusMessage *message,
1871 GDBusCapabilityFlags capabilities,
1874 GMemoryOutputStream *mos;
1875 GDataOutputStream *dos;
1878 GDataStreamByteOrder byte_order;
1879 goffset body_len_offset;
1880 goffset body_start_offset;
1882 GVariant *header_fields;
1883 GVariantBuilder builder;
1884 GHashTableIter hash_iter;
1886 GVariant *header_value;
1887 GVariant *signature;
1888 const gchar *signature_str;
1889 gint num_fds_in_message;
1890 gint num_fds_according_to_header;
1892 /* TODO: check against @capabilities */
1896 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1897 g_return_val_if_fail (out_size != NULL, NULL);
1898 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1900 mos = G_MEMORY_OUTPUT_STREAM (g_memory_output_stream_new (NULL, 0, g_realloc, g_free));
1901 dos = g_data_output_stream_new (G_OUTPUT_STREAM (mos));
1903 /* TODO: detect endianess... */
1904 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1905 g_data_output_stream_set_byte_order (dos, byte_order);
1908 g_data_output_stream_put_byte (dos, byte_order == G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN ? 'l' : 'B', NULL, NULL);
1909 g_data_output_stream_put_byte (dos, message->priv->type, NULL, NULL);
1910 g_data_output_stream_put_byte (dos, message->priv->flags, NULL, NULL);
1911 g_data_output_stream_put_byte (dos, 1, NULL, NULL); /* major protocol version */
1912 body_len_offset = g_memory_output_stream_get_data_size (mos);
1913 /* body length - will be filled in later */
1914 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
1915 g_data_output_stream_put_uint32 (dos, message->priv->serial, NULL, NULL);
1917 num_fds_in_message = 0;
1919 if (message->priv->fd_list != NULL)
1920 num_fds_in_message = g_unix_fd_list_get_length (message->priv->fd_list);
1922 num_fds_according_to_header = g_dbus_message_get_num_unix_fds (message);
1923 /* TODO: check we have all the right header fields and that they are the correct value etc etc */
1924 if (num_fds_in_message != num_fds_according_to_header)
1928 G_IO_ERROR_INVALID_ARGUMENT,
1929 _("Message has %d fds but the header field indicates %d fds"),
1931 num_fds_according_to_header);
1935 g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{yv}"));
1936 g_hash_table_iter_init (&hash_iter, message->priv->headers);
1937 while (g_hash_table_iter_next (&hash_iter, &key, (gpointer) &header_value))
1939 g_variant_builder_add (&builder,
1941 (guchar) GPOINTER_TO_UINT (key),
1944 header_fields = g_variant_builder_end (&builder);
1946 if (!append_value_to_blob (header_fields,
1947 g_variant_get_type (header_fields),
1952 g_variant_unref (header_fields);
1955 g_variant_unref (header_fields);
1957 /* header size must be a multiple of 8 */
1958 ensure_output_padding (mos, dos, 8);
1960 body_start_offset = g_memory_output_stream_get_data_size (mos);
1962 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
1963 signature_str = NULL;
1964 if (signature != NULL)
1965 signature_str = g_variant_get_string (signature, NULL);
1966 if (message->priv->body != NULL)
1968 gchar *tupled_signature_str;
1969 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
1970 if (signature == NULL)
1974 G_IO_ERROR_INVALID_ARGUMENT,
1975 _("Message body has signature `%s' but there is no signature header"),
1977 g_free (tupled_signature_str);
1980 else if (g_strcmp0 (tupled_signature_str, g_variant_get_type_string (message->priv->body)) != 0)
1984 G_IO_ERROR_INVALID_ARGUMENT,
1985 _("Message body has type signature `%s' but signature in the header field is `%s'"),
1986 tupled_signature_str, g_variant_get_type_string (message->priv->body));
1987 g_free (tupled_signature_str);
1990 g_free (tupled_signature_str);
1991 if (!append_body_to_blob (message->priv->body, mos, dos, error))
1996 if (signature != NULL)
2000 G_IO_ERROR_INVALID_ARGUMENT,
2001 _("Message body is empty but signature in the header field is `(%s)'"),
2007 /* OK, we're done writing the message - set the body length */
2008 size = g_memory_output_stream_get_data_size (mos);
2009 body_size = size - body_start_offset;
2011 if (!g_seekable_seek (G_SEEKABLE (mos), body_len_offset, G_SEEK_SET, NULL, error))
2014 g_data_output_stream_put_uint32 (dos, body_size, NULL, NULL);
2017 ret = g_memdup (g_memory_output_stream_get_data (mos), size);
2020 g_object_unref (dos);
2021 g_object_unref (mos);
2026 /* ---------------------------------------------------------------------------------------------------- */
2029 get_uint32_header (GDBusMessage *message,
2030 GDBusMessageHeaderField header_field)
2036 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
2037 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_UINT32))
2038 ret = g_variant_get_uint32 (value);
2043 static const gchar *
2044 get_string_header (GDBusMessage *message,
2045 GDBusMessageHeaderField header_field)
2051 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
2052 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
2053 ret = g_variant_get_string (value, NULL);
2058 static const gchar *
2059 get_object_path_header (GDBusMessage *message,
2060 GDBusMessageHeaderField header_field)
2066 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
2067 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_OBJECT_PATH))
2068 ret = g_variant_get_string (value, NULL);
2073 static const gchar *
2074 get_signature_header (GDBusMessage *message,
2075 GDBusMessageHeaderField header_field)
2081 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
2082 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_SIGNATURE))
2083 ret = g_variant_get_string (value, NULL);
2088 /* ---------------------------------------------------------------------------------------------------- */
2091 set_uint32_header (GDBusMessage *message,
2092 GDBusMessageHeaderField header_field,
2095 g_dbus_message_set_header (message,
2097 g_variant_new_uint32 (value));
2101 set_string_header (GDBusMessage *message,
2102 GDBusMessageHeaderField header_field,
2105 g_dbus_message_set_header (message,
2107 value == NULL ? NULL : g_variant_new_string (value));
2111 set_object_path_header (GDBusMessage *message,
2112 GDBusMessageHeaderField header_field,
2115 g_dbus_message_set_header (message,
2117 value == NULL ? NULL : g_variant_new_object_path (value));
2121 set_signature_header (GDBusMessage *message,
2122 GDBusMessageHeaderField header_field,
2125 g_dbus_message_set_header (message,
2127 value == NULL ? NULL : g_variant_new_signature (value));
2130 /* ---------------------------------------------------------------------------------------------------- */
2133 * g_dbus_message_get_reply_serial:
2134 * @message: A #GDBusMessage.
2136 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2138 * Returns: The value.
2143 g_dbus_message_get_reply_serial (GDBusMessage *message)
2145 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2146 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL);
2150 * g_dbus_message_set_reply_serial:
2151 * @message: A #GDBusMessage.
2152 * @value: The value to set.
2154 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2159 g_dbus_message_set_reply_serial (GDBusMessage *message,
2162 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2163 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL, value);
2166 /* ---------------------------------------------------------------------------------------------------- */
2169 * g_dbus_message_get_interface:
2170 * @message: A #GDBusMessage.
2172 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2174 * Returns: The value.
2179 g_dbus_message_get_interface (GDBusMessage *message)
2181 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2182 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE);
2186 * g_dbus_message_set_interface:
2187 * @message: A #GDBusMessage.
2188 * @value: The value to set.
2190 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2195 g_dbus_message_set_interface (GDBusMessage *message,
2198 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2199 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2200 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE, value);
2203 /* ---------------------------------------------------------------------------------------------------- */
2206 * g_dbus_message_get_member:
2207 * @message: A #GDBusMessage.
2209 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2211 * Returns: The value.
2216 g_dbus_message_get_member (GDBusMessage *message)
2218 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2219 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER);
2223 * g_dbus_message_set_member:
2224 * @message: A #GDBusMessage.
2225 * @value: The value to set.
2227 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2232 g_dbus_message_set_member (GDBusMessage *message,
2235 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2236 g_return_if_fail (value == NULL || g_dbus_is_member_name (value));
2237 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER, value);
2240 /* ---------------------------------------------------------------------------------------------------- */
2243 * g_dbus_message_get_path:
2244 * @message: A #GDBusMessage.
2246 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2248 * Returns: The value.
2253 g_dbus_message_get_path (GDBusMessage *message)
2255 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2256 return get_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH);
2260 * g_dbus_message_set_path:
2261 * @message: A #GDBusMessage.
2262 * @value: The value to set.
2264 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2269 g_dbus_message_set_path (GDBusMessage *message,
2272 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2273 g_return_if_fail (value == NULL || g_variant_is_object_path (value));
2274 set_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH, value);
2277 /* ---------------------------------------------------------------------------------------------------- */
2280 * g_dbus_message_get_sender:
2281 * @message: A #GDBusMessage.
2283 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2285 * Returns: The value.
2290 g_dbus_message_get_sender (GDBusMessage *message)
2292 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2293 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER);
2297 * g_dbus_message_set_sender:
2298 * @message: A #GDBusMessage.
2299 * @value: The value to set.
2301 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2306 g_dbus_message_set_sender (GDBusMessage *message,
2309 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2310 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2311 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER, value);
2314 /* ---------------------------------------------------------------------------------------------------- */
2317 * g_dbus_message_get_destination:
2318 * @message: A #GDBusMessage.
2320 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2322 * Returns: The value.
2327 g_dbus_message_get_destination (GDBusMessage *message)
2329 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2330 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION);
2334 * g_dbus_message_set_destination:
2335 * @message: A #GDBusMessage.
2336 * @value: The value to set.
2338 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2343 g_dbus_message_set_destination (GDBusMessage *message,
2346 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2347 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2348 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION, value);
2351 /* ---------------------------------------------------------------------------------------------------- */
2354 * g_dbus_message_get_error_name:
2355 * @message: A #GDBusMessage.
2357 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2359 * Returns: The value.
2364 g_dbus_message_get_error_name (GDBusMessage *message)
2366 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2367 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME);
2371 * g_dbus_message_set_error_name:
2372 * @message: A #GDBusMessage.
2373 * @value: The value to set.
2375 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2380 g_dbus_message_set_error_name (GDBusMessage *message,
2383 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2384 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2385 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME, value);
2388 /* ---------------------------------------------------------------------------------------------------- */
2391 * g_dbus_message_get_signature:
2392 * @message: A #GDBusMessage.
2394 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2396 * Returns: The value.
2401 g_dbus_message_get_signature (GDBusMessage *message)
2404 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2405 ret = get_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2412 * g_dbus_message_set_signature:
2413 * @message: A #GDBusMessage.
2414 * @value: The value to set.
2416 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2421 g_dbus_message_set_signature (GDBusMessage *message,
2424 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2425 g_return_if_fail (value == NULL || g_variant_is_signature (value));
2426 set_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE, value);
2429 /* ---------------------------------------------------------------------------------------------------- */
2432 * g_dbus_message_get_arg0:
2433 * @message: A #GDBusMessage.
2435 * Convenience to get the first item in the body of @message.
2437 * Returns: The string item or %NULL if the first item in the body of
2438 * @message is not a string.
2443 g_dbus_message_get_arg0 (GDBusMessage *message)
2447 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2451 if (message->priv->body != NULL && g_variant_is_of_type (message->priv->body, G_VARIANT_TYPE_TUPLE))
2454 item = g_variant_get_child_value (message->priv->body, 0);
2455 if (g_variant_is_of_type (item, G_VARIANT_TYPE_STRING))
2456 ret = g_variant_get_string (item, NULL);
2462 /* ---------------------------------------------------------------------------------------------------- */
2465 * g_dbus_message_get_num_unix_fds:
2466 * @message: A #GDBusMessage.
2468 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2470 * Returns: The value.
2475 g_dbus_message_get_num_unix_fds (GDBusMessage *message)
2477 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2478 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS);
2482 * g_dbus_message_set_num_unix_fds:
2483 * @message: A #GDBusMessage.
2484 * @value: The value to set.
2486 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2491 g_dbus_message_set_num_unix_fds (GDBusMessage *message,
2494 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2495 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS, value);
2498 /* ---------------------------------------------------------------------------------------------------- */
2501 * g_dbus_message_to_gerror:
2502 * @message: A #GDBusMessage.
2503 * @error: The #GError to set.
2505 * If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does
2506 * nothing and returns %FALSE.
2508 * Otherwise this method encodes the error in @message as a #GError
2509 * using g_dbus_error_set_dbus_error() using the information in the
2510 * %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of @message as
2511 * well as the first string item in @message's body.
2513 * Returns: %TRUE if @error was set, %FALSE otherwise.
2518 g_dbus_message_to_gerror (GDBusMessage *message,
2522 const gchar *error_name;
2524 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2527 if (message->priv->type != G_DBUS_MESSAGE_TYPE_ERROR)
2530 error_name = g_dbus_message_get_error_name (message);
2531 if (error_name != NULL)
2535 body = g_dbus_message_get_body (message);
2537 if (body != NULL && g_variant_is_of_type (body, G_VARIANT_TYPE ("(s)")))
2539 const gchar *error_message;
2540 g_variant_get (body, "(&s)", &error_message);
2541 g_dbus_error_set_dbus_error (error,
2548 /* these two situations are valid, yet pretty rare */
2551 g_dbus_error_set_dbus_error (error,
2554 _("Error return with body of type `%s'"),
2555 g_variant_get_type_string (body));
2559 g_dbus_error_set_dbus_error (error,
2562 _("Error return with empty body"));
2568 /* TOOD: this shouldn't happen - should check this at message serialization
2569 * time and disconnect the peer.
2574 "Error return without error-name header!");
2583 /* ---------------------------------------------------------------------------------------------------- */
2586 enum_to_string (GType enum_type, gint value)
2590 GEnumValue *enum_value;
2592 klass = g_type_class_ref (enum_type);
2593 enum_value = g_enum_get_value (klass, value);
2594 if (enum_value != NULL)
2595 ret = g_strdup (enum_value->value_nick);
2597 ret = g_strdup_printf ("unknown (value %d)", value);
2598 g_type_class_unref (klass);
2603 flags_to_string (GType flags_type, guint value)
2609 klass = g_type_class_ref (flags_type);
2610 s = g_string_new (NULL);
2611 for (n = 0; n < 32; n++)
2613 if ((value & (1<<n)) != 0)
2615 GFlagsValue *flags_value;
2616 flags_value = g_flags_get_first_value (klass, (1<<n));
2618 g_string_append_c (s, ',');
2619 if (flags_value != NULL)
2620 g_string_append (s, flags_value->value_nick);
2622 g_string_append_printf (s, "unknown (bit %d)", n);
2626 g_string_append (s, "none");
2627 g_type_class_unref (klass);
2628 return g_string_free (s, FALSE);;
2632 _sort_keys_func (gconstpointer a,
2638 ia = GPOINTER_TO_INT (a);
2639 ib = GPOINTER_TO_INT (b);
2645 * g_dbus_message_print:
2646 * @message: A #GDBusMessage.
2647 * @indent: Indentation level.
2649 * Produces a human-readable multi-line description of @message.
2651 * The contents of the description has no ABI guarantees, the contents
2652 * and formatting is subject to change at any time. Typical output
2653 * looks something like this:
2660 * path -> objectpath '/org/gtk/GDBus/TestObject'
2661 * interface -> 'org.gtk.GDBus.TestInterface'
2662 * member -> 'GimmeStdout'
2663 * destination -> ':1.146'
2665 * UNIX File Descriptors:
2670 * Type: method-return
2671 * Flags: no-reply-expected
2675 * reply-serial -> uint32 4
2676 * destination -> ':1.159'
2677 * sender -> ':1.146'
2678 * num-unix-fds -> uint32 1
2680 * UNIX File Descriptors:
2681 * fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635
2684 * Returns: A string that should be freed with g_free().
2689 g_dbus_message_print (GDBusMessage *message,
2697 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2699 str = g_string_new (NULL);
2701 s = enum_to_string (G_TYPE_DBUS_MESSAGE_TYPE, message->priv->type);
2702 g_string_append_printf (str, "%*sType: %s\n", indent, "", s);
2704 s = flags_to_string (G_TYPE_DBUS_MESSAGE_FLAGS, message->priv->flags);
2705 g_string_append_printf (str, "%*sFlags: %s\n", indent, "", s);
2707 g_string_append_printf (str, "%*sVersion: %d\n", indent, "", message->priv->major_protocol_version);
2708 g_string_append_printf (str, "%*sSerial: %d\n", indent, "", message->priv->serial);
2710 g_string_append_printf (str, "%*sHeaders:\n", indent, "");
2711 keys = g_hash_table_get_keys (message->priv->headers);
2712 keys = g_list_sort (keys, _sort_keys_func);
2715 for (l = keys; l != NULL; l = l->next)
2717 gint key = GPOINTER_TO_INT (l->data);
2721 value = g_hash_table_lookup (message->priv->headers, l->data);
2722 g_assert (value != NULL);
2724 s = enum_to_string (G_TYPE_DBUS_MESSAGE_HEADER_FIELD, key);
2725 value_str = g_variant_print (value, TRUE);
2726 g_string_append_printf (str, "%*s %s -> %s\n", indent, "", s, value_str);
2733 g_string_append_printf (str, "%*s (none)\n", indent, "");
2735 g_string_append_printf (str, "%*sBody: ", indent, "");
2736 if (message->priv->body != NULL)
2738 g_variant_print_string (message->priv->body,
2744 g_string_append (str, "()");
2746 g_string_append (str, "\n");
2748 g_string_append_printf (str, "%*sUNIX File Descriptors:\n", indent, "");
2749 if (message->priv->fd_list != NULL)
2755 fds = g_unix_fd_list_peek_fds (message->priv->fd_list, &num_fds);
2758 for (n = 0; n < num_fds; n++)
2761 struct stat statbuf;
2762 fs = g_string_new (NULL);
2763 if (fstat (fds[n], &statbuf) == 0)
2765 g_string_append_printf (fs, "%s" "dev=%d:%d", fs->len > 0 ? "," : "",
2766 major (statbuf.st_dev), minor (statbuf.st_dev));
2767 g_string_append_printf (fs, "%s" "mode=0%o", fs->len > 0 ? "," : "",
2769 g_string_append_printf (fs, "%s" "ino=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2770 (guint64) statbuf.st_ino);
2771 g_string_append_printf (fs, "%s" "uid=%d", fs->len > 0 ? "," : "",
2773 g_string_append_printf (fs, "%s" "gid=%d", fs->len > 0 ? "," : "",
2775 g_string_append_printf (fs, "%s" "rdev=%d:%d", fs->len > 0 ? "," : "",
2776 major (statbuf.st_rdev), minor (statbuf.st_rdev));
2777 g_string_append_printf (fs, "%s" "size=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2778 (guint64) statbuf.st_size);
2779 g_string_append_printf (fs, "%s" "atime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2780 (guint64) statbuf.st_atime);
2781 g_string_append_printf (fs, "%s" "mtime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2782 (guint64) statbuf.st_mtime);
2783 g_string_append_printf (fs, "%s" "ctime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2784 (guint64) statbuf.st_ctime);
2788 g_string_append_printf (fs, "(fstat failed: %s)", strerror (errno));
2790 g_string_append_printf (str, "%*s fd %d: %s\n", indent, "", fds[n], fs->str);
2791 g_string_free (fs, TRUE);
2796 g_string_append_printf (str, "%*s (empty)\n", indent, "");
2801 g_string_append_printf (str, "%*s (none)\n", indent, "");
2805 return g_string_free (str, FALSE);
2809 #define __G_DBUS_MESSAGE_C__
2810 #include "gioaliasdef.c"