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;
96 GDBusMessageByteOrder byte_order;
97 guchar major_protocol_version;
102 GUnixFDList *fd_list;
112 G_DEFINE_TYPE (GDBusMessage, g_dbus_message, G_TYPE_OBJECT);
115 g_dbus_message_finalize (GObject *object)
117 GDBusMessage *message = G_DBUS_MESSAGE (object);
119 if (message->headers != NULL)
120 g_hash_table_unref (message->headers);
121 if (message->body != NULL)
122 g_variant_unref (message->body);
124 if (message->fd_list != NULL)
125 g_object_unref (message->fd_list);
128 if (G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize != NULL)
129 G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize (object);
133 g_dbus_message_get_property (GObject *object,
138 GDBusMessage *message = G_DBUS_MESSAGE (object);
143 g_value_set_boolean (value, g_dbus_message_get_locked (message));
147 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
153 g_dbus_message_class_init (GDBusMessageClass *klass)
155 GObjectClass *gobject_class;
157 gobject_class = G_OBJECT_CLASS (klass);
158 gobject_class->finalize = g_dbus_message_finalize;
159 gobject_class->get_property = g_dbus_message_get_property;
162 * GDBusConnection:locked:
164 * A boolean specifying whether the message is locked.
168 g_object_class_install_property (gobject_class,
170 g_param_spec_boolean ("locked",
172 P_("Whether the message is locked"),
175 G_PARAM_STATIC_NAME |
176 G_PARAM_STATIC_BLURB |
177 G_PARAM_STATIC_NICK));
181 g_dbus_message_init (GDBusMessage *message)
183 /* Any D-Bus implementation is supposed to handle both Big and
184 * Little Endian encodings and the Endianness is part of the D-Bus
185 * message - we prefer to use Big Endian (since it's Network Byte
186 * Order and just easier to read for humans) but if the machine is
187 * Little Endian we use that for performance reasons.
189 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
190 message->byte_order = G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN;
192 /* this could also be G_PDP_ENDIAN */
193 message->byte_order = G_DBUS_MESSAGE_BYTE_ORDER_BIG_ENDIAN;
195 message->headers = g_hash_table_new_full (g_direct_hash,
198 (GDestroyNotify) g_variant_unref);
202 * g_dbus_message_new:
204 * Creates a new empty #GDBusMessage.
206 * Returns: A #GDBusMessage. Free with g_object_unref().
211 g_dbus_message_new (void)
213 return g_object_new (G_TYPE_DBUS_MESSAGE, NULL);
217 * g_dbus_message_new_method_call:
218 * @name: A valid D-Bus name or %NULL.
219 * @path: A valid object path.
220 * @interface_: A valid D-Bus interface name or %NULL.
221 * @method: A valid method name.
223 * Creates a new #GDBusMessage for a method call.
225 * Returns: A #GDBusMessage. Free with g_object_unref().
230 g_dbus_message_new_method_call (const gchar *name,
232 const gchar *interface_,
235 GDBusMessage *message;
237 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
238 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
239 g_return_val_if_fail (g_dbus_is_member_name (method), NULL);
240 g_return_val_if_fail (interface_ == NULL || g_dbus_is_interface_name (interface_), NULL);
242 message = g_dbus_message_new ();
243 message->type = G_DBUS_MESSAGE_TYPE_METHOD_CALL;
246 g_dbus_message_set_destination (message, name);
247 g_dbus_message_set_path (message, path);
248 g_dbus_message_set_member (message, method);
249 if (interface_ != NULL)
250 g_dbus_message_set_interface (message, interface_);
256 * g_dbus_message_new_signal:
257 * @path: A valid object path.
258 * @interface_: A valid D-Bus interface name.
259 * @signal: A valid signal name.
261 * Creates a new #GDBusMessage for a signal emission.
263 * Returns: A #GDBusMessage. Free with g_object_unref().
268 g_dbus_message_new_signal (const gchar *path,
269 const gchar *interface_,
272 GDBusMessage *message;
274 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
275 g_return_val_if_fail (g_dbus_is_member_name (signal), NULL);
276 g_return_val_if_fail (g_dbus_is_interface_name (interface_), NULL);
278 message = g_dbus_message_new ();
279 message->type = G_DBUS_MESSAGE_TYPE_SIGNAL;
280 message->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
282 g_dbus_message_set_path (message, path);
283 g_dbus_message_set_member (message, signal);
284 g_dbus_message_set_interface (message, interface_);
291 * g_dbus_message_new_method_reply:
292 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
293 * create a reply message to.
295 * Creates a new #GDBusMessage that is a reply to @method_call_message.
297 * Returns: (transfer full): #GDBusMessage. Free with g_object_unref().
302 g_dbus_message_new_method_reply (GDBusMessage *method_call_message)
304 GDBusMessage *message;
307 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
308 g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
309 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
311 message = g_dbus_message_new ();
312 message->type = G_DBUS_MESSAGE_TYPE_METHOD_RETURN;
313 message->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
314 /* reply with same endianness */
315 message->byte_order = method_call_message->byte_order;
317 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
318 sender = g_dbus_message_get_sender (method_call_message);
320 g_dbus_message_set_destination (message, sender);
326 * g_dbus_message_new_method_error:
327 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
328 * create a reply message to.
329 * @error_name: A valid D-Bus error name.
330 * @error_message_format: The D-Bus error message in a printf() format.
331 * @...: Arguments for @error_message_format.
333 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
335 * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref().
340 g_dbus_message_new_method_error (GDBusMessage *method_call_message,
341 const gchar *error_name,
342 const gchar *error_message_format,
348 va_start (var_args, error_message_format);
349 ret = g_dbus_message_new_method_error_valist (method_call_message,
351 error_message_format,
359 * g_dbus_message_new_method_error_literal:
360 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
361 * create a reply message to.
362 * @error_name: A valid D-Bus error name.
363 * @error_message: The D-Bus error message.
365 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
367 * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref().
372 g_dbus_message_new_method_error_literal (GDBusMessage *method_call_message,
373 const gchar *error_name,
374 const gchar *error_message)
376 GDBusMessage *message;
379 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
380 g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
381 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
382 g_return_val_if_fail (g_dbus_is_name (error_name), NULL);
383 g_return_val_if_fail (error_message != NULL, NULL);
385 message = g_dbus_message_new ();
386 message->type = G_DBUS_MESSAGE_TYPE_ERROR;
387 message->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
388 /* reply with same endianness */
389 message->byte_order = method_call_message->byte_order;
391 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
392 g_dbus_message_set_error_name (message, error_name);
393 g_dbus_message_set_body (message, g_variant_new ("(s)", error_message));
395 sender = g_dbus_message_get_sender (method_call_message);
397 g_dbus_message_set_destination (message, sender);
403 * g_dbus_message_new_method_error_valist:
404 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
405 * create a reply message to.
406 * @error_name: A valid D-Bus error name.
407 * @error_message_format: The D-Bus error message in a printf() format.
408 * @var_args: Arguments for @error_message_format.
410 * Like g_dbus_message_new_method_error() but intended for language bindings.
412 * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref().
417 g_dbus_message_new_method_error_valist (GDBusMessage *method_call_message,
418 const gchar *error_name,
419 const gchar *error_message_format,
423 gchar *error_message;
424 error_message = g_strdup_vprintf (error_message_format, var_args);
425 ret = g_dbus_message_new_method_error_literal (method_call_message,
428 g_free (error_message);
432 /* ---------------------------------------------------------------------------------------------------- */
435 * g_dbus_message_get_byte_order:
436 * @message: A #GDBusMessage.
438 * Gets the byte order of @message.
440 * Returns: The byte order.
442 GDBusMessageByteOrder
443 g_dbus_message_get_byte_order (GDBusMessage *message)
445 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), (GDBusMessageByteOrder) 0);
446 return message->byte_order;
450 * g_dbus_message_set_byte_order:
451 * @message: A #GDBusMessage.
452 * @byte_order: The byte order.
454 * Sets the byte order of @message.
457 g_dbus_message_set_byte_order (GDBusMessage *message,
458 GDBusMessageByteOrder byte_order)
460 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
464 g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
468 message->byte_order = byte_order;
471 /* ---------------------------------------------------------------------------------------------------- */
473 /* TODO: need GI annotations to specify that any guchar value goes for the type */
476 * g_dbus_message_get_message_type:
477 * @message: A #GDBusMessage.
479 * Gets the type of @message.
481 * Returns: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
486 g_dbus_message_get_message_type (GDBusMessage *message)
488 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_TYPE_INVALID);
489 return message->type;
493 * g_dbus_message_set_message_type:
494 * @message: A #GDBusMessage.
495 * @type: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
497 * Sets @message to be of @type.
502 g_dbus_message_set_message_type (GDBusMessage *message,
503 GDBusMessageType type)
505 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
506 g_return_if_fail (type >=0 && type < 256);
510 g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
514 message->type = type;
517 /* ---------------------------------------------------------------------------------------------------- */
519 /* TODO: need GI annotations to specify that any guchar value goes for flags */
522 * g_dbus_message_get_flags:
523 * @message: A #GDBusMessage.
525 * Gets the flags for @message.
527 * Returns: Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).
532 g_dbus_message_get_flags (GDBusMessage *message)
534 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_FLAGS_NONE);
535 return message->flags;
539 * g_dbus_message_set_flags:
540 * @message: A #GDBusMessage.
541 * @flags: Flags for @message that are set (typically values from the #GDBusMessageFlags
542 * enumeration bitwise ORed together).
544 * Sets the flags to set on @message.
549 g_dbus_message_set_flags (GDBusMessage *message,
550 GDBusMessageFlags flags)
552 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
553 g_return_if_fail (flags >=0 && flags < 256);
557 g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
561 message->flags = flags;
564 /* ---------------------------------------------------------------------------------------------------- */
567 * g_dbus_message_get_serial:
568 * @message: A #GDBusMessage.
570 * Gets the serial for @message.
572 * Returns: A #guint32.
577 g_dbus_message_get_serial (GDBusMessage *message)
579 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
580 return message->serial;
584 * g_dbus_message_set_serial:
585 * @message: A #GDBusMessage.
586 * @serial: A #guint32.
588 * Sets the serial for @message.
593 g_dbus_message_set_serial (GDBusMessage *message,
596 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
600 g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
604 message->serial = serial;
607 /* ---------------------------------------------------------------------------------------------------- */
609 /* TODO: need GI annotations to specify that any guchar value goes for header_field */
612 * g_dbus_message_get_header:
613 * @message: A #GDBusMessage.
614 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
616 * Gets a header field on @message.
618 * Returns: A #GVariant with the value if the header was found, %NULL
619 * otherwise. Do not free, it is owned by @message.
624 g_dbus_message_get_header (GDBusMessage *message,
625 GDBusMessageHeaderField header_field)
627 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
628 g_return_val_if_fail (header_field >=0 && header_field < 256, NULL);
629 return g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
633 * g_dbus_message_set_header:
634 * @message: A #GDBusMessage.
635 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
636 * @value: A #GVariant to set the header field or %NULL to clear the header field.
638 * Sets a header field on @message.
640 * If @value is floating, @message assumes ownership of @value.
645 g_dbus_message_set_header (GDBusMessage *message,
646 GDBusMessageHeaderField header_field,
649 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
650 g_return_if_fail (header_field >=0 && header_field < 256);
654 g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
660 g_hash_table_remove (message->headers, GUINT_TO_POINTER (header_field));
664 g_hash_table_insert (message->headers, GUINT_TO_POINTER (header_field), g_variant_ref_sink (value));
669 * g_dbus_message_get_header_fields:
670 * @message: A #GDBusMessage.
672 * Gets an array of all header fields on @message that are set.
674 * Returns: An array of header fields terminated by
675 * %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a
676 * #guchar. Free with g_free().
681 g_dbus_message_get_header_fields (GDBusMessage *message)
689 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
691 keys = g_hash_table_get_keys (message->headers);
692 num_keys = g_list_length (keys);
693 ret = g_new (guchar, num_keys + 1);
694 for (l = keys, n = 0; l != NULL; l = l->next, n++)
695 ret[n] = GPOINTER_TO_UINT (l->data);
696 g_assert (n == num_keys);
697 ret[n] = G_DBUS_MESSAGE_HEADER_FIELD_INVALID;
703 /* ---------------------------------------------------------------------------------------------------- */
706 * g_dbus_message_get_body:
707 * @message: A #GDBusMessage.
709 * Gets the body of a message.
711 * Returns: A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message.
716 g_dbus_message_get_body (GDBusMessage *message)
718 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
719 return message->body;
723 * g_dbus_message_set_body:
724 * @message: A #GDBusMessage.
725 * @body: Either %NULL or a #GVariant that is a tuple.
727 * Sets the body @message. As a side-effect the
728 * %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the
729 * type string of @body (or cleared if @body is %NULL).
731 * If @body is floating, @message assumes ownership of @body.
736 g_dbus_message_set_body (GDBusMessage *message,
739 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
740 g_return_if_fail ((body == NULL) || g_variant_is_of_type (body, G_VARIANT_TYPE_TUPLE));
744 g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
748 if (message->body != NULL)
749 g_variant_unref (message->body);
752 message->body = NULL;
753 g_dbus_message_set_signature (message, NULL);
757 const gchar *type_string;
758 gsize type_string_len;
761 message->body = g_variant_ref_sink (body);
763 type_string = g_variant_get_type_string (body);
764 type_string_len = strlen (type_string);
765 g_assert (type_string_len >= 2);
766 signature = g_strndup (type_string + 1, type_string_len - 2);
767 g_dbus_message_set_signature (message, signature);
772 /* ---------------------------------------------------------------------------------------------------- */
776 * g_dbus_message_get_unix_fd_list:
777 * @message: A #GDBusMessage.
779 * Gets the UNIX file descriptors associated with @message, if any.
781 * This method is only available on UNIX.
783 * Returns: (transfer none):A #GUnixFDList or %NULL if no file descriptors are
784 * associated. Do not free, this object is owned by @message.
789 g_dbus_message_get_unix_fd_list (GDBusMessage *message)
791 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
792 return message->fd_list;
796 * g_dbus_message_set_unix_fd_list:
797 * @message: A #GDBusMessage.
798 * @fd_list: (allow-none): A #GUnixFDList or %NULL.
800 * Sets the UNIX file descriptors associated with @message. As a
801 * side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header
802 * field is set to the number of fds in @fd_list (or cleared if
803 * @fd_list is %NULL).
805 * This method is only available on UNIX.
810 g_dbus_message_set_unix_fd_list (GDBusMessage *message,
811 GUnixFDList *fd_list)
813 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
814 g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
818 g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
822 if (message->fd_list != NULL)
823 g_object_unref (message->fd_list);
826 message->fd_list = g_object_ref (fd_list);
827 g_dbus_message_set_num_unix_fds (message, g_unix_fd_list_get_length (fd_list));
831 message->fd_list = NULL;
832 g_dbus_message_set_num_unix_fds (message, 0);
837 /* ---------------------------------------------------------------------------------------------------- */
840 validate_headers (GDBusMessage *message,
845 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
846 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
850 switch (message->type)
852 case G_DBUS_MESSAGE_TYPE_INVALID:
853 g_set_error_literal (error,
855 G_IO_ERROR_INVALID_ARGUMENT,
856 _("type is INVALID"));
860 case G_DBUS_MESSAGE_TYPE_METHOD_CALL:
861 if (g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH) == NULL ||
862 g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER) == NULL)
864 g_set_error_literal (error,
866 G_IO_ERROR_INVALID_ARGUMENT,
867 _("METHOD_CALL message: PATH or MEMBER header field is missing"));
872 case G_DBUS_MESSAGE_TYPE_METHOD_RETURN:
873 if (g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL) == NULL)
875 g_set_error_literal (error,
877 G_IO_ERROR_INVALID_ARGUMENT,
878 _("METHOD_RETURN message: REPLY_SERIAL header field is missing"));
883 case G_DBUS_MESSAGE_TYPE_ERROR:
884 if (g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME) == NULL ||
885 g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL) == NULL)
887 g_set_error_literal (error,
889 G_IO_ERROR_INVALID_ARGUMENT,
890 _("ERROR message: REPLY_SERIAL or ERROR_NAME header field is missing"));
895 case G_DBUS_MESSAGE_TYPE_SIGNAL:
896 if (g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH) == NULL ||
897 g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE) == NULL ||
898 g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER) == NULL)
900 g_set_error_literal (error,
902 G_IO_ERROR_INVALID_ARGUMENT,
903 _("SIGNAL message: PATH, INTERFACE or MEMBER header field is missing"));
906 if (g_strcmp0 (g_dbus_message_get_path (message), "/org/freedesktop/DBus/Local") == 0)
908 g_set_error_literal (error,
910 G_IO_ERROR_INVALID_ARGUMENT,
911 _("SIGNAL message: The PATH header field is using the reserved value /org/freedesktop/DBus/Local"));
914 if (g_strcmp0 (g_dbus_message_get_interface (message), "org.freedesktop.DBus.Local") == 0)
916 g_set_error_literal (error,
918 G_IO_ERROR_INVALID_ARGUMENT,
919 _("SIGNAL message: The INTERFACE header field is using the reserved value org.freedesktop.DBus.Local"));
925 /* hitherto unknown type - nothing to check */
932 g_assert (ret || (error == NULL || *error != NULL));
936 /* ---------------------------------------------------------------------------------------------------- */
939 ensure_input_padding (GMemoryInputStream *mis,
946 offset = g_seekable_tell (G_SEEKABLE (mis));
947 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
949 if (offset != wanted_offset)
951 return g_seekable_seek (G_SEEKABLE (mis), wanted_offset, G_SEEK_SET, NULL, error);
960 read_string (GMemoryInputStream *mis,
961 GDataInputStream *dis,
970 const gchar *end_valid;
972 s = g_string_new (NULL);
975 while (remaining > 0)
980 to_read = MIN (remaining, sizeof (buf));
981 num_read = g_input_stream_read (G_INPUT_STREAM (mis),
990 /* G_GSIZE_FORMAT doesn't work with gettext, so we use %lu */
993 G_IO_ERROR_INVALID_ARGUMENT,
994 _("Wanted to read %lu bytes but got EOF"),
999 remaining -= num_read;
1000 g_string_append_len (s, buf, num_read);
1004 nul = g_data_input_stream_read_byte (dis, NULL, &local_error);
1005 if (local_error != NULL)
1007 g_propagate_error (error, local_error);
1010 if (!g_utf8_validate (s->str, -1, &end_valid))
1014 offset = (gint) (end_valid - s->str);
1015 valid_str = g_strndup (s->str, offset);
1018 G_IO_ERROR_INVALID_ARGUMENT,
1019 _("Expected valid UTF-8 string but found invalid bytes at byte offset %d (length of string is %d). "
1020 "The valid UTF-8 string up until that point was `%s'"),
1031 G_IO_ERROR_INVALID_ARGUMENT,
1032 _("Expected NUL byte after the string `%s' but found byte %d"),
1037 return g_string_free (s, FALSE);
1040 g_string_free (s, TRUE);
1044 /* if just_align==TRUE, don't read a value, just align the input stream wrt padding */
1046 /* returns a non-floating GVariant! */
1048 parse_value_from_blob (GMemoryInputStream *mis,
1049 GDataInputStream *dis,
1050 const GVariantType *type,
1051 gboolean just_align,
1056 GError *local_error;
1059 #ifdef DEBUG_SERIALIZER
1063 s = g_variant_type_dup_string (type);
1064 g_print ("%*sReading type %s from offset 0x%04x",
1067 (gint) g_seekable_tell (G_SEEKABLE (mis)));
1070 #endif /* DEBUG_SERIALIZER */
1076 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
1078 if (!ensure_input_padding (mis, 4, &local_error))
1083 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1084 if (local_error != NULL)
1086 ret = g_variant_new_boolean (v);
1089 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1094 v = g_data_input_stream_read_byte (dis, NULL, &local_error);
1095 if (local_error != NULL)
1097 ret = g_variant_new_byte (v);
1100 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
1102 if (!ensure_input_padding (mis, 2, &local_error))
1107 v = g_data_input_stream_read_int16 (dis, NULL, &local_error);
1108 if (local_error != NULL)
1110 ret = g_variant_new_int16 (v);
1113 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
1115 if (!ensure_input_padding (mis, 2, &local_error))
1120 v = g_data_input_stream_read_uint16 (dis, NULL, &local_error);
1121 if (local_error != NULL)
1123 ret = g_variant_new_uint16 (v);
1126 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
1128 if (!ensure_input_padding (mis, 4, &local_error))
1133 v = g_data_input_stream_read_int32 (dis, NULL, &local_error);
1134 if (local_error != NULL)
1136 ret = g_variant_new_int32 (v);
1139 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
1141 if (!ensure_input_padding (mis, 4, &local_error))
1146 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1147 if (local_error != NULL)
1149 ret = g_variant_new_uint32 (v);
1152 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
1154 if (!ensure_input_padding (mis, 8, &local_error))
1159 v = g_data_input_stream_read_int64 (dis, NULL, &local_error);
1160 if (local_error != NULL)
1162 ret = g_variant_new_int64 (v);
1165 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
1167 if (!ensure_input_padding (mis, 8, &local_error))
1172 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
1173 if (local_error != NULL)
1175 ret = g_variant_new_uint64 (v);
1178 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
1180 if (!ensure_input_padding (mis, 8, &local_error))
1186 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
1187 if (local_error != NULL)
1191 G_STATIC_ASSERT (sizeof (gdouble) == sizeof (guint64));
1193 encoded = (gdouble *) &v;
1194 ret = g_variant_new_double (*encoded);
1197 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
1199 if (!ensure_input_padding (mis, 4, &local_error))
1205 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1206 if (local_error != NULL)
1208 v = read_string (mis, dis, (gsize) len, &local_error);
1211 ret = g_variant_new_string (v);
1215 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
1217 if (!ensure_input_padding (mis, 4, &local_error))
1223 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1224 if (local_error != NULL)
1226 v = read_string (mis, dis, (gsize) len, &local_error);
1229 if (!g_variant_is_object_path (v))
1231 g_set_error (&local_error,
1233 G_IO_ERROR_INVALID_ARGUMENT,
1234 _("Parsed value `%s' is not a valid D-Bus object path"),
1239 ret = g_variant_new_object_path (v);
1243 else if (g_variant_type_equal (type, G_VARIANT_TYPE_SIGNATURE))
1249 len = g_data_input_stream_read_byte (dis, NULL, &local_error);
1250 if (local_error != NULL)
1252 v = read_string (mis, dis, (gsize) len, &local_error);
1255 if (!g_variant_is_signature (v))
1257 g_set_error (&local_error,
1259 G_IO_ERROR_INVALID_ARGUMENT,
1260 _("Parsed value `%s' is not a valid D-Bus signature"),
1265 ret = g_variant_new_signature (v);
1269 else if (g_variant_type_equal (type, G_VARIANT_TYPE_HANDLE))
1271 if (!ensure_input_padding (mis, 4, &local_error))
1276 v = g_data_input_stream_read_int32 (dis, NULL, &local_error);
1277 if (local_error != NULL)
1279 ret = g_variant_new_handle (v);
1282 else if (g_variant_type_is_array (type))
1287 const GVariantType *element_type;
1288 GVariantBuilder builder;
1290 if (!ensure_input_padding (mis, 4, &local_error))
1299 array_len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1300 if (local_error != NULL)
1304 #ifdef DEBUG_SERIALIZER
1305 g_print (": array spans 0x%04x bytes\n", array_len);
1306 #endif /* DEBUG_SERIALIZER */
1308 if (array_len > (2<<26))
1310 /* G_GUINT32_FORMAT doesn't work with gettext, so use u */
1311 g_set_error (&local_error,
1313 G_IO_ERROR_INVALID_ARGUMENT,
1314 _("Encountered array of length %u bytes. Maximum length is 2<<26 bytes (64 MiB)."),
1320 g_variant_builder_init (&builder, type);
1321 element_type = g_variant_type_element (type);
1326 item = parse_value_from_blob (mis,
1332 g_assert (item == NULL);
1336 /* TODO: optimize array of primitive types */
1337 offset = g_seekable_tell (G_SEEKABLE (mis));
1338 target = offset + array_len;
1339 while (offset < target)
1342 item = parse_value_from_blob (mis,
1350 g_variant_builder_clear (&builder);
1353 g_variant_builder_add_value (&builder, item);
1354 g_variant_unref (item);
1355 offset = g_seekable_tell (G_SEEKABLE (mis));
1361 ret = g_variant_builder_end (&builder);
1365 g_variant_builder_clear (&builder);
1368 else if (g_variant_type_is_dict_entry (type))
1370 const GVariantType *key_type;
1371 const GVariantType *value_type;
1375 if (!ensure_input_padding (mis, 8, &local_error))
1379 #ifdef DEBUG_SERIALIZER
1381 #endif /* DEBUG_SERIALIZER */
1385 key_type = g_variant_type_key (type);
1386 key = parse_value_from_blob (mis,
1394 value_type = g_variant_type_value (type);
1395 value = parse_value_from_blob (mis,
1403 g_variant_unref (key);
1406 ret = g_variant_new_dict_entry (key, value);
1407 g_variant_unref (key);
1408 g_variant_unref (value);
1411 else if (g_variant_type_is_tuple (type))
1413 if (!ensure_input_padding (mis, 8, &local_error))
1417 #ifdef DEBUG_SERIALIZER
1419 #endif /* DEBUG_SERIALIZER */
1423 const GVariantType *element_type;
1424 GVariantBuilder builder;
1426 g_variant_builder_init (&builder, type);
1427 element_type = g_variant_type_first (type);
1428 while (element_type != NULL)
1431 item = parse_value_from_blob (mis,
1439 g_variant_builder_clear (&builder);
1442 g_variant_builder_add_value (&builder, item);
1443 g_variant_unref (item);
1445 element_type = g_variant_type_next (element_type);
1447 ret = g_variant_builder_end (&builder);
1450 else if (g_variant_type_is_variant (type))
1453 #ifdef DEBUG_SERIALIZER
1455 #endif /* DEBUG_SERIALIZER */
1461 GVariantType *variant_type;
1464 siglen = g_data_input_stream_read_byte (dis, NULL, &local_error);
1465 if (local_error != NULL)
1467 sig = read_string (mis, dis, (gsize) siglen, &local_error);
1470 if (!g_variant_is_signature (sig))
1472 g_set_error (&local_error,
1474 G_IO_ERROR_INVALID_ARGUMENT,
1475 _("Parsed value `%s' for variant is not a valid D-Bus signature"),
1480 variant_type = g_variant_type_new (sig);
1482 value = parse_value_from_blob (mis,
1488 g_variant_type_free (variant_type);
1491 ret = g_variant_new_variant (value);
1492 g_variant_unref (value);
1498 s = g_variant_type_dup_string (type);
1499 g_set_error (&local_error,
1501 G_IO_ERROR_INVALID_ARGUMENT,
1502 _("Error deserializing GVariant with type string `%s' from the D-Bus wire format"),
1508 g_assert ((just_align && ret == NULL) || (!just_align && ret != NULL));
1510 #ifdef DEBUG_SERIALIZER
1516 if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1518 s = g_strdup_printf ("0x%02x '%c'", g_variant_get_byte (ret), g_variant_get_byte (ret));
1522 s = g_variant_print (ret, FALSE);
1524 g_print (": %s\n", s);
1528 #endif /* DEBUG_SERIALIZER */
1530 /* sink the reference */
1533 g_assert (g_variant_is_floating (ret));
1534 g_variant_ref_sink (ret);
1539 #ifdef DEBUG_SERIALIZER
1541 "%*sFAILURE: %s (%s, %d)\n",
1543 local_error->message,
1544 g_quark_to_string (local_error->domain),
1546 #endif /* DEBUG_SERIALIZER */
1547 g_propagate_error (error, local_error);
1551 /* ---------------------------------------------------------------------------------------------------- */
1553 /* message_header must be at least 16 bytes */
1556 * g_dbus_message_bytes_needed:
1557 * @blob: A blob represent a binary D-Bus message.
1558 * @blob_len: The length of @blob (must be at least 16).
1559 * @error: Return location for error or %NULL.
1561 * Utility function to calculate how many bytes are needed to
1562 * completely deserialize the D-Bus message stored at @blob.
1564 * Returns: Number of bytes needed or -1 if @error is set (e.g. if
1565 * @blob contains invalid data or not enough data is available to
1566 * determine the size).
1571 g_dbus_message_bytes_needed (guchar *blob,
1579 g_return_val_if_fail (blob != NULL, -1);
1580 g_return_val_if_fail (error == NULL || *error == NULL, -1);
1581 g_return_val_if_fail (blob_len >= 16, -1);
1585 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1586 ret = 12 + 4 + GUINT32_FROM_LE (((guint32 *) blob)[3]);
1587 /* round up so it's a multiple of 8 */
1588 ret = 8 * ((ret + 7)/8);
1589 /* finally add the body size */
1590 ret += GUINT32_FROM_LE (((guint32 *) blob)[1]);
1592 else if (blob[0] == 'B')
1594 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1595 ret = 12 + 4 + GUINT32_FROM_BE (((guint32 *) blob)[3]);
1596 /* round up so it's a multiple of 8 */
1597 ret = 8 * ((ret + 7)/8);
1598 /* finally add the body size */
1599 ret += GUINT32_FROM_BE (((guint32 *) blob)[1]);
1605 G_IO_ERROR_INVALID_ARGUMENT,
1606 "Unable to determine message blob length - given blob is malformed");
1613 G_IO_ERROR_INVALID_ARGUMENT,
1614 "Blob indicates that message exceeds maximum message length (128MiB)");
1621 /* ---------------------------------------------------------------------------------------------------- */
1624 * g_dbus_message_new_from_blob:
1625 * @blob: A blob represent a binary D-Bus message.
1626 * @blob_len: The length of @blob.
1627 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
1628 * @error: Return location for error or %NULL.
1630 * Creates a new #GDBusMessage from the data stored at @blob. The byte
1631 * order that the message was in can be retrieved using
1632 * g_dbus_message_get_byte_order().
1634 * Returns: A new #GDBusMessage or %NULL if @error is set. Free with
1640 g_dbus_message_new_from_blob (guchar *blob,
1642 GDBusCapabilityFlags capabilities,
1646 GMemoryInputStream *mis;
1647 GDataInputStream *dis;
1648 GDBusMessage *message;
1650 guchar major_protocol_version;
1651 GDataStreamByteOrder byte_order;
1652 guint32 message_body_len;
1656 GVariant *signature;
1658 /* TODO: check against @capabilities */
1662 g_return_val_if_fail (blob != NULL, NULL);
1663 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1664 g_return_val_if_fail (blob_len >= 12, NULL);
1666 message = g_dbus_message_new ();
1668 mis = G_MEMORY_INPUT_STREAM (g_memory_input_stream_new_from_data (blob, blob_len, NULL));
1669 dis = g_data_input_stream_new (G_INPUT_STREAM (mis));
1671 endianness = g_data_input_stream_read_byte (dis, NULL, NULL);
1675 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1676 message->byte_order = G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN;
1679 byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
1680 message->byte_order = G_DBUS_MESSAGE_BYTE_ORDER_BIG_ENDIAN;
1685 G_IO_ERROR_INVALID_ARGUMENT,
1686 _("Invalid endianness value. Expected 0x6c ('l') or 0x42 ('B') but found value 0x%02x"),
1690 g_data_input_stream_set_byte_order (dis, byte_order);
1692 message->type = g_data_input_stream_read_byte (dis, NULL, NULL);
1693 message->flags = g_data_input_stream_read_byte (dis, NULL, NULL);
1694 major_protocol_version = g_data_input_stream_read_byte (dis, NULL, NULL);
1695 if (major_protocol_version != 1)
1699 G_IO_ERROR_INVALID_ARGUMENT,
1700 _("Invalid major protocol version. Expected 1 but found %d"),
1701 major_protocol_version);
1704 message_body_len = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1705 message->serial = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1707 #ifdef DEBUG_SERIALIZER
1708 g_print ("Parsing blob (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1711 s = _g_dbus_hexdump ((const gchar *) blob, blob_len, 2);
1712 g_print ("%s\n", s);
1715 #endif /* DEBUG_SERIALIZER */
1717 #ifdef DEBUG_SERIALIZER
1718 g_print ("Parsing headers (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1719 #endif /* DEBUG_SERIALIZER */
1720 headers = parse_value_from_blob (mis,
1722 G_VARIANT_TYPE ("a{yv}"),
1726 if (headers == NULL)
1728 g_variant_iter_init (&iter, headers);
1729 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1731 guchar header_field;
1733 g_variant_get (item,
1737 g_dbus_message_set_header (message, header_field, value);
1738 g_variant_unref (value);
1739 g_variant_unref (item);
1741 g_variant_unref (headers);
1743 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
1744 if (signature != NULL)
1746 const gchar *signature_str;
1747 gsize signature_str_len;
1749 signature_str = g_variant_get_string (signature, &signature_str_len);
1751 /* signature but no body */
1752 if (message_body_len == 0 && signature_str_len > 0)
1756 G_IO_ERROR_INVALID_ARGUMENT,
1757 _("Signature header with signature `%s' found but message body is empty"),
1761 else if (signature_str_len > 0)
1763 GVariantType *variant_type;
1764 gchar *tupled_signature_str;
1766 if (!g_variant_is_signature (signature_str))
1770 G_IO_ERROR_INVALID_ARGUMENT,
1771 _("Parsed value `%s' is not a valid D-Bus signature (for body)"),
1775 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
1776 variant_type = g_variant_type_new (tupled_signature_str);
1777 g_free (tupled_signature_str);
1778 #ifdef DEBUG_SERIALIZER
1779 g_print ("Parsing body (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1780 #endif /* DEBUG_SERIALIZER */
1781 message->body = parse_value_from_blob (mis,
1787 g_variant_type_free (variant_type);
1788 if (message->body == NULL)
1794 /* no signature, this is only OK if the body is empty */
1795 if (message_body_len != 0)
1797 /* G_GUINT32_FORMAT doesn't work with gettext, just use %u */
1800 G_IO_ERROR_INVALID_ARGUMENT,
1801 _("No signature header in message but the message body is %u bytes"),
1807 if (!validate_headers (message, error))
1809 g_prefix_error (error, _("Cannot deserialize message: "));
1816 g_object_unref (dis);
1817 g_object_unref (mis);
1825 if (message != NULL)
1826 g_object_unref (message);
1831 /* ---------------------------------------------------------------------------------------------------- */
1834 ensure_output_padding (GMemoryOutputStream *mos,
1835 GDataOutputStream *dos,
1839 gsize wanted_offset;
1840 gsize padding_needed;
1843 offset = g_memory_output_stream_get_data_size (mos);
1844 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
1845 padding_needed = wanted_offset - offset;
1847 for (n = 0; n < padding_needed; n++)
1848 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1850 return padding_needed;
1853 /* note that value can be NULL for e.g. empty arrays - type is never NULL */
1855 append_value_to_blob (GVariant *value,
1856 const GVariantType *type,
1857 GMemoryOutputStream *mos,
1858 GDataOutputStream *dos,
1859 gsize *out_padding_added,
1862 gsize padding_added;
1866 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
1868 padding_added = ensure_output_padding (mos, dos, 4);
1871 gboolean v = g_variant_get_boolean (value);
1872 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1875 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1879 guint8 v = g_variant_get_byte (value);
1880 g_data_output_stream_put_byte (dos, v, NULL, NULL);
1883 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
1885 padding_added = ensure_output_padding (mos, dos, 2);
1888 gint16 v = g_variant_get_int16 (value);
1889 g_data_output_stream_put_int16 (dos, v, NULL, NULL);
1892 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
1894 padding_added = ensure_output_padding (mos, dos, 2);
1897 guint16 v = g_variant_get_uint16 (value);
1898 g_data_output_stream_put_uint16 (dos, v, NULL, NULL);
1901 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
1903 padding_added = ensure_output_padding (mos, dos, 4);
1906 gint32 v = g_variant_get_int32 (value);
1907 g_data_output_stream_put_int32 (dos, v, NULL, NULL);
1910 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
1912 padding_added = ensure_output_padding (mos, dos, 4);
1915 guint32 v = g_variant_get_uint32 (value);
1916 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1919 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
1921 padding_added = ensure_output_padding (mos, dos, 8);
1924 gint64 v = g_variant_get_int64 (value);
1925 g_data_output_stream_put_int64 (dos, v, NULL, NULL);
1928 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
1930 padding_added = ensure_output_padding (mos, dos, 8);
1933 guint64 v = g_variant_get_uint64 (value);
1934 g_data_output_stream_put_uint64 (dos, v, NULL, NULL);
1937 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
1939 padding_added = ensure_output_padding (mos, dos, 8);
1943 gdouble v = g_variant_get_double (value);
1944 G_STATIC_ASSERT (sizeof (gdouble) == sizeof (guint64));
1945 encoded = (guint64 *) &v;
1946 g_data_output_stream_put_uint64 (dos, *encoded, NULL, NULL);
1949 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
1951 padding_added = ensure_output_padding (mos, dos, 4);
1957 v = g_variant_get_string (value, &len);
1958 g_assert (g_utf8_validate (v, -1, &end) && (end == v + len));
1959 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1960 g_data_output_stream_put_string (dos, v, NULL, NULL);
1961 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1964 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
1966 padding_added = ensure_output_padding (mos, dos, 4);
1970 const gchar *v = g_variant_get_string (value, &len);
1971 g_assert (g_variant_is_object_path (v));
1972 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1973 g_data_output_stream_put_string (dos, v, NULL, NULL);
1974 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1977 else if (g_variant_type_equal (type, G_VARIANT_TYPE_SIGNATURE))
1982 const gchar *v = g_variant_get_string (value, &len);
1983 g_assert (g_variant_is_signature (v));
1984 g_data_output_stream_put_byte (dos, len, NULL, NULL);
1985 g_data_output_stream_put_string (dos, v, NULL, NULL);
1986 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1989 else if (g_variant_type_equal (type, G_VARIANT_TYPE_HANDLE))
1991 padding_added = ensure_output_padding (mos, dos, 4);
1994 gint32 v = g_variant_get_handle (value);
1995 g_data_output_stream_put_int32 (dos, v, NULL, NULL);
1998 else if (g_variant_type_is_array (type))
2002 goffset array_len_offset;
2003 goffset array_payload_begin_offset;
2007 padding_added = ensure_output_padding (mos, dos, 4);
2010 /* array length - will be filled in later */
2011 array_len_offset = g_memory_output_stream_get_data_size (mos);
2012 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
2014 /* From the D-Bus spec:
2016 * "A UINT32 giving the length of the array data in bytes,
2017 * followed by alignment padding to the alignment boundary of
2018 * the array element type, followed by each array element. The
2019 * array length is from the end of the alignment padding to
2020 * the end of the last element, i.e. it does not include the
2021 * padding after the length, or any padding after the last
2024 * Thus, we need to count how much padding the first element
2025 * contributes and subtract that from the array length.
2027 array_payload_begin_offset = g_memory_output_stream_get_data_size (mos);
2029 if (g_variant_n_children (value) == 0)
2031 gsize padding_added_for_item;
2032 if (!append_value_to_blob (NULL,
2033 g_variant_type_element (type),
2036 &padding_added_for_item,
2039 array_payload_begin_offset += padding_added_for_item;
2045 g_variant_iter_init (&iter, value);
2046 while ((item = g_variant_iter_next_value (&iter)) != NULL)
2048 gsize padding_added_for_item;
2049 if (!append_value_to_blob (item,
2050 g_variant_get_type (item),
2053 &padding_added_for_item,
2056 g_variant_unref (item);
2059 g_variant_unref (item);
2062 array_payload_begin_offset += padding_added_for_item;
2068 cur_offset = g_memory_output_stream_get_data_size (mos);
2070 array_len = cur_offset - array_payload_begin_offset;
2072 if (!g_seekable_seek (G_SEEKABLE (mos), array_len_offset, G_SEEK_SET, NULL, error))
2075 g_data_output_stream_put_uint32 (dos, array_len, NULL, NULL);
2077 if (!g_seekable_seek (G_SEEKABLE (mos), cur_offset, G_SEEK_SET, NULL, error))
2081 else if (g_variant_type_is_dict_entry (type) || g_variant_type_is_tuple (type))
2083 padding_added = ensure_output_padding (mos, dos, 8);
2088 g_variant_iter_init (&iter, value);
2089 while ((item = g_variant_iter_next_value (&iter)) != NULL)
2091 if (!append_value_to_blob (item,
2092 g_variant_get_type (item),
2098 g_variant_unref (item);
2101 g_variant_unref (item);
2105 else if (g_variant_type_is_variant (type))
2110 const gchar *signature;
2111 child = g_variant_get_child_value (value, 0);
2112 signature = g_variant_get_type_string (child);
2113 g_data_output_stream_put_byte (dos, strlen (signature), NULL, NULL);
2114 g_data_output_stream_put_string (dos, signature, NULL, NULL);
2115 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
2116 if (!append_value_to_blob (child,
2117 g_variant_get_type (child),
2123 g_variant_unref (child);
2126 g_variant_unref (child);
2133 G_IO_ERROR_INVALID_ARGUMENT,
2134 _("Error serializing GVariant with type string `%s' to the D-Bus wire format"),
2135 g_variant_get_type_string (value));
2139 if (out_padding_added != NULL)
2140 *out_padding_added = padding_added;
2149 append_body_to_blob (GVariant *value,
2150 GMemoryOutputStream *mos,
2151 GDataOutputStream *dos,
2160 if (!g_variant_is_of_type (value, G_VARIANT_TYPE_TUPLE))
2164 G_IO_ERROR_INVALID_ARGUMENT,
2165 "Expected a tuple for the body of the GDBusMessage.");
2169 g_variant_iter_init (&iter, value);
2170 while ((item = g_variant_iter_next_value (&iter)) != NULL)
2172 if (!append_value_to_blob (item,
2173 g_variant_get_type (item),
2179 g_variant_unref (item);
2182 g_variant_unref (item);
2190 /* ---------------------------------------------------------------------------------------------------- */
2193 * g_dbus_message_to_blob:
2194 * @message: A #GDBusMessage.
2195 * @out_size: Return location for size of generated blob.
2196 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
2197 * @error: Return location for error.
2199 * Serializes @message to a blob. The byte order returned by
2200 * g_dbus_message_get_byte_order() will be used.
2202 * Returns: A pointer to a valid binary D-Bus message of @out_size bytes
2203 * generated by @message or %NULL if @error is set. Free with g_free().
2208 g_dbus_message_to_blob (GDBusMessage *message,
2210 GDBusCapabilityFlags capabilities,
2213 GMemoryOutputStream *mos;
2214 GDataOutputStream *dos;
2217 GDataStreamByteOrder byte_order;
2218 goffset body_len_offset;
2219 goffset body_start_offset;
2221 GVariant *header_fields;
2222 GVariantBuilder builder;
2223 GHashTableIter hash_iter;
2225 GVariant *header_value;
2226 GVariant *signature;
2227 const gchar *signature_str;
2228 gint num_fds_in_message;
2229 gint num_fds_according_to_header;
2231 /* TODO: check against @capabilities */
2235 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2236 g_return_val_if_fail (out_size != NULL, NULL);
2237 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2239 mos = G_MEMORY_OUTPUT_STREAM (g_memory_output_stream_new (NULL, 0, g_realloc, g_free));
2240 dos = g_data_output_stream_new (G_OUTPUT_STREAM (mos));
2242 byte_order = G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN;
2243 switch (message->byte_order)
2245 case G_DBUS_MESSAGE_BYTE_ORDER_BIG_ENDIAN:
2246 byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
2248 case G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN:
2249 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
2252 g_data_output_stream_set_byte_order (dos, byte_order);
2255 g_data_output_stream_put_byte (dos, (guchar) message->byte_order, NULL, NULL);
2256 g_data_output_stream_put_byte (dos, message->type, NULL, NULL);
2257 g_data_output_stream_put_byte (dos, message->flags, NULL, NULL);
2258 g_data_output_stream_put_byte (dos, 1, NULL, NULL); /* major protocol version */
2259 body_len_offset = g_memory_output_stream_get_data_size (mos);
2260 /* body length - will be filled in later */
2261 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
2262 g_data_output_stream_put_uint32 (dos, message->serial, NULL, NULL);
2264 num_fds_in_message = 0;
2266 if (message->fd_list != NULL)
2267 num_fds_in_message = g_unix_fd_list_get_length (message->fd_list);
2269 num_fds_according_to_header = g_dbus_message_get_num_unix_fds (message);
2270 if (num_fds_in_message != num_fds_according_to_header)
2274 G_IO_ERROR_INVALID_ARGUMENT,
2275 _("Message has %d fds but the header field indicates %d fds"),
2277 num_fds_according_to_header);
2281 if (!validate_headers (message, error))
2283 g_prefix_error (error, _("Cannot serialize message: "));
2287 g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{yv}"));
2288 g_hash_table_iter_init (&hash_iter, message->headers);
2289 while (g_hash_table_iter_next (&hash_iter, &key, (gpointer) &header_value))
2291 g_variant_builder_add (&builder,
2293 (guchar) GPOINTER_TO_UINT (key),
2296 header_fields = g_variant_builder_end (&builder);
2298 if (!append_value_to_blob (header_fields,
2299 g_variant_get_type (header_fields),
2304 g_variant_unref (header_fields);
2307 g_variant_unref (header_fields);
2309 /* header size must be a multiple of 8 */
2310 ensure_output_padding (mos, dos, 8);
2312 body_start_offset = g_memory_output_stream_get_data_size (mos);
2314 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2315 signature_str = NULL;
2316 if (signature != NULL)
2317 signature_str = g_variant_get_string (signature, NULL);
2318 if (message->body != NULL)
2320 gchar *tupled_signature_str;
2321 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
2322 if (signature == NULL)
2326 G_IO_ERROR_INVALID_ARGUMENT,
2327 _("Message body has signature `%s' but there is no signature header"),
2329 g_free (tupled_signature_str);
2332 else if (g_strcmp0 (tupled_signature_str, g_variant_get_type_string (message->body)) != 0)
2336 G_IO_ERROR_INVALID_ARGUMENT,
2337 _("Message body has type signature `%s' but signature in the header field is `%s'"),
2338 tupled_signature_str, g_variant_get_type_string (message->body));
2339 g_free (tupled_signature_str);
2342 g_free (tupled_signature_str);
2343 if (!append_body_to_blob (message->body, mos, dos, error))
2348 if (signature != NULL && strlen (signature_str) > 0)
2352 G_IO_ERROR_INVALID_ARGUMENT,
2353 _("Message body is empty but signature in the header field is `(%s)'"),
2359 /* OK, we're done writing the message - set the body length */
2360 size = g_memory_output_stream_get_data_size (mos);
2361 body_size = size - body_start_offset;
2363 if (!g_seekable_seek (G_SEEKABLE (mos), body_len_offset, G_SEEK_SET, NULL, error))
2366 g_data_output_stream_put_uint32 (dos, body_size, NULL, NULL);
2368 if (!g_output_stream_close (G_OUTPUT_STREAM (dos), NULL, error))
2372 ret = g_memory_output_stream_steal_data (mos);
2375 g_object_unref (dos);
2376 g_object_unref (mos);
2381 /* ---------------------------------------------------------------------------------------------------- */
2384 get_uint32_header (GDBusMessage *message,
2385 GDBusMessageHeaderField header_field)
2391 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2392 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_UINT32))
2393 ret = g_variant_get_uint32 (value);
2398 static const gchar *
2399 get_string_header (GDBusMessage *message,
2400 GDBusMessageHeaderField header_field)
2406 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2407 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
2408 ret = g_variant_get_string (value, NULL);
2413 static const gchar *
2414 get_object_path_header (GDBusMessage *message,
2415 GDBusMessageHeaderField header_field)
2421 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2422 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_OBJECT_PATH))
2423 ret = g_variant_get_string (value, NULL);
2428 static const gchar *
2429 get_signature_header (GDBusMessage *message,
2430 GDBusMessageHeaderField header_field)
2436 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2437 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_SIGNATURE))
2438 ret = g_variant_get_string (value, NULL);
2443 /* ---------------------------------------------------------------------------------------------------- */
2446 set_uint32_header (GDBusMessage *message,
2447 GDBusMessageHeaderField header_field,
2450 g_dbus_message_set_header (message,
2452 g_variant_new_uint32 (value));
2456 set_string_header (GDBusMessage *message,
2457 GDBusMessageHeaderField header_field,
2460 g_dbus_message_set_header (message,
2462 value == NULL ? NULL : g_variant_new_string (value));
2466 set_object_path_header (GDBusMessage *message,
2467 GDBusMessageHeaderField header_field,
2470 g_dbus_message_set_header (message,
2472 value == NULL ? NULL : g_variant_new_object_path (value));
2476 set_signature_header (GDBusMessage *message,
2477 GDBusMessageHeaderField header_field,
2480 g_dbus_message_set_header (message,
2482 value == NULL ? NULL : g_variant_new_signature (value));
2485 /* ---------------------------------------------------------------------------------------------------- */
2488 * g_dbus_message_get_reply_serial:
2489 * @message: A #GDBusMessage.
2491 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2493 * Returns: The value.
2498 g_dbus_message_get_reply_serial (GDBusMessage *message)
2500 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2501 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL);
2505 * g_dbus_message_set_reply_serial:
2506 * @message: A #GDBusMessage.
2507 * @value: The value to set.
2509 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2514 g_dbus_message_set_reply_serial (GDBusMessage *message,
2517 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2518 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL, value);
2521 /* ---------------------------------------------------------------------------------------------------- */
2524 * g_dbus_message_get_interface:
2525 * @message: A #GDBusMessage.
2527 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2529 * Returns: The value.
2534 g_dbus_message_get_interface (GDBusMessage *message)
2536 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2537 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE);
2541 * g_dbus_message_set_interface:
2542 * @message: A #GDBusMessage.
2543 * @value: The value to set.
2545 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2550 g_dbus_message_set_interface (GDBusMessage *message,
2553 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2554 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2555 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE, value);
2558 /* ---------------------------------------------------------------------------------------------------- */
2561 * g_dbus_message_get_member:
2562 * @message: A #GDBusMessage.
2564 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2566 * Returns: The value.
2571 g_dbus_message_get_member (GDBusMessage *message)
2573 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2574 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER);
2578 * g_dbus_message_set_member:
2579 * @message: A #GDBusMessage.
2580 * @value: The value to set.
2582 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2587 g_dbus_message_set_member (GDBusMessage *message,
2590 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2591 g_return_if_fail (value == NULL || g_dbus_is_member_name (value));
2592 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER, value);
2595 /* ---------------------------------------------------------------------------------------------------- */
2598 * g_dbus_message_get_path:
2599 * @message: A #GDBusMessage.
2601 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2603 * Returns: The value.
2608 g_dbus_message_get_path (GDBusMessage *message)
2610 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2611 return get_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH);
2615 * g_dbus_message_set_path:
2616 * @message: A #GDBusMessage.
2617 * @value: The value to set.
2619 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2624 g_dbus_message_set_path (GDBusMessage *message,
2627 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2628 g_return_if_fail (value == NULL || g_variant_is_object_path (value));
2629 set_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH, value);
2632 /* ---------------------------------------------------------------------------------------------------- */
2635 * g_dbus_message_get_sender:
2636 * @message: A #GDBusMessage.
2638 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2640 * Returns: The value.
2645 g_dbus_message_get_sender (GDBusMessage *message)
2647 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2648 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER);
2652 * g_dbus_message_set_sender:
2653 * @message: A #GDBusMessage.
2654 * @value: The value to set.
2656 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2661 g_dbus_message_set_sender (GDBusMessage *message,
2664 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2665 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2666 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER, value);
2669 /* ---------------------------------------------------------------------------------------------------- */
2672 * g_dbus_message_get_destination:
2673 * @message: A #GDBusMessage.
2675 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2677 * Returns: The value.
2682 g_dbus_message_get_destination (GDBusMessage *message)
2684 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2685 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION);
2689 * g_dbus_message_set_destination:
2690 * @message: A #GDBusMessage.
2691 * @value: The value to set.
2693 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2698 g_dbus_message_set_destination (GDBusMessage *message,
2701 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2702 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2703 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION, value);
2706 /* ---------------------------------------------------------------------------------------------------- */
2709 * g_dbus_message_get_error_name:
2710 * @message: A #GDBusMessage.
2712 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2714 * Returns: The value.
2719 g_dbus_message_get_error_name (GDBusMessage *message)
2721 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2722 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME);
2726 * g_dbus_message_set_error_name:
2727 * @message: A #GDBusMessage.
2728 * @value: The value to set.
2730 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2735 g_dbus_message_set_error_name (GDBusMessage *message,
2738 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2739 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2740 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME, value);
2743 /* ---------------------------------------------------------------------------------------------------- */
2746 * g_dbus_message_get_signature:
2747 * @message: A #GDBusMessage.
2749 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2751 * Returns: The value.
2756 g_dbus_message_get_signature (GDBusMessage *message)
2759 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2760 ret = get_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2767 * g_dbus_message_set_signature:
2768 * @message: A #GDBusMessage.
2769 * @value: The value to set.
2771 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2776 g_dbus_message_set_signature (GDBusMessage *message,
2779 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2780 g_return_if_fail (value == NULL || g_variant_is_signature (value));
2781 set_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE, value);
2784 /* ---------------------------------------------------------------------------------------------------- */
2787 * g_dbus_message_get_arg0:
2788 * @message: A #GDBusMessage.
2790 * Convenience to get the first item in the body of @message.
2792 * Returns: The string item or %NULL if the first item in the body of
2793 * @message is not a string.
2798 g_dbus_message_get_arg0 (GDBusMessage *message)
2802 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2806 if (message->body != NULL && g_variant_is_of_type (message->body, G_VARIANT_TYPE_TUPLE))
2809 item = g_variant_get_child_value (message->body, 0);
2810 if (g_variant_is_of_type (item, G_VARIANT_TYPE_STRING))
2811 ret = g_variant_get_string (item, NULL);
2812 g_variant_unref (item);
2818 /* ---------------------------------------------------------------------------------------------------- */
2821 * g_dbus_message_get_num_unix_fds:
2822 * @message: A #GDBusMessage.
2824 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2826 * Returns: The value.
2831 g_dbus_message_get_num_unix_fds (GDBusMessage *message)
2833 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2834 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS);
2838 * g_dbus_message_set_num_unix_fds:
2839 * @message: A #GDBusMessage.
2840 * @value: The value to set.
2842 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2847 g_dbus_message_set_num_unix_fds (GDBusMessage *message,
2850 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2851 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS, value);
2854 /* ---------------------------------------------------------------------------------------------------- */
2857 * g_dbus_message_to_gerror:
2858 * @message: A #GDBusMessage.
2859 * @error: The #GError to set.
2861 * If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does
2862 * nothing and returns %FALSE.
2864 * Otherwise this method encodes the error in @message as a #GError
2865 * using g_dbus_error_set_dbus_error() using the information in the
2866 * %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of @message as
2867 * well as the first string item in @message's body.
2869 * Returns: %TRUE if @error was set, %FALSE otherwise.
2874 g_dbus_message_to_gerror (GDBusMessage *message,
2878 const gchar *error_name;
2880 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2883 if (message->type != G_DBUS_MESSAGE_TYPE_ERROR)
2886 error_name = g_dbus_message_get_error_name (message);
2887 if (error_name != NULL)
2891 body = g_dbus_message_get_body (message);
2893 if (body != NULL && g_variant_is_of_type (body, G_VARIANT_TYPE ("(s)")))
2895 const gchar *error_message;
2896 g_variant_get (body, "(&s)", &error_message);
2897 g_dbus_error_set_dbus_error (error,
2904 /* these two situations are valid, yet pretty rare */
2907 g_dbus_error_set_dbus_error (error,
2910 _("Error return with body of type `%s'"),
2911 g_variant_get_type_string (body));
2915 g_dbus_error_set_dbus_error (error,
2918 _("Error return with empty body"));
2924 /* TOOD: this shouldn't happen - should check this at message serialization
2925 * time and disconnect the peer.
2930 "Error return without error-name header!");
2939 /* ---------------------------------------------------------------------------------------------------- */
2942 flags_to_string (GType flags_type, guint value)
2948 klass = g_type_class_ref (flags_type);
2949 s = g_string_new (NULL);
2950 for (n = 0; n < 32; n++)
2952 if ((value & (1<<n)) != 0)
2954 GFlagsValue *flags_value;
2955 flags_value = g_flags_get_first_value (klass, (1<<n));
2957 g_string_append_c (s, ',');
2958 if (flags_value != NULL)
2959 g_string_append (s, flags_value->value_nick);
2961 g_string_append_printf (s, "unknown (bit %d)", n);
2965 g_string_append (s, "none");
2966 g_type_class_unref (klass);
2967 return g_string_free (s, FALSE);
2971 _sort_keys_func (gconstpointer a,
2977 ia = GPOINTER_TO_INT (a);
2978 ib = GPOINTER_TO_INT (b);
2984 * g_dbus_message_print:
2985 * @message: A #GDBusMessage.
2986 * @indent: Indentation level.
2988 * Produces a human-readable multi-line description of @message.
2990 * The contents of the description has no ABI guarantees, the contents
2991 * and formatting is subject to change at any time. Typical output
2992 * looks something like this:
2999 * path -> objectpath '/org/gtk/GDBus/TestObject'
3000 * interface -> 'org.gtk.GDBus.TestInterface'
3001 * member -> 'GimmeStdout'
3002 * destination -> ':1.146'
3004 * UNIX File Descriptors:
3009 * Type: method-return
3010 * Flags: no-reply-expected
3014 * reply-serial -> uint32 4
3015 * destination -> ':1.159'
3016 * sender -> ':1.146'
3017 * num-unix-fds -> uint32 1
3019 * UNIX File Descriptors:
3020 * fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635
3023 * Returns: A string that should be freed with g_free().
3028 g_dbus_message_print (GDBusMessage *message,
3036 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
3038 str = g_string_new (NULL);
3040 s = _g_dbus_enum_to_string (G_TYPE_DBUS_MESSAGE_TYPE, message->type);
3041 g_string_append_printf (str, "%*sType: %s\n", indent, "", s);
3043 s = flags_to_string (G_TYPE_DBUS_MESSAGE_FLAGS, message->flags);
3044 g_string_append_printf (str, "%*sFlags: %s\n", indent, "", s);
3046 g_string_append_printf (str, "%*sVersion: %d\n", indent, "", message->major_protocol_version);
3047 g_string_append_printf (str, "%*sSerial: %d\n", indent, "", message->serial);
3049 g_string_append_printf (str, "%*sHeaders:\n", indent, "");
3050 keys = g_hash_table_get_keys (message->headers);
3051 keys = g_list_sort (keys, _sort_keys_func);
3054 for (l = keys; l != NULL; l = l->next)
3056 gint key = GPOINTER_TO_INT (l->data);
3060 value = g_hash_table_lookup (message->headers, l->data);
3061 g_assert (value != NULL);
3063 s = _g_dbus_enum_to_string (G_TYPE_DBUS_MESSAGE_HEADER_FIELD, key);
3064 value_str = g_variant_print (value, TRUE);
3065 g_string_append_printf (str, "%*s %s -> %s\n", indent, "", s, value_str);
3072 g_string_append_printf (str, "%*s (none)\n", indent, "");
3074 g_string_append_printf (str, "%*sBody: ", indent, "");
3075 if (message->body != NULL)
3077 g_variant_print_string (message->body,
3083 g_string_append (str, "()");
3085 g_string_append (str, "\n");
3087 g_string_append_printf (str, "%*sUNIX File Descriptors:\n", indent, "");
3088 if (message->fd_list != NULL)
3094 fds = g_unix_fd_list_peek_fds (message->fd_list, &num_fds);
3097 for (n = 0; n < num_fds; n++)
3100 struct stat statbuf;
3101 fs = g_string_new (NULL);
3102 if (fstat (fds[n], &statbuf) == 0)
3104 g_string_append_printf (fs, "%s" "dev=%d:%d", fs->len > 0 ? "," : "",
3105 major (statbuf.st_dev), minor (statbuf.st_dev));
3106 g_string_append_printf (fs, "%s" "mode=0%o", fs->len > 0 ? "," : "",
3108 g_string_append_printf (fs, "%s" "ino=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3109 (guint64) statbuf.st_ino);
3110 g_string_append_printf (fs, "%s" "uid=%d", fs->len > 0 ? "," : "",
3112 g_string_append_printf (fs, "%s" "gid=%d", fs->len > 0 ? "," : "",
3114 g_string_append_printf (fs, "%s" "rdev=%d:%d", fs->len > 0 ? "," : "",
3115 major (statbuf.st_rdev), minor (statbuf.st_rdev));
3116 g_string_append_printf (fs, "%s" "size=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3117 (guint64) statbuf.st_size);
3118 g_string_append_printf (fs, "%s" "atime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3119 (guint64) statbuf.st_atime);
3120 g_string_append_printf (fs, "%s" "mtime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3121 (guint64) statbuf.st_mtime);
3122 g_string_append_printf (fs, "%s" "ctime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3123 (guint64) statbuf.st_ctime);
3127 g_string_append_printf (fs, "(fstat failed: %s)", strerror (errno));
3129 g_string_append_printf (str, "%*s fd %d: %s\n", indent, "", fds[n], fs->str);
3130 g_string_free (fs, TRUE);
3135 g_string_append_printf (str, "%*s (empty)\n", indent, "");
3140 g_string_append_printf (str, "%*s (none)\n", indent, "");
3144 return g_string_free (str, FALSE);
3148 * g_dbus_message_get_locked:
3149 * @message: A #GDBusMessage.
3151 * Checks whether @message is locked. To monitor changes to this
3152 * value, conncet to the #GObject::notify signal to listen for changes
3153 * on the #GDBusMessage:locked property.
3155 * Returns: %TRUE if @message is locked, %FALSE otherwise.
3160 g_dbus_message_get_locked (GDBusMessage *message)
3162 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
3163 return message->locked;
3167 * g_dbus_message_lock:
3168 * @message: A #GDBusMessage.
3170 * If @message is locked, does nothing. Otherwise locks the message.
3175 g_dbus_message_lock (GDBusMessage *message)
3177 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
3179 if (message->locked)
3182 message->locked = TRUE;
3183 g_object_notify (G_OBJECT (message), "locked");
3190 * g_dbus_message_copy:
3191 * @message: A #GDBusMessage.
3192 * @error: Return location for error or %NULL.
3194 * Copies @message. The copy is a deep copy and the returned
3195 * #GDBusMessage is completely identical except that it is guaranteed
3198 * This operation can fail if e.g. @message contains file descriptors
3199 * and the per-process or system-wide open files limit is reached.
3201 * Returns: (transfer full): A new #GDBusMessage or %NULL if @error is set. Free with
3207 g_dbus_message_copy (GDBusMessage *message,
3211 GHashTableIter iter;
3212 gpointer header_key;
3213 GVariant *header_value;
3215 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
3216 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
3218 ret = g_dbus_message_new ();
3219 ret->type = message->type;
3220 ret->flags = message->flags;
3221 ret->byte_order = message->byte_order;
3222 ret->major_protocol_version = message->major_protocol_version;
3223 ret->serial = message->serial;
3226 if (message->fd_list != NULL)
3232 ret->fd_list = g_unix_fd_list_new ();
3233 fds = g_unix_fd_list_peek_fds (message->fd_list, &num_fds);
3234 for (n = 0; n < num_fds; n++)
3236 if (g_unix_fd_list_append (ret->fd_list,
3240 g_object_unref (ret);
3248 /* see https://bugzilla.gnome.org/show_bug.cgi?id=624546#c8 for why it's fine
3249 * to just ref (as opposed to deep-copying) the GVariant instances
3251 ret->body = message->body != NULL ? g_variant_ref (message->body) : NULL;
3252 g_hash_table_iter_init (&iter, message->headers);
3253 while (g_hash_table_iter_next (&iter, &header_key, (gpointer) &header_value))
3254 g_hash_table_insert (ret->headers, header_key, g_variant_ref (header_value));