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"
57 * SECTION:gdbusmessage
58 * @short_description: D-Bus Message
61 * A type for representing D-Bus messages that can be sent or received
62 * on a #GDBusConnection.
65 typedef struct _GDBusMessageClass GDBusMessageClass;
70 * Class structure for #GDBusMessage.
74 struct _GDBusMessageClass
77 GObjectClass parent_class;
83 * The #GDBusMessage structure contains only private data and should
84 * only be accessed using the provided API.
91 GObject parent_instance;
93 GDBusMessageType type;
94 GDBusMessageFlags flags;
95 guchar major_protocol_version;
100 GUnixFDList *fd_list;
104 G_DEFINE_TYPE (GDBusMessage, g_dbus_message, G_TYPE_OBJECT);
107 g_dbus_message_finalize (GObject *object)
109 GDBusMessage *message = G_DBUS_MESSAGE (object);
111 if (message->headers != NULL)
112 g_hash_table_unref (message->headers);
113 if (message->body != NULL)
114 g_variant_unref (message->body);
116 if (message->fd_list != NULL)
117 g_object_unref (message->fd_list);
120 if (G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize != NULL)
121 G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize (object);
125 g_dbus_message_class_init (GDBusMessageClass *klass)
127 GObjectClass *gobject_class;
129 gobject_class = G_OBJECT_CLASS (klass);
131 gobject_class->finalize = g_dbus_message_finalize;
135 g_dbus_message_init (GDBusMessage *message)
137 message->headers = g_hash_table_new_full (g_direct_hash,
140 (GDestroyNotify) g_variant_unref);
144 * g_dbus_message_new:
146 * Creates a new empty #GDBusMessage.
148 * Returns: A #GDBusMessage. Free with g_object_unref().
153 g_dbus_message_new (void)
155 return g_object_new (G_TYPE_DBUS_MESSAGE, NULL);
159 * g_dbus_message_new_method_call:
160 * @name: A valid D-Bus name or %NULL.
161 * @path: A valid object path.
162 * @interface_: A valid D-Bus interface name or %NULL.
163 * @method: A valid method name.
165 * Creates a new #GDBusMessage for a method call.
167 * Returns: A #GDBusMessage. Free with g_object_unref().
172 g_dbus_message_new_method_call (const gchar *name,
174 const gchar *interface_,
177 GDBusMessage *message;
179 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
180 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
181 g_return_val_if_fail (g_dbus_is_member_name (method), NULL);
182 g_return_val_if_fail (interface_ == NULL || g_dbus_is_interface_name (interface_), NULL);
184 message = g_dbus_message_new ();
185 message->type = G_DBUS_MESSAGE_TYPE_METHOD_CALL;
188 g_dbus_message_set_destination (message, name);
189 g_dbus_message_set_path (message, path);
190 g_dbus_message_set_member (message, method);
191 if (interface_ != NULL)
192 g_dbus_message_set_interface (message, interface_);
198 * g_dbus_message_new_signal:
199 * @path: A valid object path.
200 * @interface_: A valid D-Bus interface name or %NULL.
201 * @signal: A valid signal name.
203 * Creates a new #GDBusMessage for a signal emission.
205 * Returns: A #GDBusMessage. Free with g_object_unref().
210 g_dbus_message_new_signal (const gchar *path,
211 const gchar *interface_,
214 GDBusMessage *message;
216 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
217 g_return_val_if_fail (g_dbus_is_member_name (signal), NULL);
218 g_return_val_if_fail (interface_ == NULL || g_dbus_is_interface_name (interface_), NULL);
220 message = g_dbus_message_new ();
221 message->type = G_DBUS_MESSAGE_TYPE_SIGNAL;
222 message->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
224 g_dbus_message_set_path (message, path);
225 g_dbus_message_set_member (message, signal);
227 if (interface_ != NULL)
228 g_dbus_message_set_interface (message, interface_);
235 * g_dbus_message_new_method_reply:
236 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
237 * create a reply message to.
239 * Creates a new #GDBusMessage that is a reply to @method_call_message.
241 * Returns: A #GDBusMessage. Free with g_object_unref().
246 g_dbus_message_new_method_reply (GDBusMessage *method_call_message)
248 GDBusMessage *message;
251 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
252 g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
253 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
255 message = g_dbus_message_new ();
256 message->type = G_DBUS_MESSAGE_TYPE_METHOD_RETURN;
257 message->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
259 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
260 sender = g_dbus_message_get_sender (method_call_message);
262 g_dbus_message_set_destination (message, sender);
268 * g_dbus_message_new_method_error:
269 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
270 * create a reply message to.
271 * @error_name: A valid D-Bus error name.
272 * @error_message_format: The D-Bus error message in a printf() format.
273 * @...: Arguments for @error_message_format.
275 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
277 * Returns: A #GDBusMessage. Free with g_object_unref().
282 g_dbus_message_new_method_error (GDBusMessage *method_call_message,
283 const gchar *error_name,
284 const gchar *error_message_format,
290 va_start (var_args, error_message_format);
291 ret = g_dbus_message_new_method_error_valist (method_call_message,
293 error_message_format,
301 * g_dbus_message_new_method_error_literal:
302 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
303 * create a reply message to.
304 * @error_name: A valid D-Bus error name.
305 * @error_message: The D-Bus error message.
307 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
309 * Returns: A #GDBusMessage. Free with g_object_unref().
314 g_dbus_message_new_method_error_literal (GDBusMessage *method_call_message,
315 const gchar *error_name,
316 const gchar *error_message)
318 GDBusMessage *message;
321 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
322 g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
323 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
324 g_return_val_if_fail (g_dbus_is_name (error_name), NULL);
325 g_return_val_if_fail (error_message != NULL, NULL);
327 message = g_dbus_message_new ();
328 message->type = G_DBUS_MESSAGE_TYPE_ERROR;
329 message->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
331 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
332 g_dbus_message_set_error_name (message, error_name);
333 g_dbus_message_set_body (message, g_variant_new ("(s)", error_message));
335 sender = g_dbus_message_get_sender (method_call_message);
337 g_dbus_message_set_destination (message, sender);
343 * g_dbus_message_new_method_error_valist:
344 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
345 * create a reply message to.
346 * @error_name: A valid D-Bus error name.
347 * @error_message_format: The D-Bus error message in a printf() format.
348 * @var_args: Arguments for @error_message_format.
350 * Like g_dbus_message_new_method_error() but intended for language bindings.
352 * Returns: A #GDBusMessage. Free with g_object_unref().
357 g_dbus_message_new_method_error_valist (GDBusMessage *method_call_message,
358 const gchar *error_name,
359 const gchar *error_message_format,
363 gchar *error_message;
364 error_message = g_strdup_vprintf (error_message_format, var_args);
365 ret = g_dbus_message_new_method_error_literal (method_call_message,
368 g_free (error_message);
372 /* ---------------------------------------------------------------------------------------------------- */
374 /* TODO: need GI annotations to specify that any guchar value goes for the type */
377 * g_dbus_message_get_message_type:
378 * @message: A #GDBusMessage.
380 * Gets the type of @message.
382 * Returns: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
387 g_dbus_message_get_message_type (GDBusMessage *message)
389 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_TYPE_INVALID);
390 return message->type;
394 * g_dbus_message_set_message_type:
395 * @message: A #GDBusMessage.
396 * @type: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
398 * Sets @message to be of @type.
403 g_dbus_message_set_message_type (GDBusMessage *message,
404 GDBusMessageType type)
406 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
407 g_return_if_fail (type >=0 && type < 256);
408 message->type = type;
411 /* ---------------------------------------------------------------------------------------------------- */
413 /* TODO: need GI annotations to specify that any guchar value goes for flags */
416 * g_dbus_message_get_flags:
417 * @message: A #GDBusMessage.
419 * Gets the flags for @message.
421 * Returns: Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).
426 g_dbus_message_get_flags (GDBusMessage *message)
428 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_FLAGS_NONE);
429 return message->flags;
433 * g_dbus_message_set_flags:
434 * @message: A #GDBusMessage.
435 * @flags: Flags for @message that are set (typically values from the #GDBusMessageFlags
436 * enumeration bitwise ORed together).
438 * Sets the flags to set on @message.
443 g_dbus_message_set_flags (GDBusMessage *message,
444 GDBusMessageFlags flags)
446 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
447 g_return_if_fail (flags >=0 && flags < 256);
448 message->flags = flags;
451 /* ---------------------------------------------------------------------------------------------------- */
454 * g_dbus_message_get_serial:
455 * @message: A #GDBusMessage.
457 * Gets the serial for @message.
459 * Returns: A #guint32.
464 g_dbus_message_get_serial (GDBusMessage *message)
466 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
467 return message->serial;
471 * g_dbus_message_set_serial:
472 * @message: A #GDBusMessage.
473 * @serial: A #guint32.
475 * Sets the serial for @message.
480 g_dbus_message_set_serial (GDBusMessage *message,
483 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
484 message->serial = serial;
487 /* ---------------------------------------------------------------------------------------------------- */
489 /* TODO: need GI annotations to specify that any guchar value goes for header_field */
492 * g_dbus_message_get_header:
493 * @message: A #GDBusMessage.
494 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
496 * Gets a header field on @message.
498 * Returns: A #GVariant with the value if the header was found, %NULL
499 * otherwise. Do not free, it is owned by @message.
504 g_dbus_message_get_header (GDBusMessage *message,
505 GDBusMessageHeaderField header_field)
507 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
508 g_return_val_if_fail (header_field >=0 && header_field < 256, NULL);
509 return g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
513 * g_dbus_message_set_header:
514 * @message: A #GDBusMessage.
515 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
516 * @value: A #GVariant to set the header field or %NULL to clear the header field.
518 * Sets a header field on @message.
520 * If @value is floating, @message assumes ownership of @value.
525 g_dbus_message_set_header (GDBusMessage *message,
526 GDBusMessageHeaderField header_field,
529 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
530 g_return_if_fail (header_field >=0 && header_field < 256);
533 g_hash_table_remove (message->headers, GUINT_TO_POINTER (header_field));
537 g_hash_table_insert (message->headers, GUINT_TO_POINTER (header_field), g_variant_ref_sink (value));
542 * g_dbus_message_get_header_fields:
543 * @message: A #GDBusMessage.
545 * Gets an array of all header fields on @message that are set.
547 * Returns: An array of header fields terminated by
548 * %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a
549 * #guchar. Free with g_free().
554 g_dbus_message_get_header_fields (GDBusMessage *message)
562 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
564 keys = g_hash_table_get_keys (message->headers);
565 num_keys = g_list_length (keys);
566 ret = g_new (guchar, num_keys + 1);
567 for (l = keys, n = 0; l != NULL; l = l->next, n++)
568 ret[n] = GPOINTER_TO_UINT (l->data);
569 g_assert (n == num_keys);
570 ret[n] = G_DBUS_MESSAGE_HEADER_FIELD_INVALID;
576 /* ---------------------------------------------------------------------------------------------------- */
579 * g_dbus_message_get_body:
580 * @message: A #GDBusMessage.
582 * Gets the body of a message.
584 * Returns: A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message.
589 g_dbus_message_get_body (GDBusMessage *message)
591 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
592 return message->body;
596 * g_dbus_message_set_body:
597 * @message: A #GDBusMessage.
598 * @body: Either %NULL or a #GVariant that is a tuple.
600 * Sets the body @message. As a side-effect the
601 * %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the
602 * type string of @body (or cleared if @body is %NULL).
604 * If @body is floating, @message assumes ownership of @body.
609 g_dbus_message_set_body (GDBusMessage *message,
612 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
613 g_return_if_fail ((body == NULL) || g_variant_is_of_type (body, G_VARIANT_TYPE_TUPLE));
615 if (message->body != NULL)
616 g_variant_unref (message->body);
619 message->body = NULL;
620 g_dbus_message_set_signature (message, NULL);
624 const gchar *type_string;
625 gsize type_string_len;
628 message->body = g_variant_ref_sink (body);
630 type_string = g_variant_get_type_string (body);
631 type_string_len = strlen (type_string);
632 g_assert (type_string_len >= 2);
633 signature = g_strndup (type_string + 1, type_string_len - 2);
634 g_dbus_message_set_signature (message, signature);
639 /* ---------------------------------------------------------------------------------------------------- */
643 * g_dbus_message_get_unix_fd_list:
644 * @message: A #GDBusMessage.
646 * Gets the UNIX file descriptors associated with @message, if any.
648 * This method is only available on UNIX.
650 * Returns: A #GUnixFDList or %NULL if no file descriptors are
651 * associated. Do not free, this object is owned by @message.
656 g_dbus_message_get_unix_fd_list (GDBusMessage *message)
658 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
659 return message->fd_list;
663 * g_dbus_message_set_unix_fd_list:
664 * @message: A #GDBusMessage.
665 * @fd_list: A #GUnixFDList or %NULL.
667 * Sets the UNIX file descriptors associated with @message. As a
668 * side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header
669 * field is set to the number of fds in @fd_list (or cleared if
670 * @fd_list is %NULL).
672 * This method is only available on UNIX.
677 g_dbus_message_set_unix_fd_list (GDBusMessage *message,
678 GUnixFDList *fd_list)
680 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
681 g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
682 if (message->fd_list != NULL)
683 g_object_unref (message->fd_list);
686 message->fd_list = g_object_ref (fd_list);
687 g_dbus_message_set_num_unix_fds (message, g_unix_fd_list_get_length (fd_list));
691 message->fd_list = NULL;
692 g_dbus_message_set_num_unix_fds (message, 0);
697 /* ---------------------------------------------------------------------------------------------------- */
700 ensure_input_padding (GMemoryInputStream *mis,
707 offset = g_seekable_tell (G_SEEKABLE (mis));
708 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
710 if (offset != wanted_offset)
712 return g_seekable_seek (G_SEEKABLE (mis), wanted_offset, G_SEEK_SET, NULL, error);
721 read_string (GMemoryInputStream *mis,
722 GDataInputStream *dis,
732 s = g_string_new (NULL);
735 while (remaining > 0)
740 to_read = MIN (remaining, sizeof (buf));
741 num_read = g_input_stream_read (G_INPUT_STREAM (mis),
750 /* G_GSIZE_FORMAT doesn't work with gettext, so we use %lu */
753 G_IO_ERROR_INVALID_ARGUMENT,
754 _("Wanted to read %lu bytes but got EOF"),
759 remaining -= num_read;
760 g_string_append_len (s, buf, num_read);
764 nul = g_data_input_stream_read_byte (dis, NULL, &local_error);
765 if (local_error != NULL)
767 g_propagate_error (error, local_error);
774 G_IO_ERROR_INVALID_ARGUMENT,
775 _("Expected NUL byte after the string `%s' but found `%c' (%d)"),
780 return g_string_free (s, FALSE);
783 g_string_free (s, TRUE);
787 /* if just_align==TRUE, don't read a value, just align the input stream wrt padding */
789 /* returns a non-floating GVariant! */
791 parse_value_from_blob (GMemoryInputStream *mis,
792 GDataInputStream *dis,
793 const GVariantType *type,
802 #ifdef DEBUG_SERIALIZER
806 s = g_variant_type_dup_string (type);
807 g_print ("%*sReading type %s from offset 0x%04x",
810 (gint) g_seekable_tell (G_SEEKABLE (mis)));
813 #endif /* DEBUG_SERIALIZER */
819 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
821 if (!ensure_input_padding (mis, 4, &local_error))
826 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
827 if (local_error != NULL)
829 ret = g_variant_new_boolean (v);
832 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
837 v = g_data_input_stream_read_byte (dis, NULL, &local_error);
838 if (local_error != NULL)
840 ret = g_variant_new_byte (v);
843 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
845 if (!ensure_input_padding (mis, 2, &local_error))
850 v = g_data_input_stream_read_int16 (dis, NULL, &local_error);
851 if (local_error != NULL)
853 ret = g_variant_new_int16 (v);
856 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
858 if (!ensure_input_padding (mis, 2, &local_error))
863 v = g_data_input_stream_read_uint16 (dis, NULL, &local_error);
864 if (local_error != NULL)
866 ret = g_variant_new_uint16 (v);
869 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
871 if (!ensure_input_padding (mis, 4, &local_error))
876 v = g_data_input_stream_read_int32 (dis, NULL, &local_error);
877 if (local_error != NULL)
879 ret = g_variant_new_int32 (v);
882 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
884 if (!ensure_input_padding (mis, 4, &local_error))
889 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
890 if (local_error != NULL)
892 ret = g_variant_new_uint32 (v);
895 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
897 if (!ensure_input_padding (mis, 8, &local_error))
902 v = g_data_input_stream_read_int64 (dis, NULL, &local_error);
903 if (local_error != NULL)
905 ret = g_variant_new_int64 (v);
908 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
910 if (!ensure_input_padding (mis, 8, &local_error))
915 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
916 if (local_error != NULL)
918 ret = g_variant_new_uint64 (v);
921 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
923 if (!ensure_input_padding (mis, 8, &local_error))
929 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
930 if (local_error != NULL)
933 encoded = (gdouble *) &v;
934 ret = g_variant_new_double (*encoded);
937 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
939 if (!ensure_input_padding (mis, 4, &local_error))
945 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
946 if (local_error != NULL)
948 v = read_string (mis, dis, (gsize) len, &local_error);
951 ret = g_variant_new_string (v);
955 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
957 if (!ensure_input_padding (mis, 4, &local_error))
963 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
964 if (local_error != NULL)
966 v = read_string (mis, dis, (gsize) len, &local_error);
969 if (!g_variant_is_object_path (v))
971 g_set_error (&local_error,
973 G_IO_ERROR_INVALID_ARGUMENT,
974 _("Parsed value `%s' is not a valid D-Bus object path"),
979 ret = g_variant_new_object_path (v);
983 else if (g_variant_type_equal (type, G_VARIANT_TYPE_SIGNATURE))
989 len = g_data_input_stream_read_byte (dis, NULL, &local_error);
990 if (local_error != NULL)
992 v = read_string (mis, dis, (gsize) len, &local_error);
995 if (!g_variant_is_signature (v))
997 g_set_error (&local_error,
999 G_IO_ERROR_INVALID_ARGUMENT,
1000 _("Parsed value `%s' is not a valid D-Bus signature"),
1005 ret = g_variant_new_signature (v);
1009 else if (g_variant_type_equal (type, G_VARIANT_TYPE_HANDLE))
1011 if (!ensure_input_padding (mis, 4, &local_error))
1016 v = g_data_input_stream_read_int32 (dis, NULL, &local_error);
1017 if (local_error != NULL)
1019 ret = g_variant_new_handle (v);
1022 else if (g_variant_type_is_array (type))
1027 const GVariantType *element_type;
1028 GVariantBuilder builder;
1030 if (!ensure_input_padding (mis, 4, &local_error))
1039 array_len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1040 if (local_error != NULL)
1044 #ifdef DEBUG_SERIALIZER
1045 g_print (": array spans 0x%04x bytes\n", array_len);
1046 #endif /* DEBUG_SERIALIZER */
1048 if (array_len > (2<<26))
1050 /* G_GUINT32_FORMAT doesn't work with gettext, so use u */
1051 g_set_error (&local_error,
1053 G_IO_ERROR_INVALID_ARGUMENT,
1054 _("Encountered array of length %u bytes. Maximum length is 2<<26 bytes."),
1060 g_variant_builder_init (&builder, type);
1061 element_type = g_variant_type_element (type);
1066 item = parse_value_from_blob (mis,
1072 g_assert (item == NULL);
1076 /* TODO: optimize array of primitive types */
1077 offset = g_seekable_tell (G_SEEKABLE (mis));
1078 target = offset + array_len;
1079 while (offset < target)
1082 item = parse_value_from_blob (mis,
1090 g_variant_builder_clear (&builder);
1093 g_variant_builder_add_value (&builder, item);
1094 g_variant_unref (item);
1095 offset = g_seekable_tell (G_SEEKABLE (mis));
1101 ret = g_variant_builder_end (&builder);
1105 g_variant_builder_clear (&builder);
1108 else if (g_variant_type_is_dict_entry (type))
1110 const GVariantType *key_type;
1111 const GVariantType *value_type;
1115 if (!ensure_input_padding (mis, 8, &local_error))
1119 #ifdef DEBUG_SERIALIZER
1121 #endif /* DEBUG_SERIALIZER */
1125 key_type = g_variant_type_key (type);
1126 key = parse_value_from_blob (mis,
1134 value_type = g_variant_type_value (type);
1135 value = parse_value_from_blob (mis,
1143 g_variant_unref (key);
1146 ret = g_variant_new_dict_entry (key, value);
1147 g_variant_unref (key);
1148 g_variant_unref (value);
1151 else if (g_variant_type_is_tuple (type))
1153 if (!ensure_input_padding (mis, 8, &local_error))
1157 #ifdef DEBUG_SERIALIZER
1159 #endif /* DEBUG_SERIALIZER */
1163 const GVariantType *element_type;
1164 GVariantBuilder builder;
1166 g_variant_builder_init (&builder, type);
1167 element_type = g_variant_type_first (type);
1168 while (element_type != NULL)
1171 item = parse_value_from_blob (mis,
1179 g_variant_builder_clear (&builder);
1182 g_variant_builder_add_value (&builder, item);
1183 g_variant_unref (item);
1185 element_type = g_variant_type_next (element_type);
1187 ret = g_variant_builder_end (&builder);
1190 else if (g_variant_type_is_variant (type))
1193 #ifdef DEBUG_SERIALIZER
1195 #endif /* DEBUG_SERIALIZER */
1201 GVariantType *variant_type;
1204 siglen = g_data_input_stream_read_byte (dis, NULL, &local_error);
1205 if (local_error != NULL)
1207 sig = read_string (mis, dis, (gsize) siglen, &local_error);
1210 if (!g_variant_is_signature (sig))
1212 g_set_error (&local_error,
1214 G_IO_ERROR_INVALID_ARGUMENT,
1215 _("Parsed value `%s' for variant is not a valid D-Bus signature"),
1220 variant_type = g_variant_type_new (sig);
1222 value = parse_value_from_blob (mis,
1228 g_variant_type_free (variant_type);
1231 ret = g_variant_new_variant (value);
1232 g_variant_unref (value);
1238 s = g_variant_type_dup_string (type);
1239 g_set_error (&local_error,
1241 G_IO_ERROR_INVALID_ARGUMENT,
1242 _("Error deserializing GVariant with type-string `%s' from the D-Bus wire format"),
1248 g_assert ((just_align && ret == NULL) || (!just_align && ret != NULL));
1250 #ifdef DEBUG_SERIALIZER
1256 if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1258 s = g_strdup_printf ("0x%02x '%c'", g_variant_get_byte (ret), g_variant_get_byte (ret));
1262 s = g_variant_print (ret, FALSE);
1264 g_print (": %s\n", s);
1268 #endif /* DEBUG_SERIALIZER */
1270 /* sink the reference */
1273 g_assert (g_variant_is_floating (ret));
1274 g_variant_ref_sink (ret);
1279 #ifdef DEBUG_SERIALIZER
1281 "%*sFAILURE: %s (%s, %d)\n",
1283 local_error->message,
1284 g_quark_to_string (local_error->domain),
1286 #endif /* DEBUG_SERIALIZER */
1287 g_propagate_error (error, local_error);
1291 /* ---------------------------------------------------------------------------------------------------- */
1293 /* message_header must be at least 16 bytes */
1296 * g_dbus_message_bytes_needed:
1297 * @blob: A blob represent a binary D-Bus message.
1298 * @blob_len: The length of @blob (must be at least 16).
1299 * @error: Return location for error or %NULL.
1301 * Utility function to calculate how many bytes are needed to
1302 * completely deserialize the D-Bus message stored at @blob.
1304 * Returns: Number of bytes needed or -1 if @error is set (e.g. if
1305 * @blob contains invalid data or not enough data is available to
1306 * determine the size).
1311 g_dbus_message_bytes_needed (guchar *blob,
1319 g_return_val_if_fail (blob != NULL, -1);
1320 g_return_val_if_fail (error == NULL || *error == NULL, -1);
1321 g_return_val_if_fail (blob_len >= 16, -1);
1325 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1326 ret = 12 + 4 + GUINT32_FROM_LE (((guint32 *) blob)[3]);
1327 /* round up so it's a multiple of 8 */
1328 ret = 8 * ((ret + 7)/8);
1329 /* finally add the body size */
1330 ret += GUINT32_FROM_LE (((guint32 *) blob)[1]);
1332 else if (blob[0] == 'B')
1334 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1335 ret = 12 + 4 + GUINT32_FROM_BE (((guint32 *) blob)[3]);
1336 /* round up so it's a multiple of 8 */
1337 ret = 8 * ((ret + 7)/8);
1338 /* finally add the body size */
1339 ret += GUINT32_FROM_BE (((guint32 *) blob)[1]);
1345 G_IO_ERROR_INVALID_ARGUMENT,
1346 "Unable to determine message blob length - given blob is malformed");
1353 G_IO_ERROR_INVALID_ARGUMENT,
1354 "Blob indicates that message exceeds maximum message length (128MiB)");
1361 /* ---------------------------------------------------------------------------------------------------- */
1364 * g_dbus_message_new_from_blob:
1365 * @blob: A blob represent a binary D-Bus message.
1366 * @blob_len: The length of @blob.
1367 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
1368 * @error: Return location for error or %NULL.
1370 * Creates a new #GDBusMessage from the data stored at @blob.
1372 * Returns: A new #GDBusMessage or %NULL if @error is set. Free with
1378 g_dbus_message_new_from_blob (guchar *blob,
1380 GDBusCapabilityFlags capabilities,
1384 GMemoryInputStream *mis;
1385 GDataInputStream *dis;
1386 GDBusMessage *message;
1388 guchar major_protocol_version;
1389 GDataStreamByteOrder byte_order;
1390 guint32 message_body_len;
1394 GVariant *signature;
1396 /* TODO: check against @capabilities */
1400 g_return_val_if_fail (blob != NULL, NULL);
1401 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1402 g_return_val_if_fail (blob_len >= 12, NULL);
1404 message = g_dbus_message_new ();
1406 mis = G_MEMORY_INPUT_STREAM (g_memory_input_stream_new_from_data (blob, blob_len, NULL));
1407 dis = g_data_input_stream_new (G_INPUT_STREAM (mis));
1409 endianness = g_data_input_stream_read_byte (dis, NULL, NULL);
1413 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1416 byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
1421 G_IO_ERROR_INVALID_ARGUMENT,
1422 _("Invalid endianness value. Expected 'l' or 'B' but found '%c' (%d)"),
1423 endianness, endianness);
1426 g_data_input_stream_set_byte_order (dis, byte_order);
1428 message->type = g_data_input_stream_read_byte (dis, NULL, NULL);
1429 message->flags = g_data_input_stream_read_byte (dis, NULL, NULL);
1430 major_protocol_version = g_data_input_stream_read_byte (dis, NULL, NULL);
1431 if (major_protocol_version != 1)
1435 G_IO_ERROR_INVALID_ARGUMENT,
1436 _("Invalid major protocol version. Expected 1 but found %d"),
1437 major_protocol_version);
1440 message_body_len = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1441 message->serial = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1443 #ifdef DEBUG_SERIALIZER
1444 g_print ("Parsing blob (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1447 s = _g_dbus_hexdump ((const gchar *) blob, blob_len, 2);
1448 g_print ("%s\n", s);
1451 #endif /* DEBUG_SERIALIZER */
1453 #ifdef DEBUG_SERIALIZER
1454 g_print ("Parsing headers (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1455 #endif /* DEBUG_SERIALIZER */
1456 headers = parse_value_from_blob (mis,
1458 G_VARIANT_TYPE ("a{yv}"),
1462 if (headers == NULL)
1464 g_variant_iter_init (&iter, headers);
1465 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1467 guchar header_field;
1469 g_variant_get (item,
1473 g_dbus_message_set_header (message, header_field, value);
1474 g_variant_unref (value);
1475 g_variant_unref (item);
1477 g_variant_unref (headers);
1479 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
1480 if (signature != NULL)
1482 const gchar *signature_str;
1483 gsize signature_str_len;
1485 signature_str = g_variant_get_string (signature, &signature_str_len);
1487 /* signature but no body */
1488 if (message_body_len == 0 && signature_str_len > 0)
1492 G_IO_ERROR_INVALID_ARGUMENT,
1493 _("Signature header with signature `%s' found but message body is empty"),
1497 else if (signature_str_len > 0)
1499 GVariantType *variant_type;
1500 gchar *tupled_signature_str;
1502 if (!g_variant_is_signature (signature_str))
1506 G_IO_ERROR_INVALID_ARGUMENT,
1507 _("Parsed value `%s' is not a valid D-Bus signature (for body)"),
1511 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
1512 variant_type = g_variant_type_new (tupled_signature_str);
1513 g_free (tupled_signature_str);
1514 #ifdef DEBUG_SERIALIZER
1515 g_print ("Parsing body (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1516 #endif /* DEBUG_SERIALIZER */
1517 message->body = parse_value_from_blob (mis,
1523 g_variant_type_free (variant_type);
1524 if (message->body == NULL)
1530 /* no signature, this is only OK if the body is empty */
1531 if (message_body_len != 0)
1533 /* G_GUINT32_FORMAT doesn't work with gettext, just use %u */
1536 G_IO_ERROR_INVALID_ARGUMENT,
1537 _("No signature header in message but the message body is %u bytes"),
1547 g_object_unref (dis);
1548 g_object_unref (mis);
1556 if (message != NULL)
1557 g_object_unref (message);
1562 /* ---------------------------------------------------------------------------------------------------- */
1565 ensure_output_padding (GMemoryOutputStream *mos,
1566 GDataOutputStream *dos,
1570 gsize wanted_offset;
1571 gsize padding_needed;
1574 offset = g_memory_output_stream_get_data_size (mos);
1575 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
1576 padding_needed = wanted_offset - offset;
1578 for (n = 0; n < padding_needed; n++)
1579 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1581 return padding_needed;
1584 /* note that value can be NULL for e.g. empty arrays - type is never NULL */
1586 append_value_to_blob (GVariant *value,
1587 const GVariantType *type,
1588 GMemoryOutputStream *mos,
1589 GDataOutputStream *dos,
1590 gsize *out_padding_added,
1593 gsize padding_added;
1597 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
1599 padding_added = ensure_output_padding (mos, dos, 4);
1602 gboolean v = g_variant_get_boolean (value);
1603 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1606 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1610 guint8 v = g_variant_get_byte (value);
1611 g_data_output_stream_put_byte (dos, v, NULL, NULL);
1614 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
1616 padding_added = ensure_output_padding (mos, dos, 2);
1619 gint16 v = g_variant_get_int16 (value);
1620 g_data_output_stream_put_int16 (dos, v, NULL, NULL);
1623 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
1625 padding_added = ensure_output_padding (mos, dos, 2);
1628 guint16 v = g_variant_get_uint16 (value);
1629 g_data_output_stream_put_uint16 (dos, v, NULL, NULL);
1632 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
1634 padding_added = ensure_output_padding (mos, dos, 4);
1637 gint32 v = g_variant_get_int32 (value);
1638 g_data_output_stream_put_int32 (dos, v, NULL, NULL);
1641 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
1643 padding_added = ensure_output_padding (mos, dos, 4);
1646 guint32 v = g_variant_get_uint32 (value);
1647 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1650 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
1652 padding_added = ensure_output_padding (mos, dos, 8);
1655 gint64 v = g_variant_get_int64 (value);
1656 g_data_output_stream_put_int64 (dos, v, NULL, NULL);
1659 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
1661 padding_added = ensure_output_padding (mos, dos, 8);
1664 guint64 v = g_variant_get_uint64 (value);
1665 g_data_output_stream_put_uint64 (dos, v, NULL, NULL);
1668 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
1670 padding_added = ensure_output_padding (mos, dos, 8);
1674 gdouble v = g_variant_get_double (value);
1676 encoded = (guint64 *) &v;
1677 g_data_output_stream_put_uint64 (dos, *encoded, NULL, NULL);
1680 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
1682 padding_added = ensure_output_padding (mos, dos, 4);
1686 const gchar *v = g_variant_get_string (value, &len);
1687 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1688 g_data_output_stream_put_string (dos, v, NULL, NULL);
1689 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1692 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
1694 padding_added = ensure_output_padding (mos, dos, 4);
1697 /* TODO: validate object path */
1699 const gchar *v = g_variant_get_string (value, &len);
1700 g_data_output_stream_put_uint32 (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_equal (type, G_VARIANT_TYPE_SIGNATURE))
1709 /* TODO: validate signature (including max len being 255) */
1711 const gchar *v = g_variant_get_string (value, &len);
1712 g_data_output_stream_put_byte (dos, len, NULL, NULL);
1713 g_data_output_stream_put_string (dos, v, NULL, NULL);
1714 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1717 else if (g_variant_type_equal (type, G_VARIANT_TYPE_HANDLE))
1719 padding_added = ensure_output_padding (mos, dos, 4);
1722 gint32 v = g_variant_get_handle (value);
1723 g_data_output_stream_put_int32 (dos, v, NULL, NULL);
1726 else if (g_variant_type_is_array (type))
1730 goffset array_len_offset;
1731 goffset array_payload_begin_offset;
1735 padding_added = ensure_output_padding (mos, dos, 4);
1738 /* array length - will be filled in later */
1739 array_len_offset = g_memory_output_stream_get_data_size (mos);
1740 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
1742 /* From the D-Bus spec:
1744 * "A UINT32 giving the length of the array data in bytes,
1745 * followed by alignment padding to the alignment boundary of
1746 * the array element type, followed by each array element. The
1747 * array length is from the end of the alignment padding to
1748 * the end of the last element, i.e. it does not include the
1749 * padding after the length, or any padding after the last
1752 * Thus, we need to count how much padding the first element
1753 * contributes and subtract that from the array length.
1755 array_payload_begin_offset = g_memory_output_stream_get_data_size (mos);
1757 if (g_variant_n_children (value) == 0)
1759 gsize padding_added_for_item;
1760 if (!append_value_to_blob (NULL,
1761 g_variant_type_element (type),
1764 &padding_added_for_item,
1767 array_payload_begin_offset += padding_added_for_item;
1773 g_variant_iter_init (&iter, value);
1774 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1776 gsize padding_added_for_item;
1777 if (!append_value_to_blob (item,
1778 g_variant_get_type (item),
1781 &padding_added_for_item,
1784 g_variant_unref (item);
1787 g_variant_unref (item);
1790 array_payload_begin_offset += padding_added_for_item;
1796 cur_offset = g_memory_output_stream_get_data_size (mos);
1798 array_len = cur_offset - array_payload_begin_offset;
1800 if (!g_seekable_seek (G_SEEKABLE (mos), array_len_offset, G_SEEK_SET, NULL, error))
1803 g_data_output_stream_put_uint32 (dos, array_len, NULL, NULL);
1805 if (!g_seekable_seek (G_SEEKABLE (mos), cur_offset, G_SEEK_SET, NULL, error))
1809 else if (g_variant_type_is_dict_entry (type) || g_variant_type_is_tuple (type))
1811 padding_added = ensure_output_padding (mos, dos, 8);
1816 g_variant_iter_init (&iter, value);
1817 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1819 if (!append_value_to_blob (item,
1820 g_variant_get_type (item),
1826 g_variant_unref (item);
1829 g_variant_unref (item);
1833 else if (g_variant_type_is_variant (type))
1838 const gchar *signature;
1839 child = g_variant_get_child_value (value, 0);
1840 signature = g_variant_get_type_string (child);
1841 /* TODO: validate signature (including max len being 255) */
1842 g_data_output_stream_put_byte (dos, strlen (signature), NULL, NULL);
1843 g_data_output_stream_put_string (dos, signature, NULL, NULL);
1844 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1845 if (!append_value_to_blob (child,
1846 g_variant_get_type (child),
1852 g_variant_unref (child);
1855 g_variant_unref (child);
1862 G_IO_ERROR_INVALID_ARGUMENT,
1863 _("Error serializing GVariant with type-string `%s' to the D-Bus wire format"),
1864 g_variant_get_type_string (value));
1868 if (out_padding_added != NULL)
1869 *out_padding_added = padding_added;
1878 append_body_to_blob (GVariant *value,
1879 GMemoryOutputStream *mos,
1880 GDataOutputStream *dos,
1889 if (!g_variant_is_of_type (value, G_VARIANT_TYPE_TUPLE))
1893 G_IO_ERROR_INVALID_ARGUMENT,
1894 "Expected a tuple for the body of the GDBusMessage.");
1898 g_variant_iter_init (&iter, value);
1899 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1901 if (!append_value_to_blob (item,
1902 g_variant_get_type (item),
1908 g_variant_unref (item);
1911 g_variant_unref (item);
1919 /* ---------------------------------------------------------------------------------------------------- */
1922 * g_dbus_message_to_blob:
1923 * @message: A #GDBusMessage.
1924 * @out_size: Return location for size of generated blob.
1925 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
1926 * @error: Return location for error.
1928 * Serializes @message to a blob.
1930 * Returns: A pointer to a valid binary D-Bus message of @out_size bytes
1931 * generated by @message or %NULL if @error is set. Free with g_free().
1936 g_dbus_message_to_blob (GDBusMessage *message,
1938 GDBusCapabilityFlags capabilities,
1941 GMemoryOutputStream *mos;
1942 GDataOutputStream *dos;
1945 GDataStreamByteOrder byte_order;
1946 goffset body_len_offset;
1947 goffset body_start_offset;
1949 GVariant *header_fields;
1950 GVariantBuilder builder;
1951 GHashTableIter hash_iter;
1953 GVariant *header_value;
1954 GVariant *signature;
1955 const gchar *signature_str;
1956 gint num_fds_in_message;
1957 gint num_fds_according_to_header;
1959 /* TODO: check against @capabilities */
1963 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1964 g_return_val_if_fail (out_size != NULL, NULL);
1965 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1967 mos = G_MEMORY_OUTPUT_STREAM (g_memory_output_stream_new (NULL, 0, g_realloc, g_free));
1968 dos = g_data_output_stream_new (G_OUTPUT_STREAM (mos));
1970 /* Any D-Bus implementation is supposed to handle both Big and
1971 * Little Endian encodings and the Endianness is part of the D-Bus
1972 * message - we prefer to use Big Endian (since it's Network Byte
1973 * Order and just easier to read for humans) but if the machine is
1974 * Little Endian we use that for performance reasons.
1976 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
1977 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1979 /* this could also be G_PDP_ENDIAN */
1980 byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
1982 g_data_output_stream_set_byte_order (dos, byte_order);
1985 g_data_output_stream_put_byte (dos, byte_order == G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN ? 'l' : 'B', NULL, NULL);
1986 g_data_output_stream_put_byte (dos, message->type, NULL, NULL);
1987 g_data_output_stream_put_byte (dos, message->flags, NULL, NULL);
1988 g_data_output_stream_put_byte (dos, 1, NULL, NULL); /* major protocol version */
1989 body_len_offset = g_memory_output_stream_get_data_size (mos);
1990 /* body length - will be filled in later */
1991 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
1992 g_data_output_stream_put_uint32 (dos, message->serial, NULL, NULL);
1994 num_fds_in_message = 0;
1996 if (message->fd_list != NULL)
1997 num_fds_in_message = g_unix_fd_list_get_length (message->fd_list);
1999 num_fds_according_to_header = g_dbus_message_get_num_unix_fds (message);
2000 /* TODO: check we have all the right header fields and that they are the correct value etc etc */
2001 if (num_fds_in_message != num_fds_according_to_header)
2005 G_IO_ERROR_INVALID_ARGUMENT,
2006 _("Message has %d fds but the header field indicates %d fds"),
2008 num_fds_according_to_header);
2012 g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{yv}"));
2013 g_hash_table_iter_init (&hash_iter, message->headers);
2014 while (g_hash_table_iter_next (&hash_iter, &key, (gpointer) &header_value))
2016 g_variant_builder_add (&builder,
2018 (guchar) GPOINTER_TO_UINT (key),
2021 header_fields = g_variant_builder_end (&builder);
2023 if (!append_value_to_blob (header_fields,
2024 g_variant_get_type (header_fields),
2029 g_variant_unref (header_fields);
2032 g_variant_unref (header_fields);
2034 /* header size must be a multiple of 8 */
2035 ensure_output_padding (mos, dos, 8);
2037 body_start_offset = g_memory_output_stream_get_data_size (mos);
2039 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2040 signature_str = NULL;
2041 if (signature != NULL)
2042 signature_str = g_variant_get_string (signature, NULL);
2043 if (message->body != NULL)
2045 gchar *tupled_signature_str;
2046 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
2047 if (signature == NULL)
2051 G_IO_ERROR_INVALID_ARGUMENT,
2052 _("Message body has signature `%s' but there is no signature header"),
2054 g_free (tupled_signature_str);
2057 else if (g_strcmp0 (tupled_signature_str, g_variant_get_type_string (message->body)) != 0)
2061 G_IO_ERROR_INVALID_ARGUMENT,
2062 _("Message body has type signature `%s' but signature in the header field is `%s'"),
2063 tupled_signature_str, g_variant_get_type_string (message->body));
2064 g_free (tupled_signature_str);
2067 g_free (tupled_signature_str);
2068 if (!append_body_to_blob (message->body, mos, dos, error))
2073 if (signature != NULL && strlen (signature_str) > 0)
2077 G_IO_ERROR_INVALID_ARGUMENT,
2078 _("Message body is empty but signature in the header field is `(%s)'"),
2084 /* OK, we're done writing the message - set the body length */
2085 size = g_memory_output_stream_get_data_size (mos);
2086 body_size = size - body_start_offset;
2088 if (!g_seekable_seek (G_SEEKABLE (mos), body_len_offset, G_SEEK_SET, NULL, error))
2091 g_data_output_stream_put_uint32 (dos, body_size, NULL, NULL);
2094 ret = g_memdup (g_memory_output_stream_get_data (mos), size);
2097 g_object_unref (dos);
2098 g_object_unref (mos);
2103 /* ---------------------------------------------------------------------------------------------------- */
2106 get_uint32_header (GDBusMessage *message,
2107 GDBusMessageHeaderField header_field)
2113 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2114 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_UINT32))
2115 ret = g_variant_get_uint32 (value);
2120 static const gchar *
2121 get_string_header (GDBusMessage *message,
2122 GDBusMessageHeaderField header_field)
2128 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2129 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
2130 ret = g_variant_get_string (value, NULL);
2135 static const gchar *
2136 get_object_path_header (GDBusMessage *message,
2137 GDBusMessageHeaderField header_field)
2143 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2144 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_OBJECT_PATH))
2145 ret = g_variant_get_string (value, NULL);
2150 static const gchar *
2151 get_signature_header (GDBusMessage *message,
2152 GDBusMessageHeaderField header_field)
2158 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2159 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_SIGNATURE))
2160 ret = g_variant_get_string (value, NULL);
2165 /* ---------------------------------------------------------------------------------------------------- */
2168 set_uint32_header (GDBusMessage *message,
2169 GDBusMessageHeaderField header_field,
2172 g_dbus_message_set_header (message,
2174 g_variant_new_uint32 (value));
2178 set_string_header (GDBusMessage *message,
2179 GDBusMessageHeaderField header_field,
2182 g_dbus_message_set_header (message,
2184 value == NULL ? NULL : g_variant_new_string (value));
2188 set_object_path_header (GDBusMessage *message,
2189 GDBusMessageHeaderField header_field,
2192 g_dbus_message_set_header (message,
2194 value == NULL ? NULL : g_variant_new_object_path (value));
2198 set_signature_header (GDBusMessage *message,
2199 GDBusMessageHeaderField header_field,
2202 g_dbus_message_set_header (message,
2204 value == NULL ? NULL : g_variant_new_signature (value));
2207 /* ---------------------------------------------------------------------------------------------------- */
2210 * g_dbus_message_get_reply_serial:
2211 * @message: A #GDBusMessage.
2213 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2215 * Returns: The value.
2220 g_dbus_message_get_reply_serial (GDBusMessage *message)
2222 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2223 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL);
2227 * g_dbus_message_set_reply_serial:
2228 * @message: A #GDBusMessage.
2229 * @value: The value to set.
2231 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2236 g_dbus_message_set_reply_serial (GDBusMessage *message,
2239 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2240 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL, value);
2243 /* ---------------------------------------------------------------------------------------------------- */
2246 * g_dbus_message_get_interface:
2247 * @message: A #GDBusMessage.
2249 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2251 * Returns: The value.
2256 g_dbus_message_get_interface (GDBusMessage *message)
2258 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2259 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE);
2263 * g_dbus_message_set_interface:
2264 * @message: A #GDBusMessage.
2265 * @value: The value to set.
2267 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2272 g_dbus_message_set_interface (GDBusMessage *message,
2275 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2276 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2277 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE, value);
2280 /* ---------------------------------------------------------------------------------------------------- */
2283 * g_dbus_message_get_member:
2284 * @message: A #GDBusMessage.
2286 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2288 * Returns: The value.
2293 g_dbus_message_get_member (GDBusMessage *message)
2295 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2296 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER);
2300 * g_dbus_message_set_member:
2301 * @message: A #GDBusMessage.
2302 * @value: The value to set.
2304 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2309 g_dbus_message_set_member (GDBusMessage *message,
2312 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2313 g_return_if_fail (value == NULL || g_dbus_is_member_name (value));
2314 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER, value);
2317 /* ---------------------------------------------------------------------------------------------------- */
2320 * g_dbus_message_get_path:
2321 * @message: A #GDBusMessage.
2323 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2325 * Returns: The value.
2330 g_dbus_message_get_path (GDBusMessage *message)
2332 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2333 return get_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH);
2337 * g_dbus_message_set_path:
2338 * @message: A #GDBusMessage.
2339 * @value: The value to set.
2341 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2346 g_dbus_message_set_path (GDBusMessage *message,
2349 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2350 g_return_if_fail (value == NULL || g_variant_is_object_path (value));
2351 set_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH, value);
2354 /* ---------------------------------------------------------------------------------------------------- */
2357 * g_dbus_message_get_sender:
2358 * @message: A #GDBusMessage.
2360 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2362 * Returns: The value.
2367 g_dbus_message_get_sender (GDBusMessage *message)
2369 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2370 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER);
2374 * g_dbus_message_set_sender:
2375 * @message: A #GDBusMessage.
2376 * @value: The value to set.
2378 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2383 g_dbus_message_set_sender (GDBusMessage *message,
2386 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2387 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2388 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER, value);
2391 /* ---------------------------------------------------------------------------------------------------- */
2394 * g_dbus_message_get_destination:
2395 * @message: A #GDBusMessage.
2397 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2399 * Returns: The value.
2404 g_dbus_message_get_destination (GDBusMessage *message)
2406 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2407 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION);
2411 * g_dbus_message_set_destination:
2412 * @message: A #GDBusMessage.
2413 * @value: The value to set.
2415 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2420 g_dbus_message_set_destination (GDBusMessage *message,
2423 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2424 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2425 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION, value);
2428 /* ---------------------------------------------------------------------------------------------------- */
2431 * g_dbus_message_get_error_name:
2432 * @message: A #GDBusMessage.
2434 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2436 * Returns: The value.
2441 g_dbus_message_get_error_name (GDBusMessage *message)
2443 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2444 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME);
2448 * g_dbus_message_set_error_name:
2449 * @message: A #GDBusMessage.
2450 * @value: The value to set.
2452 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2457 g_dbus_message_set_error_name (GDBusMessage *message,
2460 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2461 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2462 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME, value);
2465 /* ---------------------------------------------------------------------------------------------------- */
2468 * g_dbus_message_get_signature:
2469 * @message: A #GDBusMessage.
2471 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2473 * Returns: The value.
2478 g_dbus_message_get_signature (GDBusMessage *message)
2481 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2482 ret = get_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2489 * g_dbus_message_set_signature:
2490 * @message: A #GDBusMessage.
2491 * @value: The value to set.
2493 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2498 g_dbus_message_set_signature (GDBusMessage *message,
2501 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2502 g_return_if_fail (value == NULL || g_variant_is_signature (value));
2503 set_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE, value);
2506 /* ---------------------------------------------------------------------------------------------------- */
2509 * g_dbus_message_get_arg0:
2510 * @message: A #GDBusMessage.
2512 * Convenience to get the first item in the body of @message.
2514 * Returns: The string item or %NULL if the first item in the body of
2515 * @message is not a string.
2520 g_dbus_message_get_arg0 (GDBusMessage *message)
2524 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2528 if (message->body != NULL && g_variant_is_of_type (message->body, G_VARIANT_TYPE_TUPLE))
2531 item = g_variant_get_child_value (message->body, 0);
2532 if (g_variant_is_of_type (item, G_VARIANT_TYPE_STRING))
2533 ret = g_variant_get_string (item, NULL);
2534 g_variant_unref (item);
2540 /* ---------------------------------------------------------------------------------------------------- */
2543 * g_dbus_message_get_num_unix_fds:
2544 * @message: A #GDBusMessage.
2546 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2548 * Returns: The value.
2553 g_dbus_message_get_num_unix_fds (GDBusMessage *message)
2555 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2556 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS);
2560 * g_dbus_message_set_num_unix_fds:
2561 * @message: A #GDBusMessage.
2562 * @value: The value to set.
2564 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2569 g_dbus_message_set_num_unix_fds (GDBusMessage *message,
2572 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2573 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS, value);
2576 /* ---------------------------------------------------------------------------------------------------- */
2579 * g_dbus_message_to_gerror:
2580 * @message: A #GDBusMessage.
2581 * @error: The #GError to set.
2583 * If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does
2584 * nothing and returns %FALSE.
2586 * Otherwise this method encodes the error in @message as a #GError
2587 * using g_dbus_error_set_dbus_error() using the information in the
2588 * %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of @message as
2589 * well as the first string item in @message's body.
2591 * Returns: %TRUE if @error was set, %FALSE otherwise.
2596 g_dbus_message_to_gerror (GDBusMessage *message,
2600 const gchar *error_name;
2602 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2605 if (message->type != G_DBUS_MESSAGE_TYPE_ERROR)
2608 error_name = g_dbus_message_get_error_name (message);
2609 if (error_name != NULL)
2613 body = g_dbus_message_get_body (message);
2615 if (body != NULL && g_variant_is_of_type (body, G_VARIANT_TYPE ("(s)")))
2617 const gchar *error_message;
2618 g_variant_get (body, "(&s)", &error_message);
2619 g_dbus_error_set_dbus_error (error,
2626 /* these two situations are valid, yet pretty rare */
2629 g_dbus_error_set_dbus_error (error,
2632 _("Error return with body of type `%s'"),
2633 g_variant_get_type_string (body));
2637 g_dbus_error_set_dbus_error (error,
2640 _("Error return with empty body"));
2646 /* TOOD: this shouldn't happen - should check this at message serialization
2647 * time and disconnect the peer.
2652 "Error return without error-name header!");
2661 /* ---------------------------------------------------------------------------------------------------- */
2664 flags_to_string (GType flags_type, guint value)
2670 klass = g_type_class_ref (flags_type);
2671 s = g_string_new (NULL);
2672 for (n = 0; n < 32; n++)
2674 if ((value & (1<<n)) != 0)
2676 GFlagsValue *flags_value;
2677 flags_value = g_flags_get_first_value (klass, (1<<n));
2679 g_string_append_c (s, ',');
2680 if (flags_value != NULL)
2681 g_string_append (s, flags_value->value_nick);
2683 g_string_append_printf (s, "unknown (bit %d)", n);
2687 g_string_append (s, "none");
2688 g_type_class_unref (klass);
2689 return g_string_free (s, FALSE);
2693 _sort_keys_func (gconstpointer a,
2699 ia = GPOINTER_TO_INT (a);
2700 ib = GPOINTER_TO_INT (b);
2706 * g_dbus_message_print:
2707 * @message: A #GDBusMessage.
2708 * @indent: Indentation level.
2710 * Produces a human-readable multi-line description of @message.
2712 * The contents of the description has no ABI guarantees, the contents
2713 * and formatting is subject to change at any time. Typical output
2714 * looks something like this:
2721 * path -> objectpath '/org/gtk/GDBus/TestObject'
2722 * interface -> 'org.gtk.GDBus.TestInterface'
2723 * member -> 'GimmeStdout'
2724 * destination -> ':1.146'
2726 * UNIX File Descriptors:
2731 * Type: method-return
2732 * Flags: no-reply-expected
2736 * reply-serial -> uint32 4
2737 * destination -> ':1.159'
2738 * sender -> ':1.146'
2739 * num-unix-fds -> uint32 1
2741 * UNIX File Descriptors:
2742 * fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635
2745 * Returns: A string that should be freed with g_free().
2750 g_dbus_message_print (GDBusMessage *message,
2758 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2760 str = g_string_new (NULL);
2762 s = _g_dbus_enum_to_string (G_TYPE_DBUS_MESSAGE_TYPE, message->type);
2763 g_string_append_printf (str, "%*sType: %s\n", indent, "", s);
2765 s = flags_to_string (G_TYPE_DBUS_MESSAGE_FLAGS, message->flags);
2766 g_string_append_printf (str, "%*sFlags: %s\n", indent, "", s);
2768 g_string_append_printf (str, "%*sVersion: %d\n", indent, "", message->major_protocol_version);
2769 g_string_append_printf (str, "%*sSerial: %d\n", indent, "", message->serial);
2771 g_string_append_printf (str, "%*sHeaders:\n", indent, "");
2772 keys = g_hash_table_get_keys (message->headers);
2773 keys = g_list_sort (keys, _sort_keys_func);
2776 for (l = keys; l != NULL; l = l->next)
2778 gint key = GPOINTER_TO_INT (l->data);
2782 value = g_hash_table_lookup (message->headers, l->data);
2783 g_assert (value != NULL);
2785 s = _g_dbus_enum_to_string (G_TYPE_DBUS_MESSAGE_HEADER_FIELD, key);
2786 value_str = g_variant_print (value, TRUE);
2787 g_string_append_printf (str, "%*s %s -> %s\n", indent, "", s, value_str);
2794 g_string_append_printf (str, "%*s (none)\n", indent, "");
2796 g_string_append_printf (str, "%*sBody: ", indent, "");
2797 if (message->body != NULL)
2799 g_variant_print_string (message->body,
2805 g_string_append (str, "()");
2807 g_string_append (str, "\n");
2809 g_string_append_printf (str, "%*sUNIX File Descriptors:\n", indent, "");
2810 if (message->fd_list != NULL)
2816 fds = g_unix_fd_list_peek_fds (message->fd_list, &num_fds);
2819 for (n = 0; n < num_fds; n++)
2822 struct stat statbuf;
2823 fs = g_string_new (NULL);
2824 if (fstat (fds[n], &statbuf) == 0)
2826 g_string_append_printf (fs, "%s" "dev=%d:%d", fs->len > 0 ? "," : "",
2827 major (statbuf.st_dev), minor (statbuf.st_dev));
2828 g_string_append_printf (fs, "%s" "mode=0%o", fs->len > 0 ? "," : "",
2830 g_string_append_printf (fs, "%s" "ino=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2831 (guint64) statbuf.st_ino);
2832 g_string_append_printf (fs, "%s" "uid=%d", fs->len > 0 ? "," : "",
2834 g_string_append_printf (fs, "%s" "gid=%d", fs->len > 0 ? "," : "",
2836 g_string_append_printf (fs, "%s" "rdev=%d:%d", fs->len > 0 ? "," : "",
2837 major (statbuf.st_rdev), minor (statbuf.st_rdev));
2838 g_string_append_printf (fs, "%s" "size=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2839 (guint64) statbuf.st_size);
2840 g_string_append_printf (fs, "%s" "atime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2841 (guint64) statbuf.st_atime);
2842 g_string_append_printf (fs, "%s" "mtime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2843 (guint64) statbuf.st_mtime);
2844 g_string_append_printf (fs, "%s" "ctime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2845 (guint64) statbuf.st_ctime);
2849 g_string_append_printf (fs, "(fstat failed: %s)", strerror (errno));
2851 g_string_append_printf (str, "%*s fd %d: %s\n", indent, "", fds[n], fs->str);
2852 g_string_free (fs, TRUE);
2857 g_string_append_printf (str, "%*s (empty)\n", indent, "");
2862 g_string_append_printf (str, "%*s (none)\n", indent, "");
2866 return g_string_free (str, FALSE);