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_is_array (type))
1014 const GVariantType *element_type;
1015 GVariantBuilder builder;
1017 if (!ensure_input_padding (mis, 4, &local_error))
1026 array_len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1027 if (local_error != NULL)
1031 #ifdef DEBUG_SERIALIZER
1032 g_print (": array spans 0x%04x bytes\n", array_len);
1033 #endif /* DEBUG_SERIALIZER */
1035 if (array_len > (2<<26))
1037 /* G_GUINT32_FORMAT doesn't work with gettext, so use u */
1038 g_set_error (&local_error,
1040 G_IO_ERROR_INVALID_ARGUMENT,
1041 _("Encountered array of length %u bytes. Maximum length is 2<<26 bytes."),
1047 g_variant_builder_init (&builder, type);
1048 element_type = g_variant_type_element (type);
1053 item = parse_value_from_blob (mis,
1059 g_assert (item == NULL);
1063 /* TODO: optimize array of primitive types */
1064 offset = g_seekable_tell (G_SEEKABLE (mis));
1065 target = offset + array_len;
1066 while (offset < target)
1069 item = parse_value_from_blob (mis,
1077 g_variant_builder_clear (&builder);
1080 g_variant_builder_add_value (&builder, item);
1081 g_variant_unref (item);
1082 offset = g_seekable_tell (G_SEEKABLE (mis));
1088 ret = g_variant_builder_end (&builder);
1092 g_variant_builder_clear (&builder);
1095 else if (g_variant_type_is_dict_entry (type))
1097 const GVariantType *key_type;
1098 const GVariantType *value_type;
1102 if (!ensure_input_padding (mis, 8, &local_error))
1106 #ifdef DEBUG_SERIALIZER
1108 #endif /* DEBUG_SERIALIZER */
1112 key_type = g_variant_type_key (type);
1113 key = parse_value_from_blob (mis,
1121 value_type = g_variant_type_value (type);
1122 value = parse_value_from_blob (mis,
1130 g_variant_unref (key);
1133 ret = g_variant_new_dict_entry (key, value);
1134 g_variant_unref (key);
1135 g_variant_unref (value);
1138 else if (g_variant_type_is_tuple (type))
1140 if (!ensure_input_padding (mis, 8, &local_error))
1144 #ifdef DEBUG_SERIALIZER
1146 #endif /* DEBUG_SERIALIZER */
1150 const GVariantType *element_type;
1151 GVariantBuilder builder;
1153 g_variant_builder_init (&builder, type);
1154 element_type = g_variant_type_first (type);
1155 while (element_type != NULL)
1158 item = parse_value_from_blob (mis,
1166 g_variant_builder_clear (&builder);
1169 g_variant_builder_add_value (&builder, item);
1170 g_variant_unref (item);
1172 element_type = g_variant_type_next (element_type);
1174 ret = g_variant_builder_end (&builder);
1177 else if (g_variant_type_is_variant (type))
1180 #ifdef DEBUG_SERIALIZER
1182 #endif /* DEBUG_SERIALIZER */
1188 GVariantType *variant_type;
1191 siglen = g_data_input_stream_read_byte (dis, NULL, &local_error);
1192 if (local_error != NULL)
1194 sig = read_string (mis, dis, (gsize) siglen, &local_error);
1197 if (!g_variant_is_signature (sig))
1199 g_set_error (&local_error,
1201 G_IO_ERROR_INVALID_ARGUMENT,
1202 _("Parsed value `%s' for variant is not a valid D-Bus signature"),
1207 variant_type = g_variant_type_new (sig);
1209 value = parse_value_from_blob (mis,
1215 g_variant_type_free (variant_type);
1218 ret = g_variant_new_variant (value);
1219 g_variant_unref (value);
1225 s = g_variant_type_dup_string (type);
1226 g_set_error (&local_error,
1228 G_IO_ERROR_INVALID_ARGUMENT,
1229 _("Error deserializing GVariant with type-string `%s' from the D-Bus wire format"),
1235 g_assert ((just_align && ret == NULL) || (!just_align && ret != NULL));
1237 #ifdef DEBUG_SERIALIZER
1243 if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1245 s = g_strdup_printf ("0x%02x '%c'", g_variant_get_byte (ret), g_variant_get_byte (ret));
1249 s = g_variant_print (ret, FALSE);
1251 g_print (": %s\n", s);
1255 #endif /* DEBUG_SERIALIZER */
1257 /* sink the reference */
1260 g_assert (g_variant_is_floating (ret));
1261 g_variant_ref_sink (ret);
1266 #ifdef DEBUG_SERIALIZER
1268 "%*sFAILURE: %s (%s, %d)\n",
1270 local_error->message,
1271 g_quark_to_string (local_error->domain),
1273 #endif /* DEBUG_SERIALIZER */
1274 g_propagate_error (error, local_error);
1278 /* ---------------------------------------------------------------------------------------------------- */
1280 /* message_header must be at least 16 bytes */
1283 * g_dbus_message_bytes_needed:
1284 * @blob: A blob represent a binary D-Bus message.
1285 * @blob_len: The length of @blob (must be at least 16).
1286 * @error: Return location for error or %NULL.
1288 * Utility function to calculate how many bytes are needed to
1289 * completely deserialize the D-Bus message stored at @blob.
1291 * Returns: Number of bytes needed or -1 if @error is set (e.g. if
1292 * @blob contains invalid data or not enough data is available to
1293 * determine the size).
1298 g_dbus_message_bytes_needed (guchar *blob,
1306 g_return_val_if_fail (blob != NULL, -1);
1307 g_return_val_if_fail (error == NULL || *error == NULL, -1);
1308 g_return_val_if_fail (blob_len >= 16, -1);
1312 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1313 ret = 12 + 4 + GUINT32_FROM_LE (((guint32 *) blob)[3]);
1314 /* round up so it's a multiple of 8 */
1315 ret = 8 * ((ret + 7)/8);
1316 /* finally add the body size */
1317 ret += GUINT32_FROM_LE (((guint32 *) blob)[1]);
1319 else if (blob[0] == 'B')
1321 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1322 ret = 12 + 4 + GUINT32_FROM_BE (((guint32 *) blob)[3]);
1323 /* round up so it's a multiple of 8 */
1324 ret = 8 * ((ret + 7)/8);
1325 /* finally add the body size */
1326 ret += GUINT32_FROM_BE (((guint32 *) blob)[1]);
1332 G_IO_ERROR_INVALID_ARGUMENT,
1333 "Unable to determine message blob length - given blob is malformed");
1340 G_IO_ERROR_INVALID_ARGUMENT,
1341 "Blob indicates that message exceeds maximum message length (128MiB)");
1348 /* ---------------------------------------------------------------------------------------------------- */
1351 * g_dbus_message_new_from_blob:
1352 * @blob: A blob represent a binary D-Bus message.
1353 * @blob_len: The length of @blob.
1354 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
1355 * @error: Return location for error or %NULL.
1357 * Creates a new #GDBusMessage from the data stored at @blob.
1359 * Returns: A new #GDBusMessage or %NULL if @error is set. Free with
1365 g_dbus_message_new_from_blob (guchar *blob,
1367 GDBusCapabilityFlags capabilities,
1371 GMemoryInputStream *mis;
1372 GDataInputStream *dis;
1373 GDBusMessage *message;
1375 guchar major_protocol_version;
1376 GDataStreamByteOrder byte_order;
1377 guint32 message_body_len;
1381 GVariant *signature;
1383 /* TODO: check against @capabilities */
1387 g_return_val_if_fail (blob != NULL, NULL);
1388 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1389 g_return_val_if_fail (blob_len >= 12, NULL);
1391 message = g_dbus_message_new ();
1393 mis = G_MEMORY_INPUT_STREAM (g_memory_input_stream_new_from_data (blob, blob_len, NULL));
1394 dis = g_data_input_stream_new (G_INPUT_STREAM (mis));
1396 endianness = g_data_input_stream_read_byte (dis, NULL, NULL);
1400 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1403 byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
1408 G_IO_ERROR_INVALID_ARGUMENT,
1409 _("Invalid endianness value. Expected 'l' or 'B' but found '%c' (%d)"),
1410 endianness, endianness);
1413 g_data_input_stream_set_byte_order (dis, byte_order);
1415 message->type = g_data_input_stream_read_byte (dis, NULL, NULL);
1416 message->flags = g_data_input_stream_read_byte (dis, NULL, NULL);
1417 major_protocol_version = g_data_input_stream_read_byte (dis, NULL, NULL);
1418 if (major_protocol_version != 1)
1422 G_IO_ERROR_INVALID_ARGUMENT,
1423 _("Invalid major protocol version. Expected 1 but found %d"),
1424 major_protocol_version);
1427 message_body_len = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1428 message->serial = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1430 #ifdef DEBUG_SERIALIZER
1431 g_print ("Parsing blob (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1434 s = _g_dbus_hexdump ((const gchar *) blob, blob_len, 2);
1435 g_print ("%s\n", s);
1438 #endif /* DEBUG_SERIALIZER */
1440 #ifdef DEBUG_SERIALIZER
1441 g_print ("Parsing headers (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1442 #endif /* DEBUG_SERIALIZER */
1443 headers = parse_value_from_blob (mis,
1445 G_VARIANT_TYPE ("a{yv}"),
1449 if (headers == NULL)
1451 g_variant_iter_init (&iter, headers);
1452 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1454 guchar header_field;
1456 g_variant_get (item,
1460 g_dbus_message_set_header (message, header_field, value);
1461 g_variant_unref (value);
1462 g_variant_unref (item);
1464 g_variant_unref (headers);
1466 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
1467 if (signature != NULL)
1469 const gchar *signature_str;
1470 gsize signature_str_len;
1472 signature_str = g_variant_get_string (signature, &signature_str_len);
1474 /* signature but no body */
1475 if (message_body_len == 0 && signature_str_len > 0)
1479 G_IO_ERROR_INVALID_ARGUMENT,
1480 _("Signature header with signature `%s' found but message body is empty"),
1484 else if (signature_str_len > 0)
1486 GVariantType *variant_type;
1487 gchar *tupled_signature_str;
1489 if (!g_variant_is_signature (signature_str))
1493 G_IO_ERROR_INVALID_ARGUMENT,
1494 _("Parsed value `%s' is not a valid D-Bus signature (for body)"),
1498 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
1499 variant_type = g_variant_type_new (tupled_signature_str);
1500 g_free (tupled_signature_str);
1501 #ifdef DEBUG_SERIALIZER
1502 g_print ("Parsing body (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1503 #endif /* DEBUG_SERIALIZER */
1504 message->body = parse_value_from_blob (mis,
1510 g_variant_type_free (variant_type);
1511 if (message->body == NULL)
1517 /* no signature, this is only OK if the body is empty */
1518 if (message_body_len != 0)
1520 /* G_GUINT32_FORMAT doesn't work with gettext, just use %u */
1523 G_IO_ERROR_INVALID_ARGUMENT,
1524 _("No signature header in message but the message body is %u bytes"),
1534 g_object_unref (dis);
1535 g_object_unref (mis);
1543 if (message != NULL)
1544 g_object_unref (message);
1549 /* ---------------------------------------------------------------------------------------------------- */
1552 ensure_output_padding (GMemoryOutputStream *mos,
1553 GDataOutputStream *dos,
1557 gsize wanted_offset;
1558 gsize padding_needed;
1561 offset = g_memory_output_stream_get_data_size (mos);
1562 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
1563 padding_needed = wanted_offset - offset;
1565 for (n = 0; n < padding_needed; n++)
1566 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1568 return padding_needed;
1571 /* note that value can be NULL for e.g. empty arrays - type is never NULL */
1573 append_value_to_blob (GVariant *value,
1574 const GVariantType *type,
1575 GMemoryOutputStream *mos,
1576 GDataOutputStream *dos,
1577 gsize *out_padding_added,
1580 gsize padding_added;
1584 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
1586 padding_added = ensure_output_padding (mos, dos, 4);
1589 gboolean v = g_variant_get_boolean (value);
1590 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1593 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1597 guint8 v = g_variant_get_byte (value);
1598 g_data_output_stream_put_byte (dos, v, NULL, NULL);
1601 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
1603 padding_added = ensure_output_padding (mos, dos, 2);
1606 gint16 v = g_variant_get_int16 (value);
1607 g_data_output_stream_put_int16 (dos, v, NULL, NULL);
1610 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
1612 padding_added = ensure_output_padding (mos, dos, 2);
1615 guint16 v = g_variant_get_uint16 (value);
1616 g_data_output_stream_put_uint16 (dos, v, NULL, NULL);
1619 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
1621 padding_added = ensure_output_padding (mos, dos, 4);
1624 gint32 v = g_variant_get_int32 (value);
1625 g_data_output_stream_put_int32 (dos, v, NULL, NULL);
1628 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
1630 padding_added = ensure_output_padding (mos, dos, 4);
1633 guint32 v = g_variant_get_uint32 (value);
1634 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1637 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
1639 padding_added = ensure_output_padding (mos, dos, 8);
1642 gint64 v = g_variant_get_int64 (value);
1643 g_data_output_stream_put_int64 (dos, v, NULL, NULL);
1646 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
1648 padding_added = ensure_output_padding (mos, dos, 8);
1651 guint64 v = g_variant_get_uint64 (value);
1652 g_data_output_stream_put_uint64 (dos, v, NULL, NULL);
1655 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
1657 padding_added = ensure_output_padding (mos, dos, 8);
1661 gdouble v = g_variant_get_double (value);
1663 encoded = (guint64 *) &v;
1664 g_data_output_stream_put_uint64 (dos, *encoded, NULL, NULL);
1667 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
1669 padding_added = ensure_output_padding (mos, dos, 4);
1673 const gchar *v = g_variant_get_string (value, &len);
1674 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1675 g_data_output_stream_put_string (dos, v, NULL, NULL);
1676 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1679 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
1681 padding_added = ensure_output_padding (mos, dos, 4);
1684 /* TODO: validate object path */
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_SIGNATURE))
1696 /* TODO: validate signature (including max len being 255) */
1698 const gchar *v = g_variant_get_string (value, &len);
1699 g_data_output_stream_put_byte (dos, len, NULL, NULL);
1700 g_data_output_stream_put_string (dos, v, NULL, NULL);
1701 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1704 else if (g_variant_type_is_array (type))
1708 goffset array_len_offset;
1709 goffset array_payload_begin_offset;
1713 padding_added = ensure_output_padding (mos, dos, 4);
1716 /* array length - will be filled in later */
1717 array_len_offset = g_memory_output_stream_get_data_size (mos);
1718 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
1720 /* From the D-Bus spec:
1722 * "A UINT32 giving the length of the array data in bytes,
1723 * followed by alignment padding to the alignment boundary of
1724 * the array element type, followed by each array element. The
1725 * array length is from the end of the alignment padding to
1726 * the end of the last element, i.e. it does not include the
1727 * padding after the length, or any padding after the last
1730 * Thus, we need to count how much padding the first element
1731 * contributes and subtract that from the array length.
1733 array_payload_begin_offset = g_memory_output_stream_get_data_size (mos);
1735 if (g_variant_n_children (value) == 0)
1737 gsize padding_added_for_item;
1738 if (!append_value_to_blob (NULL,
1739 g_variant_type_element (type),
1742 &padding_added_for_item,
1745 array_payload_begin_offset += padding_added_for_item;
1751 g_variant_iter_init (&iter, value);
1752 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1754 gsize padding_added_for_item;
1755 if (!append_value_to_blob (item,
1756 g_variant_get_type (item),
1759 &padding_added_for_item,
1762 g_variant_unref (item);
1765 g_variant_unref (item);
1768 array_payload_begin_offset += padding_added_for_item;
1774 cur_offset = g_memory_output_stream_get_data_size (mos);
1776 array_len = cur_offset - array_payload_begin_offset;
1778 if (!g_seekable_seek (G_SEEKABLE (mos), array_len_offset, G_SEEK_SET, NULL, error))
1781 g_data_output_stream_put_uint32 (dos, array_len, NULL, NULL);
1783 if (!g_seekable_seek (G_SEEKABLE (mos), cur_offset, G_SEEK_SET, NULL, error))
1787 else if (g_variant_type_is_dict_entry (type) || g_variant_type_is_tuple (type))
1789 padding_added = ensure_output_padding (mos, dos, 8);
1794 g_variant_iter_init (&iter, value);
1795 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1797 if (!append_value_to_blob (item,
1798 g_variant_get_type (item),
1804 g_variant_unref (item);
1807 g_variant_unref (item);
1811 else if (g_variant_type_is_variant (type))
1816 const gchar *signature;
1817 child = g_variant_get_child_value (value, 0);
1818 signature = g_variant_get_type_string (child);
1819 /* TODO: validate signature (including max len being 255) */
1820 g_data_output_stream_put_byte (dos, strlen (signature), NULL, NULL);
1821 g_data_output_stream_put_string (dos, signature, NULL, NULL);
1822 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1823 if (!append_value_to_blob (child,
1824 g_variant_get_type (child),
1830 g_variant_unref (child);
1833 g_variant_unref (child);
1840 G_IO_ERROR_INVALID_ARGUMENT,
1841 _("Error serializing GVariant with type-string `%s' to the D-Bus wire format"),
1842 g_variant_get_type_string (value));
1846 if (out_padding_added != NULL)
1847 *out_padding_added = padding_added;
1856 append_body_to_blob (GVariant *value,
1857 GMemoryOutputStream *mos,
1858 GDataOutputStream *dos,
1867 if (!g_variant_is_of_type (value, G_VARIANT_TYPE_TUPLE))
1871 G_IO_ERROR_INVALID_ARGUMENT,
1872 "Expected a tuple for the body of the GDBusMessage.");
1876 g_variant_iter_init (&iter, value);
1877 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1879 if (!append_value_to_blob (item,
1880 g_variant_get_type (item),
1886 g_variant_unref (item);
1889 g_variant_unref (item);
1897 /* ---------------------------------------------------------------------------------------------------- */
1900 * g_dbus_message_to_blob:
1901 * @message: A #GDBusMessage.
1902 * @out_size: Return location for size of generated blob.
1903 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
1904 * @error: Return location for error.
1906 * Serializes @message to a blob.
1908 * Returns: A pointer to a valid binary D-Bus message of @out_size bytes
1909 * generated by @message or %NULL if @error is set. Free with g_free().
1914 g_dbus_message_to_blob (GDBusMessage *message,
1916 GDBusCapabilityFlags capabilities,
1919 GMemoryOutputStream *mos;
1920 GDataOutputStream *dos;
1923 GDataStreamByteOrder byte_order;
1924 goffset body_len_offset;
1925 goffset body_start_offset;
1927 GVariant *header_fields;
1928 GVariantBuilder builder;
1929 GHashTableIter hash_iter;
1931 GVariant *header_value;
1932 GVariant *signature;
1933 const gchar *signature_str;
1934 gint num_fds_in_message;
1935 gint num_fds_according_to_header;
1937 /* TODO: check against @capabilities */
1941 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1942 g_return_val_if_fail (out_size != NULL, NULL);
1943 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1945 mos = G_MEMORY_OUTPUT_STREAM (g_memory_output_stream_new (NULL, 0, g_realloc, g_free));
1946 dos = g_data_output_stream_new (G_OUTPUT_STREAM (mos));
1948 /* Any D-Bus implementation is supposed to handle both Big and
1949 * Little Endian encodings and the Endianness is part of the D-Bus
1950 * message - we prefer to use Big Endian (since it's Network Byte
1951 * Order and just easier to read for humans) but if the machine is
1952 * Little Endian we use that for performance reasons.
1954 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
1955 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1957 /* this could also be G_PDP_ENDIAN */
1958 byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
1960 g_data_output_stream_set_byte_order (dos, byte_order);
1963 g_data_output_stream_put_byte (dos, byte_order == G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN ? 'l' : 'B', NULL, NULL);
1964 g_data_output_stream_put_byte (dos, message->type, NULL, NULL);
1965 g_data_output_stream_put_byte (dos, message->flags, NULL, NULL);
1966 g_data_output_stream_put_byte (dos, 1, NULL, NULL); /* major protocol version */
1967 body_len_offset = g_memory_output_stream_get_data_size (mos);
1968 /* body length - will be filled in later */
1969 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
1970 g_data_output_stream_put_uint32 (dos, message->serial, NULL, NULL);
1972 num_fds_in_message = 0;
1974 if (message->fd_list != NULL)
1975 num_fds_in_message = g_unix_fd_list_get_length (message->fd_list);
1977 num_fds_according_to_header = g_dbus_message_get_num_unix_fds (message);
1978 /* TODO: check we have all the right header fields and that they are the correct value etc etc */
1979 if (num_fds_in_message != num_fds_according_to_header)
1983 G_IO_ERROR_INVALID_ARGUMENT,
1984 _("Message has %d fds but the header field indicates %d fds"),
1986 num_fds_according_to_header);
1990 g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{yv}"));
1991 g_hash_table_iter_init (&hash_iter, message->headers);
1992 while (g_hash_table_iter_next (&hash_iter, &key, (gpointer) &header_value))
1994 g_variant_builder_add (&builder,
1996 (guchar) GPOINTER_TO_UINT (key),
1999 header_fields = g_variant_builder_end (&builder);
2001 if (!append_value_to_blob (header_fields,
2002 g_variant_get_type (header_fields),
2007 g_variant_unref (header_fields);
2010 g_variant_unref (header_fields);
2012 /* header size must be a multiple of 8 */
2013 ensure_output_padding (mos, dos, 8);
2015 body_start_offset = g_memory_output_stream_get_data_size (mos);
2017 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2018 signature_str = NULL;
2019 if (signature != NULL)
2020 signature_str = g_variant_get_string (signature, NULL);
2021 if (message->body != NULL)
2023 gchar *tupled_signature_str;
2024 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
2025 if (signature == NULL)
2029 G_IO_ERROR_INVALID_ARGUMENT,
2030 _("Message body has signature `%s' but there is no signature header"),
2032 g_free (tupled_signature_str);
2035 else if (g_strcmp0 (tupled_signature_str, g_variant_get_type_string (message->body)) != 0)
2039 G_IO_ERROR_INVALID_ARGUMENT,
2040 _("Message body has type signature `%s' but signature in the header field is `%s'"),
2041 tupled_signature_str, g_variant_get_type_string (message->body));
2042 g_free (tupled_signature_str);
2045 g_free (tupled_signature_str);
2046 if (!append_body_to_blob (message->body, mos, dos, error))
2051 if (signature != NULL && strlen (signature_str) > 0)
2055 G_IO_ERROR_INVALID_ARGUMENT,
2056 _("Message body is empty but signature in the header field is `(%s)'"),
2062 /* OK, we're done writing the message - set the body length */
2063 size = g_memory_output_stream_get_data_size (mos);
2064 body_size = size - body_start_offset;
2066 if (!g_seekable_seek (G_SEEKABLE (mos), body_len_offset, G_SEEK_SET, NULL, error))
2069 g_data_output_stream_put_uint32 (dos, body_size, NULL, NULL);
2072 ret = g_memdup (g_memory_output_stream_get_data (mos), size);
2075 g_object_unref (dos);
2076 g_object_unref (mos);
2081 /* ---------------------------------------------------------------------------------------------------- */
2084 get_uint32_header (GDBusMessage *message,
2085 GDBusMessageHeaderField header_field)
2091 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2092 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_UINT32))
2093 ret = g_variant_get_uint32 (value);
2098 static const gchar *
2099 get_string_header (GDBusMessage *message,
2100 GDBusMessageHeaderField header_field)
2106 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2107 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
2108 ret = g_variant_get_string (value, NULL);
2113 static const gchar *
2114 get_object_path_header (GDBusMessage *message,
2115 GDBusMessageHeaderField header_field)
2121 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2122 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_OBJECT_PATH))
2123 ret = g_variant_get_string (value, NULL);
2128 static const gchar *
2129 get_signature_header (GDBusMessage *message,
2130 GDBusMessageHeaderField header_field)
2136 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2137 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_SIGNATURE))
2138 ret = g_variant_get_string (value, NULL);
2143 /* ---------------------------------------------------------------------------------------------------- */
2146 set_uint32_header (GDBusMessage *message,
2147 GDBusMessageHeaderField header_field,
2150 g_dbus_message_set_header (message,
2152 g_variant_new_uint32 (value));
2156 set_string_header (GDBusMessage *message,
2157 GDBusMessageHeaderField header_field,
2160 g_dbus_message_set_header (message,
2162 value == NULL ? NULL : g_variant_new_string (value));
2166 set_object_path_header (GDBusMessage *message,
2167 GDBusMessageHeaderField header_field,
2170 g_dbus_message_set_header (message,
2172 value == NULL ? NULL : g_variant_new_object_path (value));
2176 set_signature_header (GDBusMessage *message,
2177 GDBusMessageHeaderField header_field,
2180 g_dbus_message_set_header (message,
2182 value == NULL ? NULL : g_variant_new_signature (value));
2185 /* ---------------------------------------------------------------------------------------------------- */
2188 * g_dbus_message_get_reply_serial:
2189 * @message: A #GDBusMessage.
2191 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2193 * Returns: The value.
2198 g_dbus_message_get_reply_serial (GDBusMessage *message)
2200 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2201 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL);
2205 * g_dbus_message_set_reply_serial:
2206 * @message: A #GDBusMessage.
2207 * @value: The value to set.
2209 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2214 g_dbus_message_set_reply_serial (GDBusMessage *message,
2217 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2218 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL, value);
2221 /* ---------------------------------------------------------------------------------------------------- */
2224 * g_dbus_message_get_interface:
2225 * @message: A #GDBusMessage.
2227 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2229 * Returns: The value.
2234 g_dbus_message_get_interface (GDBusMessage *message)
2236 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2237 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE);
2241 * g_dbus_message_set_interface:
2242 * @message: A #GDBusMessage.
2243 * @value: The value to set.
2245 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2250 g_dbus_message_set_interface (GDBusMessage *message,
2253 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2254 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2255 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE, value);
2258 /* ---------------------------------------------------------------------------------------------------- */
2261 * g_dbus_message_get_member:
2262 * @message: A #GDBusMessage.
2264 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2266 * Returns: The value.
2271 g_dbus_message_get_member (GDBusMessage *message)
2273 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2274 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER);
2278 * g_dbus_message_set_member:
2279 * @message: A #GDBusMessage.
2280 * @value: The value to set.
2282 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2287 g_dbus_message_set_member (GDBusMessage *message,
2290 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2291 g_return_if_fail (value == NULL || g_dbus_is_member_name (value));
2292 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER, value);
2295 /* ---------------------------------------------------------------------------------------------------- */
2298 * g_dbus_message_get_path:
2299 * @message: A #GDBusMessage.
2301 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2303 * Returns: The value.
2308 g_dbus_message_get_path (GDBusMessage *message)
2310 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2311 return get_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH);
2315 * g_dbus_message_set_path:
2316 * @message: A #GDBusMessage.
2317 * @value: The value to set.
2319 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2324 g_dbus_message_set_path (GDBusMessage *message,
2327 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2328 g_return_if_fail (value == NULL || g_variant_is_object_path (value));
2329 set_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH, value);
2332 /* ---------------------------------------------------------------------------------------------------- */
2335 * g_dbus_message_get_sender:
2336 * @message: A #GDBusMessage.
2338 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2340 * Returns: The value.
2345 g_dbus_message_get_sender (GDBusMessage *message)
2347 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2348 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER);
2352 * g_dbus_message_set_sender:
2353 * @message: A #GDBusMessage.
2354 * @value: The value to set.
2356 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2361 g_dbus_message_set_sender (GDBusMessage *message,
2364 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2365 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2366 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER, value);
2369 /* ---------------------------------------------------------------------------------------------------- */
2372 * g_dbus_message_get_destination:
2373 * @message: A #GDBusMessage.
2375 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2377 * Returns: The value.
2382 g_dbus_message_get_destination (GDBusMessage *message)
2384 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2385 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION);
2389 * g_dbus_message_set_destination:
2390 * @message: A #GDBusMessage.
2391 * @value: The value to set.
2393 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2398 g_dbus_message_set_destination (GDBusMessage *message,
2401 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2402 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2403 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION, value);
2406 /* ---------------------------------------------------------------------------------------------------- */
2409 * g_dbus_message_get_error_name:
2410 * @message: A #GDBusMessage.
2412 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2414 * Returns: The value.
2419 g_dbus_message_get_error_name (GDBusMessage *message)
2421 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2422 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME);
2426 * g_dbus_message_set_error_name:
2427 * @message: A #GDBusMessage.
2428 * @value: The value to set.
2430 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2435 g_dbus_message_set_error_name (GDBusMessage *message,
2438 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2439 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2440 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME, value);
2443 /* ---------------------------------------------------------------------------------------------------- */
2446 * g_dbus_message_get_signature:
2447 * @message: A #GDBusMessage.
2449 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2451 * Returns: The value.
2456 g_dbus_message_get_signature (GDBusMessage *message)
2459 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2460 ret = get_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2467 * g_dbus_message_set_signature:
2468 * @message: A #GDBusMessage.
2469 * @value: The value to set.
2471 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2476 g_dbus_message_set_signature (GDBusMessage *message,
2479 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2480 g_return_if_fail (value == NULL || g_variant_is_signature (value));
2481 set_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE, value);
2484 /* ---------------------------------------------------------------------------------------------------- */
2487 * g_dbus_message_get_arg0:
2488 * @message: A #GDBusMessage.
2490 * Convenience to get the first item in the body of @message.
2492 * Returns: The string item or %NULL if the first item in the body of
2493 * @message is not a string.
2498 g_dbus_message_get_arg0 (GDBusMessage *message)
2502 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2506 if (message->body != NULL && g_variant_is_of_type (message->body, G_VARIANT_TYPE_TUPLE))
2509 item = g_variant_get_child_value (message->body, 0);
2510 if (g_variant_is_of_type (item, G_VARIANT_TYPE_STRING))
2511 ret = g_variant_get_string (item, NULL);
2512 g_variant_unref (item);
2518 /* ---------------------------------------------------------------------------------------------------- */
2521 * g_dbus_message_get_num_unix_fds:
2522 * @message: A #GDBusMessage.
2524 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2526 * Returns: The value.
2531 g_dbus_message_get_num_unix_fds (GDBusMessage *message)
2533 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2534 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS);
2538 * g_dbus_message_set_num_unix_fds:
2539 * @message: A #GDBusMessage.
2540 * @value: The value to set.
2542 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2547 g_dbus_message_set_num_unix_fds (GDBusMessage *message,
2550 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2551 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS, value);
2554 /* ---------------------------------------------------------------------------------------------------- */
2557 * g_dbus_message_to_gerror:
2558 * @message: A #GDBusMessage.
2559 * @error: The #GError to set.
2561 * If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does
2562 * nothing and returns %FALSE.
2564 * Otherwise this method encodes the error in @message as a #GError
2565 * using g_dbus_error_set_dbus_error() using the information in the
2566 * %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of @message as
2567 * well as the first string item in @message's body.
2569 * Returns: %TRUE if @error was set, %FALSE otherwise.
2574 g_dbus_message_to_gerror (GDBusMessage *message,
2578 const gchar *error_name;
2580 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2583 if (message->type != G_DBUS_MESSAGE_TYPE_ERROR)
2586 error_name = g_dbus_message_get_error_name (message);
2587 if (error_name != NULL)
2591 body = g_dbus_message_get_body (message);
2593 if (body != NULL && g_variant_is_of_type (body, G_VARIANT_TYPE ("(s)")))
2595 const gchar *error_message;
2596 g_variant_get (body, "(&s)", &error_message);
2597 g_dbus_error_set_dbus_error (error,
2604 /* these two situations are valid, yet pretty rare */
2607 g_dbus_error_set_dbus_error (error,
2610 _("Error return with body of type `%s'"),
2611 g_variant_get_type_string (body));
2615 g_dbus_error_set_dbus_error (error,
2618 _("Error return with empty body"));
2624 /* TOOD: this shouldn't happen - should check this at message serialization
2625 * time and disconnect the peer.
2630 "Error return without error-name header!");
2639 /* ---------------------------------------------------------------------------------------------------- */
2642 flags_to_string (GType flags_type, guint value)
2648 klass = g_type_class_ref (flags_type);
2649 s = g_string_new (NULL);
2650 for (n = 0; n < 32; n++)
2652 if ((value & (1<<n)) != 0)
2654 GFlagsValue *flags_value;
2655 flags_value = g_flags_get_first_value (klass, (1<<n));
2657 g_string_append_c (s, ',');
2658 if (flags_value != NULL)
2659 g_string_append (s, flags_value->value_nick);
2661 g_string_append_printf (s, "unknown (bit %d)", n);
2665 g_string_append (s, "none");
2666 g_type_class_unref (klass);
2667 return g_string_free (s, FALSE);
2671 _sort_keys_func (gconstpointer a,
2677 ia = GPOINTER_TO_INT (a);
2678 ib = GPOINTER_TO_INT (b);
2684 * g_dbus_message_print:
2685 * @message: A #GDBusMessage.
2686 * @indent: Indentation level.
2688 * Produces a human-readable multi-line description of @message.
2690 * The contents of the description has no ABI guarantees, the contents
2691 * and formatting is subject to change at any time. Typical output
2692 * looks something like this:
2699 * path -> objectpath '/org/gtk/GDBus/TestObject'
2700 * interface -> 'org.gtk.GDBus.TestInterface'
2701 * member -> 'GimmeStdout'
2702 * destination -> ':1.146'
2704 * UNIX File Descriptors:
2709 * Type: method-return
2710 * Flags: no-reply-expected
2714 * reply-serial -> uint32 4
2715 * destination -> ':1.159'
2716 * sender -> ':1.146'
2717 * num-unix-fds -> uint32 1
2719 * UNIX File Descriptors:
2720 * fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635
2723 * Returns: A string that should be freed with g_free().
2728 g_dbus_message_print (GDBusMessage *message,
2736 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2738 str = g_string_new (NULL);
2740 s = _g_dbus_enum_to_string (G_TYPE_DBUS_MESSAGE_TYPE, message->type);
2741 g_string_append_printf (str, "%*sType: %s\n", indent, "", s);
2743 s = flags_to_string (G_TYPE_DBUS_MESSAGE_FLAGS, message->flags);
2744 g_string_append_printf (str, "%*sFlags: %s\n", indent, "", s);
2746 g_string_append_printf (str, "%*sVersion: %d\n", indent, "", message->major_protocol_version);
2747 g_string_append_printf (str, "%*sSerial: %d\n", indent, "", message->serial);
2749 g_string_append_printf (str, "%*sHeaders:\n", indent, "");
2750 keys = g_hash_table_get_keys (message->headers);
2751 keys = g_list_sort (keys, _sort_keys_func);
2754 for (l = keys; l != NULL; l = l->next)
2756 gint key = GPOINTER_TO_INT (l->data);
2760 value = g_hash_table_lookup (message->headers, l->data);
2761 g_assert (value != NULL);
2763 s = _g_dbus_enum_to_string (G_TYPE_DBUS_MESSAGE_HEADER_FIELD, key);
2764 value_str = g_variant_print (value, TRUE);
2765 g_string_append_printf (str, "%*s %s -> %s\n", indent, "", s, value_str);
2772 g_string_append_printf (str, "%*s (none)\n", indent, "");
2774 g_string_append_printf (str, "%*sBody: ", indent, "");
2775 if (message->body != NULL)
2777 g_variant_print_string (message->body,
2783 g_string_append (str, "()");
2785 g_string_append (str, "\n");
2787 g_string_append_printf (str, "%*sUNIX File Descriptors:\n", indent, "");
2788 if (message->fd_list != NULL)
2794 fds = g_unix_fd_list_peek_fds (message->fd_list, &num_fds);
2797 for (n = 0; n < num_fds; n++)
2800 struct stat statbuf;
2801 fs = g_string_new (NULL);
2802 if (fstat (fds[n], &statbuf) == 0)
2804 g_string_append_printf (fs, "%s" "dev=%d:%d", fs->len > 0 ? "," : "",
2805 major (statbuf.st_dev), minor (statbuf.st_dev));
2806 g_string_append_printf (fs, "%s" "mode=0%o", fs->len > 0 ? "," : "",
2808 g_string_append_printf (fs, "%s" "ino=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2809 (guint64) statbuf.st_ino);
2810 g_string_append_printf (fs, "%s" "uid=%d", fs->len > 0 ? "," : "",
2812 g_string_append_printf (fs, "%s" "gid=%d", fs->len > 0 ? "," : "",
2814 g_string_append_printf (fs, "%s" "rdev=%d:%d", fs->len > 0 ? "," : "",
2815 major (statbuf.st_rdev), minor (statbuf.st_rdev));
2816 g_string_append_printf (fs, "%s" "size=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2817 (guint64) statbuf.st_size);
2818 g_string_append_printf (fs, "%s" "atime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2819 (guint64) statbuf.st_atime);
2820 g_string_append_printf (fs, "%s" "mtime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2821 (guint64) statbuf.st_mtime);
2822 g_string_append_printf (fs, "%s" "ctime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2823 (guint64) statbuf.st_ctime);
2827 g_string_append_printf (fs, "(fstat failed: %s)", strerror (errno));
2829 g_string_append_printf (str, "%*s fd %d: %s\n", indent, "", fds[n], fs->str);
2830 g_string_free (fs, TRUE);
2835 g_string_append_printf (str, "%*s (empty)\n", indent, "");
2840 g_string_append_printf (str, "%*s (none)\n", indent, "");
2844 return g_string_free (str, FALSE);