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 typedef struct _GDBusMessageClass GDBusMessageClass;
71 * Class structure for #GDBusMessage.
75 struct _GDBusMessageClass
78 GObjectClass parent_class;
84 * The #GDBusMessage structure contains only private data and should
85 * only be accessed using the provided API.
92 GObject parent_instance;
94 GDBusMessageType type;
95 GDBusMessageFlags flags;
96 guchar major_protocol_version;
101 GUnixFDList *fd_list;
105 G_DEFINE_TYPE (GDBusMessage, g_dbus_message, G_TYPE_OBJECT);
108 g_dbus_message_finalize (GObject *object)
110 GDBusMessage *message = G_DBUS_MESSAGE (object);
112 if (message->headers != NULL)
113 g_hash_table_unref (message->headers);
114 if (message->body != NULL)
115 g_variant_unref (message->body);
117 if (message->fd_list != NULL)
118 g_object_unref (message->fd_list);
121 if (G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize != NULL)
122 G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize (object);
126 g_dbus_message_class_init (GDBusMessageClass *klass)
128 GObjectClass *gobject_class;
130 gobject_class = G_OBJECT_CLASS (klass);
132 gobject_class->finalize = g_dbus_message_finalize;
136 g_dbus_message_init (GDBusMessage *message)
138 message->headers = g_hash_table_new_full (g_direct_hash,
141 (GDestroyNotify) g_variant_unref);
145 * g_dbus_message_new:
147 * Creates a new empty #GDBusMessage.
149 * Returns: A #GDBusMessage. Free with g_object_unref().
154 g_dbus_message_new (void)
156 return g_object_new (G_TYPE_DBUS_MESSAGE, NULL);
160 * g_dbus_message_new_method_call:
161 * @name: A valid D-Bus name or %NULL.
162 * @path: A valid object path.
163 * @interface_: A valid D-Bus interface name or %NULL.
164 * @method: A valid method name.
166 * Creates a new #GDBusMessage for a method call.
168 * Returns: A #GDBusMessage. Free with g_object_unref().
173 g_dbus_message_new_method_call (const gchar *name,
175 const gchar *interface_,
178 GDBusMessage *message;
180 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
181 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
182 g_return_val_if_fail (g_dbus_is_member_name (method), NULL);
183 g_return_val_if_fail (interface_ == NULL || g_dbus_is_interface_name (interface_), NULL);
185 message = g_dbus_message_new ();
186 message->type = G_DBUS_MESSAGE_TYPE_METHOD_CALL;
189 g_dbus_message_set_destination (message, name);
190 g_dbus_message_set_path (message, path);
191 g_dbus_message_set_member (message, method);
192 if (interface_ != NULL)
193 g_dbus_message_set_interface (message, interface_);
199 * g_dbus_message_new_signal:
200 * @path: A valid object path.
201 * @interface_: A valid D-Bus interface name or %NULL.
202 * @signal: A valid signal name.
204 * Creates a new #GDBusMessage for a signal emission.
206 * Returns: A #GDBusMessage. Free with g_object_unref().
211 g_dbus_message_new_signal (const gchar *path,
212 const gchar *interface_,
215 GDBusMessage *message;
217 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
218 g_return_val_if_fail (g_dbus_is_member_name (signal), NULL);
219 g_return_val_if_fail (interface_ == NULL || g_dbus_is_interface_name (interface_), NULL);
221 message = g_dbus_message_new ();
222 message->type = G_DBUS_MESSAGE_TYPE_SIGNAL;
223 message->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
225 g_dbus_message_set_path (message, path);
226 g_dbus_message_set_member (message, signal);
228 if (interface_ != NULL)
229 g_dbus_message_set_interface (message, interface_);
236 * g_dbus_message_new_method_reply:
237 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
238 * create a reply message to.
240 * Creates a new #GDBusMessage that is a reply to @method_call_message.
242 * Returns: A #GDBusMessage. Free with g_object_unref().
247 g_dbus_message_new_method_reply (GDBusMessage *method_call_message)
249 GDBusMessage *message;
252 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
253 g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
254 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
256 message = g_dbus_message_new ();
257 message->type = G_DBUS_MESSAGE_TYPE_METHOD_RETURN;
258 message->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
260 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
261 sender = g_dbus_message_get_sender (method_call_message);
263 g_dbus_message_set_destination (message, sender);
269 * g_dbus_message_new_method_error:
270 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
271 * create a reply message to.
272 * @error_name: A valid D-Bus error name.
273 * @error_message_format: The D-Bus error message in a printf() format.
274 * @...: Arguments for @error_message_format.
276 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
278 * Returns: A #GDBusMessage. Free with g_object_unref().
283 g_dbus_message_new_method_error (GDBusMessage *method_call_message,
284 const gchar *error_name,
285 const gchar *error_message_format,
291 va_start (var_args, error_message_format);
292 ret = g_dbus_message_new_method_error_valist (method_call_message,
294 error_message_format,
302 * g_dbus_message_new_method_error_literal:
303 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
304 * create a reply message to.
305 * @error_name: A valid D-Bus error name.
306 * @error_message: The D-Bus error message.
308 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
310 * Returns: A #GDBusMessage. Free with g_object_unref().
315 g_dbus_message_new_method_error_literal (GDBusMessage *method_call_message,
316 const gchar *error_name,
317 const gchar *error_message)
319 GDBusMessage *message;
322 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
323 g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
324 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
325 g_return_val_if_fail (g_dbus_is_name (error_name), NULL);
326 g_return_val_if_fail (error_message != NULL, NULL);
328 message = g_dbus_message_new ();
329 message->type = G_DBUS_MESSAGE_TYPE_ERROR;
330 message->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
332 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
333 g_dbus_message_set_error_name (message, error_name);
334 g_dbus_message_set_body (message, g_variant_new ("(s)", error_message));
336 sender = g_dbus_message_get_sender (method_call_message);
338 g_dbus_message_set_destination (message, sender);
344 * g_dbus_message_new_method_error_valist:
345 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
346 * create a reply message to.
347 * @error_name: A valid D-Bus error name.
348 * @error_message_format: The D-Bus error message in a printf() format.
349 * @var_args: Arguments for @error_message_format.
351 * Like g_dbus_message_new_method_error() but intended for language bindings.
353 * Returns: A #GDBusMessage. Free with g_object_unref().
358 g_dbus_message_new_method_error_valist (GDBusMessage *method_call_message,
359 const gchar *error_name,
360 const gchar *error_message_format,
364 gchar *error_message;
365 error_message = g_strdup_vprintf (error_message_format, var_args);
366 ret = g_dbus_message_new_method_error_literal (method_call_message,
369 g_free (error_message);
373 /* ---------------------------------------------------------------------------------------------------- */
375 /* TODO: need GI annotations to specify that any guchar value goes for the type */
378 * g_dbus_message_get_message_type:
379 * @message: A #GDBusMessage.
381 * Gets the type of @message.
383 * Returns: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
388 g_dbus_message_get_message_type (GDBusMessage *message)
390 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_TYPE_INVALID);
391 return message->type;
395 * g_dbus_message_set_message_type:
396 * @message: A #GDBusMessage.
397 * @type: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
399 * Sets @message to be of @type.
404 g_dbus_message_set_message_type (GDBusMessage *message,
405 GDBusMessageType type)
407 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
408 g_return_if_fail (type >=0 && type < 256);
409 message->type = type;
412 /* ---------------------------------------------------------------------------------------------------- */
414 /* TODO: need GI annotations to specify that any guchar value goes for flags */
417 * g_dbus_message_get_flags:
418 * @message: A #GDBusMessage.
420 * Gets the flags for @message.
422 * Returns: Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).
427 g_dbus_message_get_flags (GDBusMessage *message)
429 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_FLAGS_NONE);
430 return message->flags;
434 * g_dbus_message_set_flags:
435 * @message: A #GDBusMessage.
436 * @flags: Flags for @message that are set (typically values from the #GDBusMessageFlags
437 * enumeration bitwise ORed together).
439 * Sets the flags to set on @message.
444 g_dbus_message_set_flags (GDBusMessage *message,
445 GDBusMessageFlags flags)
447 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
448 g_return_if_fail (flags >=0 && flags < 256);
449 message->flags = flags;
452 /* ---------------------------------------------------------------------------------------------------- */
455 * g_dbus_message_get_serial:
456 * @message: A #GDBusMessage.
458 * Gets the serial for @message.
460 * Returns: A #guint32.
465 g_dbus_message_get_serial (GDBusMessage *message)
467 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
468 return message->serial;
472 * g_dbus_message_set_serial:
473 * @message: A #GDBusMessage.
474 * @serial: A #guint32.
476 * Sets the serial for @message.
481 g_dbus_message_set_serial (GDBusMessage *message,
484 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
485 message->serial = serial;
488 /* ---------------------------------------------------------------------------------------------------- */
490 /* TODO: need GI annotations to specify that any guchar value goes for header_field */
493 * g_dbus_message_get_header:
494 * @message: A #GDBusMessage.
495 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
497 * Gets a header field on @message.
499 * Returns: A #GVariant with the value if the header was found, %NULL
500 * otherwise. Do not free, it is owned by @message.
505 g_dbus_message_get_header (GDBusMessage *message,
506 GDBusMessageHeaderField header_field)
508 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
509 g_return_val_if_fail (header_field >=0 && header_field < 256, NULL);
510 return g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
514 * g_dbus_message_set_header:
515 * @message: A #GDBusMessage.
516 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
517 * @value: A #GVariant to set the header field or %NULL to clear the header field.
519 * Sets a header field on @message.
521 * If @value is floating, @message assumes ownership of @value.
526 g_dbus_message_set_header (GDBusMessage *message,
527 GDBusMessageHeaderField header_field,
530 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
531 g_return_if_fail (header_field >=0 && header_field < 256);
534 g_hash_table_remove (message->headers, GUINT_TO_POINTER (header_field));
538 g_hash_table_insert (message->headers, GUINT_TO_POINTER (header_field), g_variant_ref_sink (value));
543 * g_dbus_message_get_header_fields:
544 * @message: A #GDBusMessage.
546 * Gets an array of all header fields on @message that are set.
548 * Returns: An array of header fields terminated by
549 * %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a
550 * #guchar. Free with g_free().
555 g_dbus_message_get_header_fields (GDBusMessage *message)
563 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
565 keys = g_hash_table_get_keys (message->headers);
566 num_keys = g_list_length (keys);
567 ret = g_new (guchar, num_keys + 1);
568 for (l = keys, n = 0; l != NULL; l = l->next, n++)
569 ret[n] = GPOINTER_TO_UINT (l->data);
570 g_assert (n == num_keys);
571 ret[n] = G_DBUS_MESSAGE_HEADER_FIELD_INVALID;
577 /* ---------------------------------------------------------------------------------------------------- */
580 * g_dbus_message_get_body:
581 * @message: A #GDBusMessage.
583 * Gets the body of a message.
585 * Returns: A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message.
590 g_dbus_message_get_body (GDBusMessage *message)
592 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
593 return message->body;
597 * g_dbus_message_set_body:
598 * @message: A #GDBusMessage.
599 * @body: Either %NULL or a #GVariant that is a tuple.
601 * Sets the body @message. As a side-effect the
602 * %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the
603 * type string of @body (or cleared if @body is %NULL).
605 * If @body is floating, @message assumes ownership of @body.
610 g_dbus_message_set_body (GDBusMessage *message,
613 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
614 g_return_if_fail ((body == NULL) || g_variant_is_of_type (body, G_VARIANT_TYPE_TUPLE));
616 if (message->body != NULL)
617 g_variant_unref (message->body);
620 message->body = NULL;
621 g_dbus_message_set_signature (message, NULL);
625 const gchar *type_string;
626 gsize type_string_len;
629 message->body = g_variant_ref_sink (body);
631 type_string = g_variant_get_type_string (body);
632 type_string_len = strlen (type_string);
633 g_assert (type_string_len >= 2);
634 signature = g_strndup (type_string + 1, type_string_len - 2);
635 g_dbus_message_set_signature (message, signature);
640 /* ---------------------------------------------------------------------------------------------------- */
644 * g_dbus_message_get_unix_fd_list:
645 * @message: A #GDBusMessage.
647 * Gets the UNIX file descriptors associated with @message, if any.
649 * This method is only available on UNIX.
651 * Returns: A #GUnixFDList or %NULL if no file descriptors are
652 * associated. Do not free, this object is owned by @message.
657 g_dbus_message_get_unix_fd_list (GDBusMessage *message)
659 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
660 return message->fd_list;
664 * g_dbus_message_set_unix_fd_list:
665 * @message: A #GDBusMessage.
666 * @fd_list: A #GUnixFDList or %NULL.
668 * Sets the UNIX file descriptors associated with @message. As a
669 * side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header
670 * field is set to the number of fds in @fd_list (or cleared if
671 * @fd_list is %NULL).
673 * This method is only available on UNIX.
678 g_dbus_message_set_unix_fd_list (GDBusMessage *message,
679 GUnixFDList *fd_list)
681 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
682 g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
683 if (message->fd_list != NULL)
684 g_object_unref (message->fd_list);
687 message->fd_list = g_object_ref (fd_list);
688 g_dbus_message_set_num_unix_fds (message, g_unix_fd_list_get_length (fd_list));
692 message->fd_list = NULL;
693 g_dbus_message_set_num_unix_fds (message, 0);
698 /* ---------------------------------------------------------------------------------------------------- */
701 ensure_input_padding (GMemoryInputStream *mis,
708 offset = g_seekable_tell (G_SEEKABLE (mis));
709 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
711 if (offset != wanted_offset)
713 return g_seekable_seek (G_SEEKABLE (mis), wanted_offset, G_SEEK_SET, NULL, error);
722 read_string (GMemoryInputStream *mis,
723 GDataInputStream *dis,
733 s = g_string_new (NULL);
736 while (remaining > 0)
741 to_read = MIN (remaining, sizeof (buf));
742 num_read = g_input_stream_read (G_INPUT_STREAM (mis),
751 /* G_GSIZE_FORMAT doesn't work with gettext, so we use %lu */
754 G_IO_ERROR_INVALID_ARGUMENT,
755 _("Wanted to read %lu bytes but got EOF"),
760 remaining -= num_read;
761 g_string_append_len (s, buf, num_read);
765 nul = g_data_input_stream_read_byte (dis, NULL, &local_error);
766 if (local_error != NULL)
768 g_propagate_error (error, local_error);
775 G_IO_ERROR_INVALID_ARGUMENT,
776 _("Expected NUL byte after the string `%s' but found `%c' (%d)"),
781 return g_string_free (s, FALSE);
784 g_string_free (s, TRUE);
788 /* if just_align==TRUE, don't read a value, just align the input stream wrt padding */
790 /* returns a non-floating GVariant! */
792 parse_value_from_blob (GMemoryInputStream *mis,
793 GDataInputStream *dis,
794 const GVariantType *type,
803 #ifdef DEBUG_SERIALIZER
807 s = g_variant_type_dup_string (type);
808 g_print ("%*sReading type %s from offset 0x%04x",
811 (gint) g_seekable_tell (G_SEEKABLE (mis)));
814 #endif /* DEBUG_SERIALIZER */
820 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
822 if (!ensure_input_padding (mis, 4, &local_error))
827 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
828 if (local_error != NULL)
830 ret = g_variant_new_boolean (v);
833 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
838 v = g_data_input_stream_read_byte (dis, NULL, &local_error);
839 if (local_error != NULL)
841 ret = g_variant_new_byte (v);
844 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
846 if (!ensure_input_padding (mis, 2, &local_error))
851 v = g_data_input_stream_read_int16 (dis, NULL, &local_error);
852 if (local_error != NULL)
854 ret = g_variant_new_int16 (v);
857 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
859 if (!ensure_input_padding (mis, 2, &local_error))
864 v = g_data_input_stream_read_uint16 (dis, NULL, &local_error);
865 if (local_error != NULL)
867 ret = g_variant_new_uint16 (v);
870 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
872 if (!ensure_input_padding (mis, 4, &local_error))
877 v = g_data_input_stream_read_int32 (dis, NULL, &local_error);
878 if (local_error != NULL)
880 ret = g_variant_new_int32 (v);
883 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
885 if (!ensure_input_padding (mis, 4, &local_error))
890 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
891 if (local_error != NULL)
893 ret = g_variant_new_uint32 (v);
896 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
898 if (!ensure_input_padding (mis, 8, &local_error))
903 v = g_data_input_stream_read_int64 (dis, NULL, &local_error);
904 if (local_error != NULL)
906 ret = g_variant_new_int64 (v);
909 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
911 if (!ensure_input_padding (mis, 8, &local_error))
916 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
917 if (local_error != NULL)
919 ret = g_variant_new_uint64 (v);
922 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
924 if (!ensure_input_padding (mis, 8, &local_error))
930 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
931 if (local_error != NULL)
934 encoded = (gdouble *) &v;
935 ret = g_variant_new_double (*encoded);
938 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
940 if (!ensure_input_padding (mis, 4, &local_error))
946 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
947 if (local_error != NULL)
949 v = read_string (mis, dis, (gsize) len, &local_error);
952 ret = g_variant_new_string (v);
956 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
958 if (!ensure_input_padding (mis, 4, &local_error))
964 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
965 if (local_error != NULL)
967 v = read_string (mis, dis, (gsize) len, &local_error);
970 if (!g_variant_is_object_path (v))
972 g_set_error (&local_error,
974 G_IO_ERROR_INVALID_ARGUMENT,
975 _("Parsed value `%s' is not a valid D-Bus object path"),
980 ret = g_variant_new_object_path (v);
984 else if (g_variant_type_equal (type, G_VARIANT_TYPE_SIGNATURE))
990 len = g_data_input_stream_read_byte (dis, NULL, &local_error);
991 if (local_error != NULL)
993 v = read_string (mis, dis, (gsize) len, &local_error);
996 if (!g_variant_is_signature (v))
998 g_set_error (&local_error,
1000 G_IO_ERROR_INVALID_ARGUMENT,
1001 _("Parsed value `%s' is not a valid D-Bus signature"),
1006 ret = g_variant_new_signature (v);
1010 else if (g_variant_type_is_array (type))
1015 const GVariantType *element_type;
1016 GVariantBuilder builder;
1018 if (!ensure_input_padding (mis, 4, &local_error))
1027 array_len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1028 if (local_error != NULL)
1032 #ifdef DEBUG_SERIALIZER
1033 g_print (": array spans 0x%04x bytes\n", array_len);
1034 #endif /* DEBUG_SERIALIZER */
1036 if (array_len > (2<<26))
1038 /* G_GUINT32_FORMAT doesn't work with gettext, so use u */
1039 g_set_error (&local_error,
1041 G_IO_ERROR_INVALID_ARGUMENT,
1042 _("Encountered array of length %u bytes. Maximum length is 2<<26 bytes."),
1048 g_variant_builder_init (&builder, type);
1049 element_type = g_variant_type_element (type);
1054 item = parse_value_from_blob (mis,
1060 g_assert (item == NULL);
1064 /* TODO: optimize array of primitive types */
1065 offset = g_seekable_tell (G_SEEKABLE (mis));
1066 target = offset + array_len;
1067 while (offset < target)
1070 item = parse_value_from_blob (mis,
1078 g_variant_builder_clear (&builder);
1081 g_variant_builder_add_value (&builder, item);
1082 g_variant_unref (item);
1083 offset = g_seekable_tell (G_SEEKABLE (mis));
1089 ret = g_variant_builder_end (&builder);
1093 g_variant_builder_clear (&builder);
1096 else if (g_variant_type_is_dict_entry (type))
1098 const GVariantType *key_type;
1099 const GVariantType *value_type;
1103 if (!ensure_input_padding (mis, 8, &local_error))
1107 #ifdef DEBUG_SERIALIZER
1109 #endif /* DEBUG_SERIALIZER */
1113 key_type = g_variant_type_key (type);
1114 key = parse_value_from_blob (mis,
1122 value_type = g_variant_type_value (type);
1123 value = parse_value_from_blob (mis,
1131 g_variant_unref (key);
1134 ret = g_variant_new_dict_entry (key, value);
1135 g_variant_unref (key);
1136 g_variant_unref (value);
1139 else if (g_variant_type_is_tuple (type))
1141 if (!ensure_input_padding (mis, 8, &local_error))
1145 #ifdef DEBUG_SERIALIZER
1147 #endif /* DEBUG_SERIALIZER */
1151 const GVariantType *element_type;
1152 GVariantBuilder builder;
1154 g_variant_builder_init (&builder, type);
1155 element_type = g_variant_type_first (type);
1156 while (element_type != NULL)
1159 item = parse_value_from_blob (mis,
1167 g_variant_builder_clear (&builder);
1170 g_variant_builder_add_value (&builder, item);
1171 g_variant_unref (item);
1173 element_type = g_variant_type_next (element_type);
1175 ret = g_variant_builder_end (&builder);
1178 else if (g_variant_type_is_variant (type))
1181 #ifdef DEBUG_SERIALIZER
1183 #endif /* DEBUG_SERIALIZER */
1189 GVariantType *variant_type;
1192 siglen = g_data_input_stream_read_byte (dis, NULL, &local_error);
1193 if (local_error != NULL)
1195 sig = read_string (mis, dis, (gsize) siglen, &local_error);
1198 if (!g_variant_is_signature (sig))
1200 g_set_error (&local_error,
1202 G_IO_ERROR_INVALID_ARGUMENT,
1203 _("Parsed value `%s' for variant is not a valid D-Bus signature"),
1208 variant_type = g_variant_type_new (sig);
1210 value = parse_value_from_blob (mis,
1216 g_variant_type_free (variant_type);
1219 ret = g_variant_new_variant (value);
1220 g_variant_unref (value);
1226 s = g_variant_type_dup_string (type);
1227 g_set_error (&local_error,
1229 G_IO_ERROR_INVALID_ARGUMENT,
1230 _("Error deserializing GVariant with type-string `%s' from the D-Bus wire format"),
1236 g_assert ((just_align && ret == NULL) || (!just_align && ret != NULL));
1238 #ifdef DEBUG_SERIALIZER
1244 if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1246 s = g_strdup_printf ("0x%02x '%c'", g_variant_get_byte (ret), g_variant_get_byte (ret));
1250 s = g_variant_print (ret, FALSE);
1252 g_print (": %s\n", s);
1256 #endif /* DEBUG_SERIALIZER */
1258 /* sink the reference */
1261 g_assert (g_variant_is_floating (ret));
1262 g_variant_ref_sink (ret);
1267 #ifdef DEBUG_SERIALIZER
1269 "%*sFAILURE: %s (%s, %d)\n",
1271 local_error->message,
1272 g_quark_to_string (local_error->domain),
1274 #endif /* DEBUG_SERIALIZER */
1275 g_propagate_error (error, local_error);
1279 /* ---------------------------------------------------------------------------------------------------- */
1281 /* message_header must be at least 16 bytes */
1284 * g_dbus_message_bytes_needed:
1285 * @blob: A blob represent a binary D-Bus message.
1286 * @blob_len: The length of @blob (must be at least 16).
1287 * @error: Return location for error or %NULL.
1289 * Utility function to calculate how many bytes are needed to
1290 * completely deserialize the D-Bus message stored at @blob.
1292 * Returns: Number of bytes needed or -1 if @error is set (e.g. if
1293 * @blob contains invalid data or not enough data is available to
1294 * determine the size).
1299 g_dbus_message_bytes_needed (guchar *blob,
1307 g_return_val_if_fail (blob != NULL, -1);
1308 g_return_val_if_fail (error == NULL || *error == NULL, -1);
1309 g_return_val_if_fail (blob_len >= 16, -1);
1313 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1314 ret = 12 + 4 + GUINT32_FROM_LE (((guint32 *) blob)[3]);
1315 /* round up so it's a multiple of 8 */
1316 ret = 8 * ((ret + 7)/8);
1317 /* finally add the body size */
1318 ret += GUINT32_FROM_LE (((guint32 *) blob)[1]);
1320 else if (blob[0] == 'B')
1322 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1323 ret = 12 + 4 + GUINT32_FROM_BE (((guint32 *) blob)[3]);
1324 /* round up so it's a multiple of 8 */
1325 ret = 8 * ((ret + 7)/8);
1326 /* finally add the body size */
1327 ret += GUINT32_FROM_BE (((guint32 *) blob)[1]);
1333 G_IO_ERROR_INVALID_ARGUMENT,
1334 "Unable to determine message blob length - given blob is malformed");
1341 G_IO_ERROR_INVALID_ARGUMENT,
1342 "Blob indicates that message exceeds maximum message length (128MiB)");
1349 /* ---------------------------------------------------------------------------------------------------- */
1352 * g_dbus_message_new_from_blob:
1353 * @blob: A blob represent a binary D-Bus message.
1354 * @blob_len: The length of @blob.
1355 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
1356 * @error: Return location for error or %NULL.
1358 * Creates a new #GDBusMessage from the data stored at @blob.
1360 * Returns: A new #GDBusMessage or %NULL if @error is set. Free with
1366 g_dbus_message_new_from_blob (guchar *blob,
1368 GDBusCapabilityFlags capabilities,
1372 GMemoryInputStream *mis;
1373 GDataInputStream *dis;
1374 GDBusMessage *message;
1376 guchar major_protocol_version;
1377 GDataStreamByteOrder byte_order;
1378 guint32 message_body_len;
1382 GVariant *signature;
1384 /* TODO: check against @capabilities */
1388 g_return_val_if_fail (blob != NULL, NULL);
1389 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1390 g_return_val_if_fail (blob_len >= 12, NULL);
1392 message = g_dbus_message_new ();
1394 mis = G_MEMORY_INPUT_STREAM (g_memory_input_stream_new_from_data (blob, blob_len, NULL));
1395 dis = g_data_input_stream_new (G_INPUT_STREAM (mis));
1397 endianness = g_data_input_stream_read_byte (dis, NULL, NULL);
1401 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1404 byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
1409 G_IO_ERROR_INVALID_ARGUMENT,
1410 _("Invalid endianness value. Expected 'l' or 'B' but found '%c' (%d)"),
1411 endianness, endianness);
1414 g_data_input_stream_set_byte_order (dis, byte_order);
1416 message->type = g_data_input_stream_read_byte (dis, NULL, NULL);
1417 message->flags = g_data_input_stream_read_byte (dis, NULL, NULL);
1418 major_protocol_version = g_data_input_stream_read_byte (dis, NULL, NULL);
1419 if (major_protocol_version != 1)
1423 G_IO_ERROR_INVALID_ARGUMENT,
1424 _("Invalid major protocol version. Expected 1 but found %d"),
1425 major_protocol_version);
1428 message_body_len = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1429 message->serial = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1431 #ifdef DEBUG_SERIALIZER
1432 g_print ("Parsing blob (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1435 s = _g_dbus_hexdump ((const gchar *) blob, blob_len, 2);
1436 g_print ("%s\n", s);
1439 #endif /* DEBUG_SERIALIZER */
1441 #ifdef DEBUG_SERIALIZER
1442 g_print ("Parsing headers (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1443 #endif /* DEBUG_SERIALIZER */
1444 headers = parse_value_from_blob (mis,
1446 G_VARIANT_TYPE ("a{yv}"),
1450 if (headers == NULL)
1452 g_variant_iter_init (&iter, headers);
1453 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1455 guchar header_field;
1457 g_variant_get (item,
1461 g_dbus_message_set_header (message, header_field, value);
1462 g_variant_unref (value);
1463 g_variant_unref (item);
1465 g_variant_unref (headers);
1467 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
1468 if (signature != NULL)
1470 const gchar *signature_str;
1471 gsize signature_str_len;
1473 signature_str = g_variant_get_string (signature, &signature_str_len);
1475 /* signature but no body */
1476 if (message_body_len == 0 && signature_str_len > 0)
1480 G_IO_ERROR_INVALID_ARGUMENT,
1481 _("Signature header with signature `%s' found but message body is empty"),
1485 else if (signature_str_len > 0)
1487 GVariantType *variant_type;
1488 gchar *tupled_signature_str;
1490 if (!g_variant_is_signature (signature_str))
1494 G_IO_ERROR_INVALID_ARGUMENT,
1495 _("Parsed value `%s' is not a valid D-Bus signature (for body)"),
1499 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
1500 variant_type = g_variant_type_new (tupled_signature_str);
1501 g_free (tupled_signature_str);
1502 #ifdef DEBUG_SERIALIZER
1503 g_print ("Parsing body (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1504 #endif /* DEBUG_SERIALIZER */
1505 message->body = parse_value_from_blob (mis,
1511 g_variant_type_free (variant_type);
1512 if (message->body == NULL)
1518 /* no signature, this is only OK if the body is empty */
1519 if (message_body_len != 0)
1521 /* G_GUINT32_FORMAT doesn't work with gettext, just use %u */
1524 G_IO_ERROR_INVALID_ARGUMENT,
1525 _("No signature header in message but the message body is %u bytes"),
1535 g_object_unref (dis);
1536 g_object_unref (mis);
1544 if (message != NULL)
1545 g_object_unref (message);
1550 /* ---------------------------------------------------------------------------------------------------- */
1553 ensure_output_padding (GMemoryOutputStream *mos,
1554 GDataOutputStream *dos,
1558 gsize wanted_offset;
1559 gsize padding_needed;
1562 offset = g_memory_output_stream_get_data_size (mos);
1563 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
1564 padding_needed = wanted_offset - offset;
1566 for (n = 0; n < padding_needed; n++)
1567 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1569 return padding_needed;
1572 /* note that value can be NULL for e.g. empty arrays - type is never NULL */
1574 append_value_to_blob (GVariant *value,
1575 const GVariantType *type,
1576 GMemoryOutputStream *mos,
1577 GDataOutputStream *dos,
1578 gsize *out_padding_added,
1581 gsize padding_added;
1585 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
1587 padding_added = ensure_output_padding (mos, dos, 4);
1590 gboolean v = g_variant_get_boolean (value);
1591 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1594 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1598 guint8 v = g_variant_get_byte (value);
1599 g_data_output_stream_put_byte (dos, v, NULL, NULL);
1602 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
1604 padding_added = ensure_output_padding (mos, dos, 2);
1607 gint16 v = g_variant_get_int16 (value);
1608 g_data_output_stream_put_int16 (dos, v, NULL, NULL);
1611 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
1613 padding_added = ensure_output_padding (mos, dos, 2);
1616 guint16 v = g_variant_get_uint16 (value);
1617 g_data_output_stream_put_uint16 (dos, v, NULL, NULL);
1620 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
1622 padding_added = ensure_output_padding (mos, dos, 4);
1625 gint32 v = g_variant_get_int32 (value);
1626 g_data_output_stream_put_int32 (dos, v, NULL, NULL);
1629 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
1631 padding_added = ensure_output_padding (mos, dos, 4);
1634 guint32 v = g_variant_get_uint32 (value);
1635 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1638 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
1640 padding_added = ensure_output_padding (mos, dos, 8);
1643 gint64 v = g_variant_get_int64 (value);
1644 g_data_output_stream_put_int64 (dos, v, NULL, NULL);
1647 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
1649 padding_added = ensure_output_padding (mos, dos, 8);
1652 guint64 v = g_variant_get_uint64 (value);
1653 g_data_output_stream_put_uint64 (dos, v, NULL, NULL);
1656 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
1658 padding_added = ensure_output_padding (mos, dos, 8);
1662 gdouble v = g_variant_get_double (value);
1664 encoded = (guint64 *) &v;
1665 g_data_output_stream_put_uint64 (dos, *encoded, NULL, NULL);
1668 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
1670 padding_added = ensure_output_padding (mos, dos, 4);
1674 const gchar *v = g_variant_get_string (value, &len);
1675 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1676 g_data_output_stream_put_string (dos, v, NULL, NULL);
1677 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1680 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
1682 padding_added = ensure_output_padding (mos, dos, 4);
1685 /* TODO: validate object path */
1687 const gchar *v = g_variant_get_string (value, &len);
1688 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1689 g_data_output_stream_put_string (dos, v, NULL, NULL);
1690 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1693 else if (g_variant_type_equal (type, G_VARIANT_TYPE_SIGNATURE))
1697 /* TODO: validate signature (including max len being 255) */
1699 const gchar *v = g_variant_get_string (value, &len);
1700 g_data_output_stream_put_byte (dos, len, NULL, NULL);
1701 g_data_output_stream_put_string (dos, v, NULL, NULL);
1702 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1705 else if (g_variant_type_is_array (type))
1709 goffset array_len_offset;
1710 goffset array_payload_begin_offset;
1714 padding_added = ensure_output_padding (mos, dos, 4);
1717 /* array length - will be filled in later */
1718 array_len_offset = g_memory_output_stream_get_data_size (mos);
1719 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
1721 /* From the D-Bus spec:
1723 * "A UINT32 giving the length of the array data in bytes,
1724 * followed by alignment padding to the alignment boundary of
1725 * the array element type, followed by each array element. The
1726 * array length is from the end of the alignment padding to
1727 * the end of the last element, i.e. it does not include the
1728 * padding after the length, or any padding after the last
1731 * Thus, we need to count how much padding the first element
1732 * contributes and subtract that from the array length.
1734 array_payload_begin_offset = g_memory_output_stream_get_data_size (mos);
1736 if (g_variant_n_children (value) == 0)
1738 gsize padding_added_for_item;
1739 if (!append_value_to_blob (NULL,
1740 g_variant_type_element (type),
1743 &padding_added_for_item,
1746 array_payload_begin_offset += padding_added_for_item;
1752 g_variant_iter_init (&iter, value);
1753 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1755 gsize padding_added_for_item;
1756 if (!append_value_to_blob (item,
1757 g_variant_get_type (item),
1760 &padding_added_for_item,
1763 g_variant_unref (item);
1766 g_variant_unref (item);
1769 array_payload_begin_offset += padding_added_for_item;
1775 cur_offset = g_memory_output_stream_get_data_size (mos);
1777 array_len = cur_offset - array_payload_begin_offset;
1779 if (!g_seekable_seek (G_SEEKABLE (mos), array_len_offset, G_SEEK_SET, NULL, error))
1782 g_data_output_stream_put_uint32 (dos, array_len, NULL, NULL);
1784 if (!g_seekable_seek (G_SEEKABLE (mos), cur_offset, G_SEEK_SET, NULL, error))
1788 else if (g_variant_type_is_dict_entry (type) || g_variant_type_is_tuple (type))
1790 padding_added = ensure_output_padding (mos, dos, 8);
1795 g_variant_iter_init (&iter, value);
1796 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1798 if (!append_value_to_blob (item,
1799 g_variant_get_type (item),
1805 g_variant_unref (item);
1808 g_variant_unref (item);
1812 else if (g_variant_type_is_variant (type))
1817 const gchar *signature;
1818 child = g_variant_get_child_value (value, 0);
1819 signature = g_variant_get_type_string (child);
1820 /* TODO: validate signature (including max len being 255) */
1821 g_data_output_stream_put_byte (dos, strlen (signature), NULL, NULL);
1822 g_data_output_stream_put_string (dos, signature, NULL, NULL);
1823 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1824 if (!append_value_to_blob (child,
1825 g_variant_get_type (child),
1831 g_variant_unref (child);
1834 g_variant_unref (child);
1841 G_IO_ERROR_INVALID_ARGUMENT,
1842 _("Error serializing GVariant with type-string `%s' to the D-Bus wire format"),
1843 g_variant_get_type_string (value));
1847 if (out_padding_added != NULL)
1848 *out_padding_added = padding_added;
1857 append_body_to_blob (GVariant *value,
1858 GMemoryOutputStream *mos,
1859 GDataOutputStream *dos,
1868 if (!g_variant_is_of_type (value, G_VARIANT_TYPE_TUPLE))
1872 G_IO_ERROR_INVALID_ARGUMENT,
1873 "Expected a tuple for the body of the GDBusMessage.");
1877 g_variant_iter_init (&iter, value);
1878 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1880 if (!append_value_to_blob (item,
1881 g_variant_get_type (item),
1887 g_variant_unref (item);
1890 g_variant_unref (item);
1898 /* ---------------------------------------------------------------------------------------------------- */
1901 * g_dbus_message_to_blob:
1902 * @message: A #GDBusMessage.
1903 * @out_size: Return location for size of generated blob.
1904 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
1905 * @error: Return location for error.
1907 * Serializes @message to a blob.
1909 * Returns: A pointer to a valid binary D-Bus message of @out_size bytes
1910 * generated by @message or %NULL if @error is set. Free with g_free().
1915 g_dbus_message_to_blob (GDBusMessage *message,
1917 GDBusCapabilityFlags capabilities,
1920 GMemoryOutputStream *mos;
1921 GDataOutputStream *dos;
1924 GDataStreamByteOrder byte_order;
1925 goffset body_len_offset;
1926 goffset body_start_offset;
1928 GVariant *header_fields;
1929 GVariantBuilder builder;
1930 GHashTableIter hash_iter;
1932 GVariant *header_value;
1933 GVariant *signature;
1934 const gchar *signature_str;
1935 gint num_fds_in_message;
1936 gint num_fds_according_to_header;
1938 /* TODO: check against @capabilities */
1942 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1943 g_return_val_if_fail (out_size != NULL, NULL);
1944 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1946 mos = G_MEMORY_OUTPUT_STREAM (g_memory_output_stream_new (NULL, 0, g_realloc, g_free));
1947 dos = g_data_output_stream_new (G_OUTPUT_STREAM (mos));
1949 /* TODO: detect endianess... */
1950 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1951 g_data_output_stream_set_byte_order (dos, byte_order);
1954 g_data_output_stream_put_byte (dos, byte_order == G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN ? 'l' : 'B', NULL, NULL);
1955 g_data_output_stream_put_byte (dos, message->type, NULL, NULL);
1956 g_data_output_stream_put_byte (dos, message->flags, NULL, NULL);
1957 g_data_output_stream_put_byte (dos, 1, NULL, NULL); /* major protocol version */
1958 body_len_offset = g_memory_output_stream_get_data_size (mos);
1959 /* body length - will be filled in later */
1960 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
1961 g_data_output_stream_put_uint32 (dos, message->serial, NULL, NULL);
1963 num_fds_in_message = 0;
1965 if (message->fd_list != NULL)
1966 num_fds_in_message = g_unix_fd_list_get_length (message->fd_list);
1968 num_fds_according_to_header = g_dbus_message_get_num_unix_fds (message);
1969 /* TODO: check we have all the right header fields and that they are the correct value etc etc */
1970 if (num_fds_in_message != num_fds_according_to_header)
1974 G_IO_ERROR_INVALID_ARGUMENT,
1975 _("Message has %d fds but the header field indicates %d fds"),
1977 num_fds_according_to_header);
1981 g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{yv}"));
1982 g_hash_table_iter_init (&hash_iter, message->headers);
1983 while (g_hash_table_iter_next (&hash_iter, &key, (gpointer) &header_value))
1985 g_variant_builder_add (&builder,
1987 (guchar) GPOINTER_TO_UINT (key),
1990 header_fields = g_variant_builder_end (&builder);
1992 if (!append_value_to_blob (header_fields,
1993 g_variant_get_type (header_fields),
1998 g_variant_unref (header_fields);
2001 g_variant_unref (header_fields);
2003 /* header size must be a multiple of 8 */
2004 ensure_output_padding (mos, dos, 8);
2006 body_start_offset = g_memory_output_stream_get_data_size (mos);
2008 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2009 signature_str = NULL;
2010 if (signature != NULL)
2011 signature_str = g_variant_get_string (signature, NULL);
2012 if (message->body != NULL)
2014 gchar *tupled_signature_str;
2015 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
2016 if (signature == NULL)
2020 G_IO_ERROR_INVALID_ARGUMENT,
2021 _("Message body has signature `%s' but there is no signature header"),
2023 g_free (tupled_signature_str);
2026 else if (g_strcmp0 (tupled_signature_str, g_variant_get_type_string (message->body)) != 0)
2030 G_IO_ERROR_INVALID_ARGUMENT,
2031 _("Message body has type signature `%s' but signature in the header field is `%s'"),
2032 tupled_signature_str, g_variant_get_type_string (message->body));
2033 g_free (tupled_signature_str);
2036 g_free (tupled_signature_str);
2037 if (!append_body_to_blob (message->body, mos, dos, error))
2042 if (signature != NULL)
2046 G_IO_ERROR_INVALID_ARGUMENT,
2047 _("Message body is empty but signature in the header field is `(%s)'"),
2053 /* OK, we're done writing the message - set the body length */
2054 size = g_memory_output_stream_get_data_size (mos);
2055 body_size = size - body_start_offset;
2057 if (!g_seekable_seek (G_SEEKABLE (mos), body_len_offset, G_SEEK_SET, NULL, error))
2060 g_data_output_stream_put_uint32 (dos, body_size, NULL, NULL);
2063 ret = g_memdup (g_memory_output_stream_get_data (mos), size);
2066 g_object_unref (dos);
2067 g_object_unref (mos);
2072 /* ---------------------------------------------------------------------------------------------------- */
2075 get_uint32_header (GDBusMessage *message,
2076 GDBusMessageHeaderField header_field)
2082 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2083 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_UINT32))
2084 ret = g_variant_get_uint32 (value);
2089 static const gchar *
2090 get_string_header (GDBusMessage *message,
2091 GDBusMessageHeaderField header_field)
2097 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2098 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
2099 ret = g_variant_get_string (value, NULL);
2104 static const gchar *
2105 get_object_path_header (GDBusMessage *message,
2106 GDBusMessageHeaderField header_field)
2112 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2113 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_OBJECT_PATH))
2114 ret = g_variant_get_string (value, NULL);
2119 static const gchar *
2120 get_signature_header (GDBusMessage *message,
2121 GDBusMessageHeaderField header_field)
2127 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2128 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_SIGNATURE))
2129 ret = g_variant_get_string (value, NULL);
2134 /* ---------------------------------------------------------------------------------------------------- */
2137 set_uint32_header (GDBusMessage *message,
2138 GDBusMessageHeaderField header_field,
2141 g_dbus_message_set_header (message,
2143 g_variant_new_uint32 (value));
2147 set_string_header (GDBusMessage *message,
2148 GDBusMessageHeaderField header_field,
2151 g_dbus_message_set_header (message,
2153 value == NULL ? NULL : g_variant_new_string (value));
2157 set_object_path_header (GDBusMessage *message,
2158 GDBusMessageHeaderField header_field,
2161 g_dbus_message_set_header (message,
2163 value == NULL ? NULL : g_variant_new_object_path (value));
2167 set_signature_header (GDBusMessage *message,
2168 GDBusMessageHeaderField header_field,
2171 g_dbus_message_set_header (message,
2173 value == NULL ? NULL : g_variant_new_signature (value));
2176 /* ---------------------------------------------------------------------------------------------------- */
2179 * g_dbus_message_get_reply_serial:
2180 * @message: A #GDBusMessage.
2182 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2184 * Returns: The value.
2189 g_dbus_message_get_reply_serial (GDBusMessage *message)
2191 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2192 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL);
2196 * g_dbus_message_set_reply_serial:
2197 * @message: A #GDBusMessage.
2198 * @value: The value to set.
2200 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2205 g_dbus_message_set_reply_serial (GDBusMessage *message,
2208 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2209 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL, value);
2212 /* ---------------------------------------------------------------------------------------------------- */
2215 * g_dbus_message_get_interface:
2216 * @message: A #GDBusMessage.
2218 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2220 * Returns: The value.
2225 g_dbus_message_get_interface (GDBusMessage *message)
2227 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2228 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE);
2232 * g_dbus_message_set_interface:
2233 * @message: A #GDBusMessage.
2234 * @value: The value to set.
2236 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2241 g_dbus_message_set_interface (GDBusMessage *message,
2244 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2245 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2246 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE, value);
2249 /* ---------------------------------------------------------------------------------------------------- */
2252 * g_dbus_message_get_member:
2253 * @message: A #GDBusMessage.
2255 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2257 * Returns: The value.
2262 g_dbus_message_get_member (GDBusMessage *message)
2264 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2265 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER);
2269 * g_dbus_message_set_member:
2270 * @message: A #GDBusMessage.
2271 * @value: The value to set.
2273 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2278 g_dbus_message_set_member (GDBusMessage *message,
2281 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2282 g_return_if_fail (value == NULL || g_dbus_is_member_name (value));
2283 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER, value);
2286 /* ---------------------------------------------------------------------------------------------------- */
2289 * g_dbus_message_get_path:
2290 * @message: A #GDBusMessage.
2292 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2294 * Returns: The value.
2299 g_dbus_message_get_path (GDBusMessage *message)
2301 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2302 return get_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH);
2306 * g_dbus_message_set_path:
2307 * @message: A #GDBusMessage.
2308 * @value: The value to set.
2310 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2315 g_dbus_message_set_path (GDBusMessage *message,
2318 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2319 g_return_if_fail (value == NULL || g_variant_is_object_path (value));
2320 set_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH, value);
2323 /* ---------------------------------------------------------------------------------------------------- */
2326 * g_dbus_message_get_sender:
2327 * @message: A #GDBusMessage.
2329 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2331 * Returns: The value.
2336 g_dbus_message_get_sender (GDBusMessage *message)
2338 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2339 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER);
2343 * g_dbus_message_set_sender:
2344 * @message: A #GDBusMessage.
2345 * @value: The value to set.
2347 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2352 g_dbus_message_set_sender (GDBusMessage *message,
2355 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2356 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2357 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER, value);
2360 /* ---------------------------------------------------------------------------------------------------- */
2363 * g_dbus_message_get_destination:
2364 * @message: A #GDBusMessage.
2366 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2368 * Returns: The value.
2373 g_dbus_message_get_destination (GDBusMessage *message)
2375 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2376 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION);
2380 * g_dbus_message_set_destination:
2381 * @message: A #GDBusMessage.
2382 * @value: The value to set.
2384 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2389 g_dbus_message_set_destination (GDBusMessage *message,
2392 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2393 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2394 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION, value);
2397 /* ---------------------------------------------------------------------------------------------------- */
2400 * g_dbus_message_get_error_name:
2401 * @message: A #GDBusMessage.
2403 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2405 * Returns: The value.
2410 g_dbus_message_get_error_name (GDBusMessage *message)
2412 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2413 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME);
2417 * g_dbus_message_set_error_name:
2418 * @message: A #GDBusMessage.
2419 * @value: The value to set.
2421 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2426 g_dbus_message_set_error_name (GDBusMessage *message,
2429 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2430 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2431 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME, value);
2434 /* ---------------------------------------------------------------------------------------------------- */
2437 * g_dbus_message_get_signature:
2438 * @message: A #GDBusMessage.
2440 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2442 * Returns: The value.
2447 g_dbus_message_get_signature (GDBusMessage *message)
2450 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2451 ret = get_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2458 * g_dbus_message_set_signature:
2459 * @message: A #GDBusMessage.
2460 * @value: The value to set.
2462 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2467 g_dbus_message_set_signature (GDBusMessage *message,
2470 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2471 g_return_if_fail (value == NULL || g_variant_is_signature (value));
2472 set_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE, value);
2475 /* ---------------------------------------------------------------------------------------------------- */
2478 * g_dbus_message_get_arg0:
2479 * @message: A #GDBusMessage.
2481 * Convenience to get the first item in the body of @message.
2483 * Returns: The string item or %NULL if the first item in the body of
2484 * @message is not a string.
2489 g_dbus_message_get_arg0 (GDBusMessage *message)
2493 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2497 if (message->body != NULL && g_variant_is_of_type (message->body, G_VARIANT_TYPE_TUPLE))
2500 item = g_variant_get_child_value (message->body, 0);
2501 if (g_variant_is_of_type (item, G_VARIANT_TYPE_STRING))
2502 ret = g_variant_get_string (item, NULL);
2503 g_variant_unref (item);
2509 /* ---------------------------------------------------------------------------------------------------- */
2512 * g_dbus_message_get_num_unix_fds:
2513 * @message: A #GDBusMessage.
2515 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2517 * Returns: The value.
2522 g_dbus_message_get_num_unix_fds (GDBusMessage *message)
2524 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2525 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS);
2529 * g_dbus_message_set_num_unix_fds:
2530 * @message: A #GDBusMessage.
2531 * @value: The value to set.
2533 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2538 g_dbus_message_set_num_unix_fds (GDBusMessage *message,
2541 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2542 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS, value);
2545 /* ---------------------------------------------------------------------------------------------------- */
2548 * g_dbus_message_to_gerror:
2549 * @message: A #GDBusMessage.
2550 * @error: The #GError to set.
2552 * If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does
2553 * nothing and returns %FALSE.
2555 * Otherwise this method encodes the error in @message as a #GError
2556 * using g_dbus_error_set_dbus_error() using the information in the
2557 * %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of @message as
2558 * well as the first string item in @message's body.
2560 * Returns: %TRUE if @error was set, %FALSE otherwise.
2565 g_dbus_message_to_gerror (GDBusMessage *message,
2569 const gchar *error_name;
2571 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2574 if (message->type != G_DBUS_MESSAGE_TYPE_ERROR)
2577 error_name = g_dbus_message_get_error_name (message);
2578 if (error_name != NULL)
2582 body = g_dbus_message_get_body (message);
2584 if (body != NULL && g_variant_is_of_type (body, G_VARIANT_TYPE ("(s)")))
2586 const gchar *error_message;
2587 g_variant_get (body, "(&s)", &error_message);
2588 g_dbus_error_set_dbus_error (error,
2595 /* these two situations are valid, yet pretty rare */
2598 g_dbus_error_set_dbus_error (error,
2601 _("Error return with body of type `%s'"),
2602 g_variant_get_type_string (body));
2606 g_dbus_error_set_dbus_error (error,
2609 _("Error return with empty body"));
2615 /* TOOD: this shouldn't happen - should check this at message serialization
2616 * time and disconnect the peer.
2621 "Error return without error-name header!");
2630 /* ---------------------------------------------------------------------------------------------------- */
2633 flags_to_string (GType flags_type, guint value)
2639 klass = g_type_class_ref (flags_type);
2640 s = g_string_new (NULL);
2641 for (n = 0; n < 32; n++)
2643 if ((value & (1<<n)) != 0)
2645 GFlagsValue *flags_value;
2646 flags_value = g_flags_get_first_value (klass, (1<<n));
2648 g_string_append_c (s, ',');
2649 if (flags_value != NULL)
2650 g_string_append (s, flags_value->value_nick);
2652 g_string_append_printf (s, "unknown (bit %d)", n);
2656 g_string_append (s, "none");
2657 g_type_class_unref (klass);
2658 return g_string_free (s, FALSE);
2662 _sort_keys_func (gconstpointer a,
2668 ia = GPOINTER_TO_INT (a);
2669 ib = GPOINTER_TO_INT (b);
2675 * g_dbus_message_print:
2676 * @message: A #GDBusMessage.
2677 * @indent: Indentation level.
2679 * Produces a human-readable multi-line description of @message.
2681 * The contents of the description has no ABI guarantees, the contents
2682 * and formatting is subject to change at any time. Typical output
2683 * looks something like this:
2690 * path -> objectpath '/org/gtk/GDBus/TestObject'
2691 * interface -> 'org.gtk.GDBus.TestInterface'
2692 * member -> 'GimmeStdout'
2693 * destination -> ':1.146'
2695 * UNIX File Descriptors:
2700 * Type: method-return
2701 * Flags: no-reply-expected
2705 * reply-serial -> uint32 4
2706 * destination -> ':1.159'
2707 * sender -> ':1.146'
2708 * num-unix-fds -> uint32 1
2710 * UNIX File Descriptors:
2711 * fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635
2714 * Returns: A string that should be freed with g_free().
2719 g_dbus_message_print (GDBusMessage *message,
2727 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2729 str = g_string_new (NULL);
2731 s = _g_dbus_enum_to_string (G_TYPE_DBUS_MESSAGE_TYPE, message->type);
2732 g_string_append_printf (str, "%*sType: %s\n", indent, "", s);
2734 s = flags_to_string (G_TYPE_DBUS_MESSAGE_FLAGS, message->flags);
2735 g_string_append_printf (str, "%*sFlags: %s\n", indent, "", s);
2737 g_string_append_printf (str, "%*sVersion: %d\n", indent, "", message->major_protocol_version);
2738 g_string_append_printf (str, "%*sSerial: %d\n", indent, "", message->serial);
2740 g_string_append_printf (str, "%*sHeaders:\n", indent, "");
2741 keys = g_hash_table_get_keys (message->headers);
2742 keys = g_list_sort (keys, _sort_keys_func);
2745 for (l = keys; l != NULL; l = l->next)
2747 gint key = GPOINTER_TO_INT (l->data);
2751 value = g_hash_table_lookup (message->headers, l->data);
2752 g_assert (value != NULL);
2754 s = _g_dbus_enum_to_string (G_TYPE_DBUS_MESSAGE_HEADER_FIELD, key);
2755 value_str = g_variant_print (value, TRUE);
2756 g_string_append_printf (str, "%*s %s -> %s\n", indent, "", s, value_str);
2763 g_string_append_printf (str, "%*s (none)\n", indent, "");
2765 g_string_append_printf (str, "%*sBody: ", indent, "");
2766 if (message->body != NULL)
2768 g_variant_print_string (message->body,
2774 g_string_append (str, "()");
2776 g_string_append (str, "\n");
2778 g_string_append_printf (str, "%*sUNIX File Descriptors:\n", indent, "");
2779 if (message->fd_list != NULL)
2785 fds = g_unix_fd_list_peek_fds (message->fd_list, &num_fds);
2788 for (n = 0; n < num_fds; n++)
2791 struct stat statbuf;
2792 fs = g_string_new (NULL);
2793 if (fstat (fds[n], &statbuf) == 0)
2795 g_string_append_printf (fs, "%s" "dev=%d:%d", fs->len > 0 ? "," : "",
2796 major (statbuf.st_dev), minor (statbuf.st_dev));
2797 g_string_append_printf (fs, "%s" "mode=0%o", fs->len > 0 ? "," : "",
2799 g_string_append_printf (fs, "%s" "ino=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2800 (guint64) statbuf.st_ino);
2801 g_string_append_printf (fs, "%s" "uid=%d", fs->len > 0 ? "," : "",
2803 g_string_append_printf (fs, "%s" "gid=%d", fs->len > 0 ? "," : "",
2805 g_string_append_printf (fs, "%s" "rdev=%d:%d", fs->len > 0 ? "," : "",
2806 major (statbuf.st_rdev), minor (statbuf.st_rdev));
2807 g_string_append_printf (fs, "%s" "size=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2808 (guint64) statbuf.st_size);
2809 g_string_append_printf (fs, "%s" "atime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2810 (guint64) statbuf.st_atime);
2811 g_string_append_printf (fs, "%s" "mtime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2812 (guint64) statbuf.st_mtime);
2813 g_string_append_printf (fs, "%s" "ctime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2814 (guint64) statbuf.st_ctime);
2818 g_string_append_printf (fs, "(fstat failed: %s)", strerror (errno));
2820 g_string_append_printf (str, "%*s fd %d: %s\n", indent, "", fds[n], fs->str);
2821 g_string_free (fs, TRUE);
2826 g_string_append_printf (str, "%*s (empty)\n", indent, "");
2831 g_string_append_printf (str, "%*s (none)\n", indent, "");
2835 return g_string_free (str, FALSE);
2839 #define __G_DBUS_MESSAGE_C__
2840 #include "gioaliasdef.c"