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>
32 #ifdef HAVE_SYS_MKDEV_H
33 #include <sys/mkdev.h>
39 #include "gdbusutils.h"
40 #include "gdbusmessage.h"
41 #include "gdbuserror.h"
42 #include "gioenumtypes.h"
43 #include "ginputstream.h"
44 #include "gdatainputstream.h"
45 #include "gmemoryinputstream.h"
46 #include "goutputstream.h"
47 #include "gdataoutputstream.h"
48 #include "gmemoryoutputstream.h"
49 #include "gseekable.h"
51 #include "gdbusprivate.h"
54 #include "gunixfdlist.h"
60 * SECTION:gdbusmessage
61 * @short_description: D-Bus Message
64 * A type for representing D-Bus messages that can be sent or received
65 * on a #GDBusConnection.
68 typedef struct _GDBusMessageClass GDBusMessageClass;
73 * Class structure for #GDBusMessage.
77 struct _GDBusMessageClass
80 GObjectClass parent_class;
86 * The #GDBusMessage structure contains only private data and should
87 * only be accessed using the provided API.
94 GObject parent_instance;
96 GDBusMessageType type;
97 GDBusMessageFlags flags;
99 GDBusMessageByteOrder byte_order;
100 guchar major_protocol_version;
105 GUnixFDList *fd_list;
115 G_DEFINE_TYPE (GDBusMessage, g_dbus_message, G_TYPE_OBJECT);
118 g_dbus_message_finalize (GObject *object)
120 GDBusMessage *message = G_DBUS_MESSAGE (object);
122 if (message->headers != NULL)
123 g_hash_table_unref (message->headers);
124 if (message->body != NULL)
125 g_variant_unref (message->body);
127 if (message->fd_list != NULL)
128 g_object_unref (message->fd_list);
131 if (G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize != NULL)
132 G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize (object);
136 g_dbus_message_get_property (GObject *object,
141 GDBusMessage *message = G_DBUS_MESSAGE (object);
146 g_value_set_boolean (value, g_dbus_message_get_locked (message));
150 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
156 g_dbus_message_class_init (GDBusMessageClass *klass)
158 GObjectClass *gobject_class;
160 gobject_class = G_OBJECT_CLASS (klass);
161 gobject_class->finalize = g_dbus_message_finalize;
162 gobject_class->get_property = g_dbus_message_get_property;
165 * GDBusConnection:locked:
167 * A boolean specifying whether the message is locked.
171 g_object_class_install_property (gobject_class,
173 g_param_spec_boolean ("locked",
175 P_("Whether the message is locked"),
178 G_PARAM_STATIC_NAME |
179 G_PARAM_STATIC_BLURB |
180 G_PARAM_STATIC_NICK));
184 g_dbus_message_init (GDBusMessage *message)
186 /* Any D-Bus implementation is supposed to handle both Big and
187 * Little Endian encodings and the Endianness is part of the D-Bus
188 * message - we prefer to use Big Endian (since it's Network Byte
189 * Order and just easier to read for humans) but if the machine is
190 * Little Endian we use that for performance reasons.
192 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
193 message->byte_order = G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN;
195 /* this could also be G_PDP_ENDIAN */
196 message->byte_order = G_DBUS_MESSAGE_BYTE_ORDER_BIG_ENDIAN;
198 message->headers = g_hash_table_new_full (g_direct_hash,
201 (GDestroyNotify) g_variant_unref);
205 * g_dbus_message_new:
207 * Creates a new empty #GDBusMessage.
209 * Returns: A #GDBusMessage. Free with g_object_unref().
214 g_dbus_message_new (void)
216 return g_object_new (G_TYPE_DBUS_MESSAGE, NULL);
220 * g_dbus_message_new_method_call:
221 * @name: A valid D-Bus name or %NULL.
222 * @path: A valid object path.
223 * @interface_: A valid D-Bus interface name or %NULL.
224 * @method: A valid method name.
226 * Creates a new #GDBusMessage for a method call.
228 * Returns: A #GDBusMessage. Free with g_object_unref().
233 g_dbus_message_new_method_call (const gchar *name,
235 const gchar *interface_,
238 GDBusMessage *message;
240 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
241 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
242 g_return_val_if_fail (g_dbus_is_member_name (method), NULL);
243 g_return_val_if_fail (interface_ == NULL || g_dbus_is_interface_name (interface_), NULL);
245 message = g_dbus_message_new ();
246 message->type = G_DBUS_MESSAGE_TYPE_METHOD_CALL;
249 g_dbus_message_set_destination (message, name);
250 g_dbus_message_set_path (message, path);
251 g_dbus_message_set_member (message, method);
252 if (interface_ != NULL)
253 g_dbus_message_set_interface (message, interface_);
259 * g_dbus_message_new_signal:
260 * @path: A valid object path.
261 * @interface_: A valid D-Bus interface name.
262 * @signal: A valid signal name.
264 * Creates a new #GDBusMessage for a signal emission.
266 * Returns: A #GDBusMessage. Free with g_object_unref().
271 g_dbus_message_new_signal (const gchar *path,
272 const gchar *interface_,
275 GDBusMessage *message;
277 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
278 g_return_val_if_fail (g_dbus_is_member_name (signal), NULL);
279 g_return_val_if_fail (g_dbus_is_interface_name (interface_), NULL);
281 message = g_dbus_message_new ();
282 message->type = G_DBUS_MESSAGE_TYPE_SIGNAL;
283 message->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
285 g_dbus_message_set_path (message, path);
286 g_dbus_message_set_member (message, signal);
287 g_dbus_message_set_interface (message, interface_);
294 * g_dbus_message_new_method_reply:
295 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
296 * create a reply message to.
298 * Creates a new #GDBusMessage that is a reply to @method_call_message.
300 * Returns: (transfer full): #GDBusMessage. Free with g_object_unref().
305 g_dbus_message_new_method_reply (GDBusMessage *method_call_message)
307 GDBusMessage *message;
310 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
311 g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
312 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
314 message = g_dbus_message_new ();
315 message->type = G_DBUS_MESSAGE_TYPE_METHOD_RETURN;
316 message->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
317 /* reply with same endianness */
318 message->byte_order = method_call_message->byte_order;
320 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
321 sender = g_dbus_message_get_sender (method_call_message);
323 g_dbus_message_set_destination (message, sender);
329 * g_dbus_message_new_method_error:
330 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
331 * create a reply message to.
332 * @error_name: A valid D-Bus error name.
333 * @error_message_format: The D-Bus error message in a printf() format.
334 * @...: Arguments for @error_message_format.
336 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
338 * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref().
343 g_dbus_message_new_method_error (GDBusMessage *method_call_message,
344 const gchar *error_name,
345 const gchar *error_message_format,
351 va_start (var_args, error_message_format);
352 ret = g_dbus_message_new_method_error_valist (method_call_message,
354 error_message_format,
362 * g_dbus_message_new_method_error_literal:
363 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
364 * create a reply message to.
365 * @error_name: A valid D-Bus error name.
366 * @error_message: The D-Bus error message.
368 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
370 * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref().
375 g_dbus_message_new_method_error_literal (GDBusMessage *method_call_message,
376 const gchar *error_name,
377 const gchar *error_message)
379 GDBusMessage *message;
382 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
383 g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
384 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
385 g_return_val_if_fail (g_dbus_is_name (error_name), NULL);
386 g_return_val_if_fail (error_message != NULL, NULL);
388 message = g_dbus_message_new ();
389 message->type = G_DBUS_MESSAGE_TYPE_ERROR;
390 message->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
391 /* reply with same endianness */
392 message->byte_order = method_call_message->byte_order;
394 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
395 g_dbus_message_set_error_name (message, error_name);
396 g_dbus_message_set_body (message, g_variant_new ("(s)", error_message));
398 sender = g_dbus_message_get_sender (method_call_message);
400 g_dbus_message_set_destination (message, sender);
406 * g_dbus_message_new_method_error_valist:
407 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
408 * create a reply message to.
409 * @error_name: A valid D-Bus error name.
410 * @error_message_format: The D-Bus error message in a printf() format.
411 * @var_args: Arguments for @error_message_format.
413 * Like g_dbus_message_new_method_error() but intended for language bindings.
415 * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref().
420 g_dbus_message_new_method_error_valist (GDBusMessage *method_call_message,
421 const gchar *error_name,
422 const gchar *error_message_format,
426 gchar *error_message;
427 error_message = g_strdup_vprintf (error_message_format, var_args);
428 ret = g_dbus_message_new_method_error_literal (method_call_message,
431 g_free (error_message);
435 /* ---------------------------------------------------------------------------------------------------- */
438 * g_dbus_message_get_byte_order:
439 * @message: A #GDBusMessage.
441 * Gets the byte order of @message.
443 * Returns: The byte order.
445 GDBusMessageByteOrder
446 g_dbus_message_get_byte_order (GDBusMessage *message)
448 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), (GDBusMessageByteOrder) 0);
449 return message->byte_order;
453 * g_dbus_message_set_byte_order:
454 * @message: A #GDBusMessage.
455 * @byte_order: The byte order.
457 * Sets the byte order of @message.
460 g_dbus_message_set_byte_order (GDBusMessage *message,
461 GDBusMessageByteOrder byte_order)
463 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
467 g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
471 message->byte_order = byte_order;
474 /* ---------------------------------------------------------------------------------------------------- */
476 /* TODO: need GI annotations to specify that any guchar value goes for the type */
479 * g_dbus_message_get_message_type:
480 * @message: A #GDBusMessage.
482 * Gets the type of @message.
484 * Returns: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
489 g_dbus_message_get_message_type (GDBusMessage *message)
491 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_TYPE_INVALID);
492 return message->type;
496 * g_dbus_message_set_message_type:
497 * @message: A #GDBusMessage.
498 * @type: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
500 * Sets @message to be of @type.
505 g_dbus_message_set_message_type (GDBusMessage *message,
506 GDBusMessageType type)
508 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
509 g_return_if_fail (type >=0 && type < 256);
513 g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
517 message->type = type;
520 /* ---------------------------------------------------------------------------------------------------- */
522 /* TODO: need GI annotations to specify that any guchar value goes for flags */
525 * g_dbus_message_get_flags:
526 * @message: A #GDBusMessage.
528 * Gets the flags for @message.
530 * Returns: Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).
535 g_dbus_message_get_flags (GDBusMessage *message)
537 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_FLAGS_NONE);
538 return message->flags;
542 * g_dbus_message_set_flags:
543 * @message: A #GDBusMessage.
544 * @flags: Flags for @message that are set (typically values from the #GDBusMessageFlags
545 * enumeration bitwise ORed together).
547 * Sets the flags to set on @message.
552 g_dbus_message_set_flags (GDBusMessage *message,
553 GDBusMessageFlags flags)
555 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
556 g_return_if_fail (flags >=0 && flags < 256);
560 g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
564 message->flags = flags;
567 /* ---------------------------------------------------------------------------------------------------- */
570 * g_dbus_message_get_serial:
571 * @message: A #GDBusMessage.
573 * Gets the serial for @message.
575 * Returns: A #guint32.
580 g_dbus_message_get_serial (GDBusMessage *message)
582 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
583 return message->serial;
587 * g_dbus_message_set_serial:
588 * @message: A #GDBusMessage.
589 * @serial: A #guint32.
591 * Sets the serial for @message.
596 g_dbus_message_set_serial (GDBusMessage *message,
599 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
603 g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
607 message->serial = serial;
610 /* ---------------------------------------------------------------------------------------------------- */
612 /* TODO: need GI annotations to specify that any guchar value goes for header_field */
615 * g_dbus_message_get_header:
616 * @message: A #GDBusMessage.
617 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
619 * Gets a header field on @message.
621 * Returns: A #GVariant with the value if the header was found, %NULL
622 * otherwise. Do not free, it is owned by @message.
627 g_dbus_message_get_header (GDBusMessage *message,
628 GDBusMessageHeaderField header_field)
630 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
631 g_return_val_if_fail (header_field >=0 && header_field < 256, NULL);
632 return g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
636 * g_dbus_message_set_header:
637 * @message: A #GDBusMessage.
638 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
639 * @value: A #GVariant to set the header field or %NULL to clear the header field.
641 * Sets a header field on @message.
643 * If @value is floating, @message assumes ownership of @value.
648 g_dbus_message_set_header (GDBusMessage *message,
649 GDBusMessageHeaderField header_field,
652 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
653 g_return_if_fail (header_field >=0 && header_field < 256);
657 g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
663 g_hash_table_remove (message->headers, GUINT_TO_POINTER (header_field));
667 g_hash_table_insert (message->headers, GUINT_TO_POINTER (header_field), g_variant_ref_sink (value));
672 * g_dbus_message_get_header_fields:
673 * @message: A #GDBusMessage.
675 * Gets an array of all header fields on @message that are set.
677 * Returns: An array of header fields terminated by
678 * %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a
679 * #guchar. Free with g_free().
684 g_dbus_message_get_header_fields (GDBusMessage *message)
692 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
694 keys = g_hash_table_get_keys (message->headers);
695 num_keys = g_list_length (keys);
696 ret = g_new (guchar, num_keys + 1);
697 for (l = keys, n = 0; l != NULL; l = l->next, n++)
698 ret[n] = GPOINTER_TO_UINT (l->data);
699 g_assert (n == num_keys);
700 ret[n] = G_DBUS_MESSAGE_HEADER_FIELD_INVALID;
706 /* ---------------------------------------------------------------------------------------------------- */
709 * g_dbus_message_get_body:
710 * @message: A #GDBusMessage.
712 * Gets the body of a message.
714 * Returns: A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message.
719 g_dbus_message_get_body (GDBusMessage *message)
721 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
722 return message->body;
726 * g_dbus_message_set_body:
727 * @message: A #GDBusMessage.
728 * @body: Either %NULL or a #GVariant that is a tuple.
730 * Sets the body @message. As a side-effect the
731 * %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the
732 * type string of @body (or cleared if @body is %NULL).
734 * If @body is floating, @message assumes ownership of @body.
739 g_dbus_message_set_body (GDBusMessage *message,
742 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
743 g_return_if_fail ((body == NULL) || g_variant_is_of_type (body, G_VARIANT_TYPE_TUPLE));
747 g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
751 if (message->body != NULL)
752 g_variant_unref (message->body);
755 message->body = NULL;
756 g_dbus_message_set_signature (message, NULL);
760 const gchar *type_string;
761 gsize type_string_len;
764 message->body = g_variant_ref_sink (body);
766 type_string = g_variant_get_type_string (body);
767 type_string_len = strlen (type_string);
768 g_assert (type_string_len >= 2);
769 signature = g_strndup (type_string + 1, type_string_len - 2);
770 g_dbus_message_set_signature (message, signature);
775 /* ---------------------------------------------------------------------------------------------------- */
779 * g_dbus_message_get_unix_fd_list:
780 * @message: A #GDBusMessage.
782 * Gets the UNIX file descriptors associated with @message, if any.
784 * This method is only available on UNIX.
786 * Returns: (transfer none):A #GUnixFDList or %NULL if no file descriptors are
787 * associated. Do not free, this object is owned by @message.
792 g_dbus_message_get_unix_fd_list (GDBusMessage *message)
794 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
795 return message->fd_list;
799 * g_dbus_message_set_unix_fd_list:
800 * @message: A #GDBusMessage.
801 * @fd_list: (allow-none): A #GUnixFDList or %NULL.
803 * Sets the UNIX file descriptors associated with @message. As a
804 * side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header
805 * field is set to the number of fds in @fd_list (or cleared if
806 * @fd_list is %NULL).
808 * This method is only available on UNIX.
813 g_dbus_message_set_unix_fd_list (GDBusMessage *message,
814 GUnixFDList *fd_list)
816 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
817 g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
821 g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
825 if (message->fd_list != NULL)
826 g_object_unref (message->fd_list);
829 message->fd_list = g_object_ref (fd_list);
830 g_dbus_message_set_num_unix_fds (message, g_unix_fd_list_get_length (fd_list));
834 message->fd_list = NULL;
835 g_dbus_message_set_num_unix_fds (message, 0);
840 /* ---------------------------------------------------------------------------------------------------- */
843 validate_headers (GDBusMessage *message,
848 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
849 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
853 switch (message->type)
855 case G_DBUS_MESSAGE_TYPE_INVALID:
856 g_set_error_literal (error,
858 G_IO_ERROR_INVALID_ARGUMENT,
859 _("type is INVALID"));
863 case G_DBUS_MESSAGE_TYPE_METHOD_CALL:
864 if (g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH) == NULL ||
865 g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER) == NULL)
867 g_set_error_literal (error,
869 G_IO_ERROR_INVALID_ARGUMENT,
870 _("METHOD_CALL message: PATH or MEMBER header field is missing"));
875 case G_DBUS_MESSAGE_TYPE_METHOD_RETURN:
876 if (g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL) == NULL)
878 g_set_error_literal (error,
880 G_IO_ERROR_INVALID_ARGUMENT,
881 _("METHOD_RETURN message: REPLY_SERIAL header field is missing"));
886 case G_DBUS_MESSAGE_TYPE_ERROR:
887 if (g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME) == NULL ||
888 g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL) == NULL)
890 g_set_error_literal (error,
892 G_IO_ERROR_INVALID_ARGUMENT,
893 _("ERROR message: REPLY_SERIAL or ERROR_NAME header field is missing"));
898 case G_DBUS_MESSAGE_TYPE_SIGNAL:
899 if (g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH) == NULL ||
900 g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE) == NULL ||
901 g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER) == NULL)
903 g_set_error_literal (error,
905 G_IO_ERROR_INVALID_ARGUMENT,
906 _("SIGNAL message: PATH, INTERFACE or MEMBER header field is missing"));
909 if (g_strcmp0 (g_dbus_message_get_path (message), "/org/freedesktop/DBus/Local") == 0)
911 g_set_error_literal (error,
913 G_IO_ERROR_INVALID_ARGUMENT,
914 _("SIGNAL message: The PATH header field is using the reserved value /org/freedesktop/DBus/Local"));
917 if (g_strcmp0 (g_dbus_message_get_interface (message), "org.freedesktop.DBus.Local") == 0)
919 g_set_error_literal (error,
921 G_IO_ERROR_INVALID_ARGUMENT,
922 _("SIGNAL message: The INTERFACE header field is using the reserved value org.freedesktop.DBus.Local"));
928 /* hitherto unknown type - nothing to check */
935 g_assert (ret || (error == NULL || *error != NULL));
939 /* ---------------------------------------------------------------------------------------------------- */
942 ensure_input_padding (GMemoryInputStream *mis,
949 offset = g_seekable_tell (G_SEEKABLE (mis));
950 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
952 if (offset != wanted_offset)
954 return g_seekable_seek (G_SEEKABLE (mis), wanted_offset, G_SEEK_SET, NULL, error);
963 read_string (GMemoryInputStream *mis,
964 GDataInputStream *dis,
973 const gchar *end_valid;
975 s = g_string_new (NULL);
978 while (remaining > 0)
983 to_read = MIN (remaining, sizeof (buf));
984 num_read = g_input_stream_read (G_INPUT_STREAM (mis),
993 /* G_GSIZE_FORMAT doesn't work with gettext, so we use %lu */
996 G_IO_ERROR_INVALID_ARGUMENT,
997 g_dngettext (GETTEXT_PACKAGE,
998 "Wanted to read %lu byte but got EOF",
999 "Wanted to read %lu bytes but got EOF",
1005 remaining -= num_read;
1006 g_string_append_len (s, buf, num_read);
1010 nul = g_data_input_stream_read_byte (dis, NULL, &local_error);
1011 if (local_error != NULL)
1013 g_propagate_error (error, local_error);
1016 if (!g_utf8_validate (s->str, -1, &end_valid))
1020 offset = (gint) (end_valid - s->str);
1021 valid_str = g_strndup (s->str, offset);
1024 G_IO_ERROR_INVALID_ARGUMENT,
1025 _("Expected valid UTF-8 string but found invalid bytes at byte offset %d (length of string is %d). "
1026 "The valid UTF-8 string up until that point was `%s'"),
1037 G_IO_ERROR_INVALID_ARGUMENT,
1038 _("Expected NUL byte after the string `%s' but found byte %d"),
1043 return g_string_free (s, FALSE);
1046 g_string_free (s, TRUE);
1050 /* if just_align==TRUE, don't read a value, just align the input stream wrt padding */
1052 /* returns a non-floating GVariant! */
1054 parse_value_from_blob (GMemoryInputStream *mis,
1055 GDataInputStream *dis,
1056 const GVariantType *type,
1057 gboolean just_align,
1062 GError *local_error;
1064 const gchar *type_string;
1066 type_string = g_variant_type_peek_string (type);
1068 #ifdef DEBUG_SERIALIZER
1072 s = g_variant_type_dup_string (type);
1073 g_print ("%*sReading type %s from offset 0x%04x",
1076 (gint) g_seekable_tell (G_SEEKABLE (mis)));
1079 #endif /* DEBUG_SERIALIZER */
1085 switch (type_string[0])
1087 case 'b': /* G_VARIANT_TYPE_BOOLEAN */
1088 if (!ensure_input_padding (mis, 4, &local_error))
1093 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1094 if (local_error != NULL)
1096 ret = g_variant_new_boolean (v);
1100 case 'y': /* G_VARIANT_TYPE_BYTE */
1104 v = g_data_input_stream_read_byte (dis, NULL, &local_error);
1105 if (local_error != NULL)
1107 ret = g_variant_new_byte (v);
1111 case 'n': /* G_VARIANT_TYPE_INT16 */
1112 if (!ensure_input_padding (mis, 2, &local_error))
1117 v = g_data_input_stream_read_int16 (dis, NULL, &local_error);
1118 if (local_error != NULL)
1120 ret = g_variant_new_int16 (v);
1124 case 'q': /* G_VARIANT_TYPE_UINT16 */
1125 if (!ensure_input_padding (mis, 2, &local_error))
1130 v = g_data_input_stream_read_uint16 (dis, NULL, &local_error);
1131 if (local_error != NULL)
1133 ret = g_variant_new_uint16 (v);
1137 case 'i': /* G_VARIANT_TYPE_INT32 */
1138 if (!ensure_input_padding (mis, 4, &local_error))
1143 v = g_data_input_stream_read_int32 (dis, NULL, &local_error);
1144 if (local_error != NULL)
1146 ret = g_variant_new_int32 (v);
1150 case 'u': /* G_VARIANT_TYPE_UINT32 */
1151 if (!ensure_input_padding (mis, 4, &local_error))
1156 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1157 if (local_error != NULL)
1159 ret = g_variant_new_uint32 (v);
1163 case 'x': /* G_VARIANT_TYPE_INT64 */
1164 if (!ensure_input_padding (mis, 8, &local_error))
1169 v = g_data_input_stream_read_int64 (dis, NULL, &local_error);
1170 if (local_error != NULL)
1172 ret = g_variant_new_int64 (v);
1176 case 't': /* G_VARIANT_TYPE_UINT64 */
1177 if (!ensure_input_padding (mis, 8, &local_error))
1182 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
1183 if (local_error != NULL)
1185 ret = g_variant_new_uint64 (v);
1189 case 'd': /* G_VARIANT_TYPE_DOUBLE */
1190 if (!ensure_input_padding (mis, 8, &local_error))
1198 G_STATIC_ASSERT (sizeof (gdouble) == sizeof (guint64));
1199 u.v_uint64 = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
1200 if (local_error != NULL)
1202 ret = g_variant_new_double (u.v_double);
1206 case 's': /* G_VARIANT_TYPE_STRING */
1207 if (!ensure_input_padding (mis, 4, &local_error))
1213 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1214 if (local_error != NULL)
1216 v = read_string (mis, dis, (gsize) len, &local_error);
1219 ret = g_variant_new_string (v);
1224 case 'o': /* G_VARIANT_TYPE_OBJECT_PATH */
1225 if (!ensure_input_padding (mis, 4, &local_error))
1231 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1232 if (local_error != NULL)
1234 v = read_string (mis, dis, (gsize) len, &local_error);
1237 if (!g_variant_is_object_path (v))
1239 g_set_error (&local_error,
1241 G_IO_ERROR_INVALID_ARGUMENT,
1242 _("Parsed value `%s' is not a valid D-Bus object path"),
1247 ret = g_variant_new_object_path (v);
1252 case 'g': /* G_VARIANT_TYPE_SIGNATURE */
1257 len = g_data_input_stream_read_byte (dis, NULL, &local_error);
1258 if (local_error != NULL)
1260 v = read_string (mis, dis, (gsize) len, &local_error);
1263 if (!g_variant_is_signature (v))
1265 g_set_error (&local_error,
1267 G_IO_ERROR_INVALID_ARGUMENT,
1268 _("Parsed value `%s' is not a valid D-Bus signature"),
1273 ret = g_variant_new_signature (v);
1278 case 'h': /* G_VARIANT_TYPE_HANDLE */
1279 if (!ensure_input_padding (mis, 4, &local_error))
1284 v = g_data_input_stream_read_int32 (dis, NULL, &local_error);
1285 if (local_error != NULL)
1287 ret = g_variant_new_handle (v);
1291 case 'a': /* G_VARIANT_TYPE_ARRAY */
1296 const GVariantType *element_type;
1297 GVariantBuilder builder;
1299 if (!ensure_input_padding (mis, 4, &local_error))
1308 array_len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1309 if (local_error != NULL)
1313 #ifdef DEBUG_SERIALIZER
1314 g_print (": array spans 0x%04x bytes\n", array_len);
1315 #endif /* DEBUG_SERIALIZER */
1317 if (array_len > (2<<26))
1319 /* G_GUINT32_FORMAT doesn't work with gettext, so use u */
1320 g_set_error (&local_error,
1322 G_IO_ERROR_INVALID_ARGUMENT,
1323 g_dngettext (GETTEXT_PACKAGE,
1324 "Encountered array of length %u byte. Maximum length is 2<<26 bytes (64 MiB).",
1325 "Encountered array of length %u bytes. Maximum length is 2<<26 bytes (64 MiB).",
1332 g_variant_builder_init (&builder, type);
1333 element_type = g_variant_type_element (type);
1338 item = parse_value_from_blob (mis,
1344 g_assert (item == NULL);
1348 /* TODO: optimize array of primitive types */
1349 offset = g_seekable_tell (G_SEEKABLE (mis));
1350 target = offset + array_len;
1351 while (offset < target)
1354 item = parse_value_from_blob (mis,
1362 g_variant_builder_clear (&builder);
1365 g_variant_builder_add_value (&builder, item);
1366 g_variant_unref (item);
1367 offset = g_seekable_tell (G_SEEKABLE (mis));
1373 ret = g_variant_builder_end (&builder);
1377 g_variant_builder_clear (&builder);
1383 if (g_variant_type_is_dict_entry (type))
1385 const GVariantType *key_type;
1386 const GVariantType *value_type;
1390 if (!ensure_input_padding (mis, 8, &local_error))
1394 #ifdef DEBUG_SERIALIZER
1396 #endif /* DEBUG_SERIALIZER */
1400 key_type = g_variant_type_key (type);
1401 key = parse_value_from_blob (mis,
1409 value_type = g_variant_type_value (type);
1410 value = parse_value_from_blob (mis,
1418 g_variant_unref (key);
1421 ret = g_variant_new_dict_entry (key, value);
1422 g_variant_unref (key);
1423 g_variant_unref (value);
1426 else if (g_variant_type_is_tuple (type))
1428 if (!ensure_input_padding (mis, 8, &local_error))
1432 #ifdef DEBUG_SERIALIZER
1434 #endif /* DEBUG_SERIALIZER */
1438 const GVariantType *element_type;
1439 GVariantBuilder builder;
1441 g_variant_builder_init (&builder, type);
1442 element_type = g_variant_type_first (type);
1443 while (element_type != NULL)
1446 item = parse_value_from_blob (mis,
1454 g_variant_builder_clear (&builder);
1457 g_variant_builder_add_value (&builder, item);
1458 g_variant_unref (item);
1460 element_type = g_variant_type_next (element_type);
1462 ret = g_variant_builder_end (&builder);
1465 else if (g_variant_type_is_variant (type))
1468 #ifdef DEBUG_SERIALIZER
1470 #endif /* DEBUG_SERIALIZER */
1476 GVariantType *variant_type;
1479 siglen = g_data_input_stream_read_byte (dis, NULL, &local_error);
1480 if (local_error != NULL)
1482 sig = read_string (mis, dis, (gsize) siglen, &local_error);
1485 if (!g_variant_is_signature (sig))
1487 g_set_error (&local_error,
1489 G_IO_ERROR_INVALID_ARGUMENT,
1490 _("Parsed value `%s' for variant is not a valid D-Bus signature"),
1495 variant_type = g_variant_type_new (sig);
1497 value = parse_value_from_blob (mis,
1503 g_variant_type_free (variant_type);
1506 ret = g_variant_new_variant (value);
1507 g_variant_unref (value);
1513 s = g_variant_type_dup_string (type);
1514 g_set_error (&local_error,
1516 G_IO_ERROR_INVALID_ARGUMENT,
1517 _("Error deserializing GVariant with type string `%s' from the D-Bus wire format"),
1525 g_assert ((just_align && ret == NULL) || (!just_align && ret != NULL));
1527 #ifdef DEBUG_SERIALIZER
1533 if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1535 s = g_strdup_printf ("0x%02x '%c'", g_variant_get_byte (ret), g_variant_get_byte (ret));
1539 s = g_variant_print (ret, FALSE);
1541 g_print (": %s\n", s);
1546 is_leaf = is_leaf; /* To avoid -Wunused-but-set-variable */
1547 #endif /* DEBUG_SERIALIZER */
1549 /* sink the reference */
1552 g_assert (g_variant_is_floating (ret));
1553 g_variant_ref_sink (ret);
1558 #ifdef DEBUG_SERIALIZER
1560 "%*sFAILURE: %s (%s, %d)\n",
1562 local_error->message,
1563 g_quark_to_string (local_error->domain),
1565 #endif /* DEBUG_SERIALIZER */
1566 g_propagate_error (error, local_error);
1570 /* ---------------------------------------------------------------------------------------------------- */
1572 /* message_header must be at least 16 bytes */
1575 * g_dbus_message_bytes_needed:
1576 * @blob: A blob represent a binary D-Bus message.
1577 * @blob_len: The length of @blob (must be at least 16).
1578 * @error: Return location for error or %NULL.
1580 * Utility function to calculate how many bytes are needed to
1581 * completely deserialize the D-Bus message stored at @blob.
1583 * Returns: Number of bytes needed or -1 if @error is set (e.g. if
1584 * @blob contains invalid data or not enough data is available to
1585 * determine the size).
1590 g_dbus_message_bytes_needed (guchar *blob,
1598 g_return_val_if_fail (blob != NULL, -1);
1599 g_return_val_if_fail (error == NULL || *error == NULL, -1);
1600 g_return_val_if_fail (blob_len >= 16, -1);
1604 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1605 ret = 12 + 4 + GUINT32_FROM_LE (((guint32 *) blob)[3]);
1606 /* round up so it's a multiple of 8 */
1607 ret = 8 * ((ret + 7)/8);
1608 /* finally add the body size */
1609 ret += GUINT32_FROM_LE (((guint32 *) blob)[1]);
1611 else if (blob[0] == 'B')
1613 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1614 ret = 12 + 4 + GUINT32_FROM_BE (((guint32 *) blob)[3]);
1615 /* round up so it's a multiple of 8 */
1616 ret = 8 * ((ret + 7)/8);
1617 /* finally add the body size */
1618 ret += GUINT32_FROM_BE (((guint32 *) blob)[1]);
1624 G_IO_ERROR_INVALID_ARGUMENT,
1625 "Unable to determine message blob length - given blob is malformed");
1632 G_IO_ERROR_INVALID_ARGUMENT,
1633 "Blob indicates that message exceeds maximum message length (128MiB)");
1640 /* ---------------------------------------------------------------------------------------------------- */
1643 * g_dbus_message_new_from_blob:
1644 * @blob: A blob represent a binary D-Bus message.
1645 * @blob_len: The length of @blob.
1646 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
1647 * @error: Return location for error or %NULL.
1649 * Creates a new #GDBusMessage from the data stored at @blob. The byte
1650 * order that the message was in can be retrieved using
1651 * g_dbus_message_get_byte_order().
1653 * Returns: A new #GDBusMessage or %NULL if @error is set. Free with
1659 g_dbus_message_new_from_blob (guchar *blob,
1661 GDBusCapabilityFlags capabilities,
1665 GMemoryInputStream *mis;
1666 GDataInputStream *dis;
1667 GDBusMessage *message;
1669 guchar major_protocol_version;
1670 GDataStreamByteOrder byte_order;
1671 guint32 message_body_len;
1675 GVariant *signature;
1677 /* TODO: check against @capabilities */
1681 g_return_val_if_fail (blob != NULL, NULL);
1682 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1683 g_return_val_if_fail (blob_len >= 12, NULL);
1685 message = g_dbus_message_new ();
1687 mis = G_MEMORY_INPUT_STREAM (g_memory_input_stream_new_from_data (blob, blob_len, NULL));
1688 dis = g_data_input_stream_new (G_INPUT_STREAM (mis));
1690 endianness = g_data_input_stream_read_byte (dis, NULL, NULL);
1694 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1695 message->byte_order = G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN;
1698 byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
1699 message->byte_order = G_DBUS_MESSAGE_BYTE_ORDER_BIG_ENDIAN;
1704 G_IO_ERROR_INVALID_ARGUMENT,
1705 _("Invalid endianness value. Expected 0x6c ('l') or 0x42 ('B') but found value 0x%02x"),
1709 g_data_input_stream_set_byte_order (dis, byte_order);
1711 message->type = g_data_input_stream_read_byte (dis, NULL, NULL);
1712 message->flags = g_data_input_stream_read_byte (dis, NULL, NULL);
1713 major_protocol_version = g_data_input_stream_read_byte (dis, NULL, NULL);
1714 if (major_protocol_version != 1)
1718 G_IO_ERROR_INVALID_ARGUMENT,
1719 _("Invalid major protocol version. Expected 1 but found %d"),
1720 major_protocol_version);
1723 message_body_len = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1724 message->serial = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1726 #ifdef DEBUG_SERIALIZER
1727 g_print ("Parsing blob (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1730 s = _g_dbus_hexdump ((const gchar *) blob, blob_len, 2);
1731 g_print ("%s\n", s);
1734 #endif /* DEBUG_SERIALIZER */
1736 #ifdef DEBUG_SERIALIZER
1737 g_print ("Parsing headers (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1738 #endif /* DEBUG_SERIALIZER */
1739 headers = parse_value_from_blob (mis,
1741 G_VARIANT_TYPE ("a{yv}"),
1745 if (headers == NULL)
1747 g_variant_iter_init (&iter, headers);
1748 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1750 guchar header_field;
1752 g_variant_get (item,
1756 g_dbus_message_set_header (message, header_field, value);
1757 g_variant_unref (value);
1758 g_variant_unref (item);
1760 g_variant_unref (headers);
1762 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
1763 if (signature != NULL)
1765 const gchar *signature_str;
1766 gsize signature_str_len;
1768 signature_str = g_variant_get_string (signature, &signature_str_len);
1770 /* signature but no body */
1771 if (message_body_len == 0 && signature_str_len > 0)
1775 G_IO_ERROR_INVALID_ARGUMENT,
1776 _("Signature header with signature `%s' found but message body is empty"),
1780 else if (signature_str_len > 0)
1782 GVariantType *variant_type;
1783 gchar *tupled_signature_str;
1785 if (!g_variant_is_signature (signature_str))
1789 G_IO_ERROR_INVALID_ARGUMENT,
1790 _("Parsed value `%s' is not a valid D-Bus signature (for body)"),
1794 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
1795 variant_type = g_variant_type_new (tupled_signature_str);
1796 g_free (tupled_signature_str);
1797 #ifdef DEBUG_SERIALIZER
1798 g_print ("Parsing body (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1799 #endif /* DEBUG_SERIALIZER */
1800 message->body = parse_value_from_blob (mis,
1806 g_variant_type_free (variant_type);
1807 if (message->body == NULL)
1813 /* no signature, this is only OK if the body is empty */
1814 if (message_body_len != 0)
1816 /* G_GUINT32_FORMAT doesn't work with gettext, just use %u */
1819 G_IO_ERROR_INVALID_ARGUMENT,
1820 g_dngettext (GETTEXT_PACKAGE,
1821 "No signature header in message but the message body is %u byte",
1822 "No signature header in message but the message body is %u bytes",
1829 if (!validate_headers (message, error))
1831 g_prefix_error (error, _("Cannot deserialize message: "));
1838 g_object_unref (dis);
1839 g_object_unref (mis);
1847 if (message != NULL)
1848 g_object_unref (message);
1853 /* ---------------------------------------------------------------------------------------------------- */
1856 ensure_output_padding (GMemoryOutputStream *mos,
1857 GDataOutputStream *dos,
1861 gsize wanted_offset;
1862 gsize padding_needed;
1865 offset = g_memory_output_stream_get_data_size (mos);
1866 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
1867 padding_needed = wanted_offset - offset;
1869 for (n = 0; n < padding_needed; n++)
1870 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1872 return padding_needed;
1875 /* note that value can be NULL for e.g. empty arrays - type is never NULL */
1877 append_value_to_blob (GVariant *value,
1878 const GVariantType *type,
1879 GMemoryOutputStream *mos,
1880 GDataOutputStream *dos,
1881 gsize *out_padding_added,
1884 gsize padding_added;
1885 const gchar *type_string;
1887 type_string = g_variant_type_peek_string (type);
1891 switch (type_string[0])
1893 case 'b': /* G_VARIANT_TYPE_BOOLEAN */
1894 padding_added = ensure_output_padding (mos, dos, 4);
1897 gboolean v = g_variant_get_boolean (value);
1898 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1902 case 'y': /* G_VARIANT_TYPE_BYTE */
1905 guint8 v = g_variant_get_byte (value);
1906 g_data_output_stream_put_byte (dos, v, NULL, NULL);
1910 case 'n': /* G_VARIANT_TYPE_INT16 */
1911 padding_added = ensure_output_padding (mos, dos, 2);
1914 gint16 v = g_variant_get_int16 (value);
1915 g_data_output_stream_put_int16 (dos, v, NULL, NULL);
1919 case 'q': /* G_VARIANT_TYPE_UINT16 */
1920 padding_added = ensure_output_padding (mos, dos, 2);
1923 guint16 v = g_variant_get_uint16 (value);
1924 g_data_output_stream_put_uint16 (dos, v, NULL, NULL);
1928 case 'i': /* G_VARIANT_TYPE_INT32 */
1929 padding_added = ensure_output_padding (mos, dos, 4);
1932 gint32 v = g_variant_get_int32 (value);
1933 g_data_output_stream_put_int32 (dos, v, NULL, NULL);
1937 case 'u': /* G_VARIANT_TYPE_UINT32 */
1938 padding_added = ensure_output_padding (mos, dos, 4);
1941 guint32 v = g_variant_get_uint32 (value);
1942 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1946 case 'x': /* G_VARIANT_TYPE_INT64 */
1947 padding_added = ensure_output_padding (mos, dos, 8);
1950 gint64 v = g_variant_get_int64 (value);
1951 g_data_output_stream_put_int64 (dos, v, NULL, NULL);
1955 case 't': /* G_VARIANT_TYPE_UINT64 */
1956 padding_added = ensure_output_padding (mos, dos, 8);
1959 guint64 v = g_variant_get_uint64 (value);
1960 g_data_output_stream_put_uint64 (dos, v, NULL, NULL);
1964 case 'd': /* G_VARIANT_TYPE_DOUBLE */
1965 padding_added = ensure_output_padding (mos, dos, 8);
1972 G_STATIC_ASSERT (sizeof (gdouble) == sizeof (guint64));
1973 u.v_double = g_variant_get_double (value);
1974 g_data_output_stream_put_uint64 (dos, u.v_uint64, NULL, NULL);
1978 case 's': /* G_VARIANT_TYPE_STRING */
1979 padding_added = ensure_output_padding (mos, dos, 4);
1985 v = g_variant_get_string (value, &len);
1986 g_assert (g_utf8_validate (v, -1, &end) && (end == v + len));
1987 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1988 g_data_output_stream_put_string (dos, v, NULL, NULL);
1989 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1993 case 'o': /* G_VARIANT_TYPE_OBJECT_PATH */
1994 padding_added = ensure_output_padding (mos, dos, 4);
1998 const gchar *v = g_variant_get_string (value, &len);
1999 g_assert (g_variant_is_object_path (v));
2000 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
2001 g_data_output_stream_put_string (dos, v, NULL, NULL);
2002 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
2006 case 'g': /* G_VARIANT_TYPE_SIGNATURE */
2010 const gchar *v = g_variant_get_string (value, &len);
2011 g_assert (g_variant_is_signature (v));
2012 g_data_output_stream_put_byte (dos, len, NULL, NULL);
2013 g_data_output_stream_put_string (dos, v, NULL, NULL);
2014 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
2018 case 'h': /* G_VARIANT_TYPE_HANDLE */
2019 padding_added = ensure_output_padding (mos, dos, 4);
2022 gint32 v = g_variant_get_handle (value);
2023 g_data_output_stream_put_int32 (dos, v, NULL, NULL);
2027 case 'a': /* G_VARIANT_TYPE_ARRAY */
2031 goffset array_len_offset;
2032 goffset array_payload_begin_offset;
2036 padding_added = ensure_output_padding (mos, dos, 4);
2039 /* array length - will be filled in later */
2040 array_len_offset = g_memory_output_stream_get_data_size (mos);
2041 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
2043 /* From the D-Bus spec:
2045 * "A UINT32 giving the length of the array data in bytes,
2046 * followed by alignment padding to the alignment boundary of
2047 * the array element type, followed by each array element. The
2048 * array length is from the end of the alignment padding to
2049 * the end of the last element, i.e. it does not include the
2050 * padding after the length, or any padding after the last
2053 * Thus, we need to count how much padding the first element
2054 * contributes and subtract that from the array length.
2056 array_payload_begin_offset = g_memory_output_stream_get_data_size (mos);
2058 if (g_variant_n_children (value) == 0)
2060 gsize padding_added_for_item;
2061 if (!append_value_to_blob (NULL,
2062 g_variant_type_element (type),
2065 &padding_added_for_item,
2068 array_payload_begin_offset += padding_added_for_item;
2074 g_variant_iter_init (&iter, value);
2075 while ((item = g_variant_iter_next_value (&iter)) != NULL)
2077 gsize padding_added_for_item;
2078 if (!append_value_to_blob (item,
2079 g_variant_get_type (item),
2082 &padding_added_for_item,
2085 g_variant_unref (item);
2088 g_variant_unref (item);
2091 array_payload_begin_offset += padding_added_for_item;
2097 cur_offset = g_memory_output_stream_get_data_size (mos);
2098 array_len = cur_offset - array_payload_begin_offset;
2099 if (!g_seekable_seek (G_SEEKABLE (mos), array_len_offset, G_SEEK_SET, NULL, error))
2102 g_data_output_stream_put_uint32 (dos, array_len, NULL, NULL);
2103 if (!g_seekable_seek (G_SEEKABLE (mos), cur_offset, G_SEEK_SET, NULL, error))
2110 if (g_variant_type_is_dict_entry (type) || g_variant_type_is_tuple (type))
2112 padding_added = ensure_output_padding (mos, dos, 8);
2117 g_variant_iter_init (&iter, value);
2118 while ((item = g_variant_iter_next_value (&iter)) != NULL)
2120 if (!append_value_to_blob (item,
2121 g_variant_get_type (item),
2127 g_variant_unref (item);
2130 g_variant_unref (item);
2134 else if (g_variant_type_is_variant (type))
2139 const gchar *signature;
2140 child = g_variant_get_child_value (value, 0);
2141 signature = g_variant_get_type_string (child);
2142 g_data_output_stream_put_byte (dos, strlen (signature), NULL, NULL);
2143 g_data_output_stream_put_string (dos, signature, NULL, NULL);
2144 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
2145 if (!append_value_to_blob (child,
2146 g_variant_get_type (child),
2152 g_variant_unref (child);
2155 g_variant_unref (child);
2162 G_IO_ERROR_INVALID_ARGUMENT,
2163 _("Error serializing GVariant with type string `%s' to the D-Bus wire format"),
2164 g_variant_get_type_string (value));
2170 if (out_padding_added != NULL)
2171 *out_padding_added = padding_added;
2180 append_body_to_blob (GVariant *value,
2181 GMemoryOutputStream *mos,
2182 GDataOutputStream *dos,
2188 if (!g_variant_is_of_type (value, G_VARIANT_TYPE_TUPLE))
2192 G_IO_ERROR_INVALID_ARGUMENT,
2193 "Expected a tuple for the body of the GDBusMessage.");
2197 g_variant_iter_init (&iter, value);
2198 while ((item = g_variant_iter_next_value (&iter)) != NULL)
2200 if (!append_value_to_blob (item,
2201 g_variant_get_type (item),
2207 g_variant_unref (item);
2210 g_variant_unref (item);
2218 /* ---------------------------------------------------------------------------------------------------- */
2221 * g_dbus_message_to_blob:
2222 * @message: A #GDBusMessage.
2223 * @out_size: Return location for size of generated blob.
2224 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
2225 * @error: Return location for error.
2227 * Serializes @message to a blob. The byte order returned by
2228 * g_dbus_message_get_byte_order() will be used.
2230 * Returns: A pointer to a valid binary D-Bus message of @out_size bytes
2231 * generated by @message or %NULL if @error is set. Free with g_free().
2236 g_dbus_message_to_blob (GDBusMessage *message,
2238 GDBusCapabilityFlags capabilities,
2241 GMemoryOutputStream *mos;
2242 GDataOutputStream *dos;
2245 GDataStreamByteOrder byte_order;
2246 goffset body_len_offset;
2247 goffset body_start_offset;
2249 GVariant *header_fields;
2250 GVariantBuilder builder;
2251 GHashTableIter hash_iter;
2253 GVariant *header_value;
2254 GVariant *signature;
2255 const gchar *signature_str;
2256 gint num_fds_in_message;
2257 gint num_fds_according_to_header;
2259 /* TODO: check against @capabilities */
2263 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2264 g_return_val_if_fail (out_size != NULL, NULL);
2265 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2267 mos = G_MEMORY_OUTPUT_STREAM (g_memory_output_stream_new (NULL, 0, g_realloc, g_free));
2268 dos = g_data_output_stream_new (G_OUTPUT_STREAM (mos));
2270 byte_order = G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN;
2271 switch (message->byte_order)
2273 case G_DBUS_MESSAGE_BYTE_ORDER_BIG_ENDIAN:
2274 byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
2276 case G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN:
2277 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
2280 g_data_output_stream_set_byte_order (dos, byte_order);
2283 g_data_output_stream_put_byte (dos, (guchar) message->byte_order, NULL, NULL);
2284 g_data_output_stream_put_byte (dos, message->type, NULL, NULL);
2285 g_data_output_stream_put_byte (dos, message->flags, NULL, NULL);
2286 g_data_output_stream_put_byte (dos, 1, NULL, NULL); /* major protocol version */
2287 body_len_offset = g_memory_output_stream_get_data_size (mos);
2288 /* body length - will be filled in later */
2289 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
2290 g_data_output_stream_put_uint32 (dos, message->serial, NULL, NULL);
2292 num_fds_in_message = 0;
2294 if (message->fd_list != NULL)
2295 num_fds_in_message = g_unix_fd_list_get_length (message->fd_list);
2297 num_fds_according_to_header = g_dbus_message_get_num_unix_fds (message);
2298 if (num_fds_in_message != num_fds_according_to_header)
2302 G_IO_ERROR_INVALID_ARGUMENT,
2303 _("Message has %d file descriptors but the header field indicates %d file descriptors"),
2305 num_fds_according_to_header);
2309 if (!validate_headers (message, error))
2311 g_prefix_error (error, _("Cannot serialize message: "));
2315 g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{yv}"));
2316 g_hash_table_iter_init (&hash_iter, message->headers);
2317 while (g_hash_table_iter_next (&hash_iter, &key, (gpointer) &header_value))
2319 g_variant_builder_add (&builder,
2321 (guchar) GPOINTER_TO_UINT (key),
2324 header_fields = g_variant_builder_end (&builder);
2326 if (!append_value_to_blob (header_fields,
2327 g_variant_get_type (header_fields),
2332 g_variant_unref (header_fields);
2335 g_variant_unref (header_fields);
2337 /* header size must be a multiple of 8 */
2338 ensure_output_padding (mos, dos, 8);
2340 body_start_offset = g_memory_output_stream_get_data_size (mos);
2342 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2343 signature_str = NULL;
2344 if (signature != NULL)
2345 signature_str = g_variant_get_string (signature, NULL);
2346 if (message->body != NULL)
2348 gchar *tupled_signature_str;
2349 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
2350 if (signature == NULL)
2354 G_IO_ERROR_INVALID_ARGUMENT,
2355 _("Message body has signature `%s' but there is no signature header"),
2357 g_free (tupled_signature_str);
2360 else if (g_strcmp0 (tupled_signature_str, g_variant_get_type_string (message->body)) != 0)
2364 G_IO_ERROR_INVALID_ARGUMENT,
2365 _("Message body has type signature `%s' but signature in the header field is `%s'"),
2366 tupled_signature_str, g_variant_get_type_string (message->body));
2367 g_free (tupled_signature_str);
2370 g_free (tupled_signature_str);
2371 if (!append_body_to_blob (message->body, mos, dos, error))
2376 if (signature != NULL && strlen (signature_str) > 0)
2380 G_IO_ERROR_INVALID_ARGUMENT,
2381 _("Message body is empty but signature in the header field is `(%s)'"),
2387 /* OK, we're done writing the message - set the body length */
2388 size = g_memory_output_stream_get_data_size (mos);
2389 body_size = size - body_start_offset;
2391 if (!g_seekable_seek (G_SEEKABLE (mos), body_len_offset, G_SEEK_SET, NULL, error))
2394 g_data_output_stream_put_uint32 (dos, body_size, NULL, NULL);
2396 if (!g_output_stream_close (G_OUTPUT_STREAM (dos), NULL, error))
2400 ret = g_memory_output_stream_steal_data (mos);
2403 g_object_unref (dos);
2404 g_object_unref (mos);
2409 /* ---------------------------------------------------------------------------------------------------- */
2412 get_uint32_header (GDBusMessage *message,
2413 GDBusMessageHeaderField header_field)
2419 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2420 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_UINT32))
2421 ret = g_variant_get_uint32 (value);
2426 static const gchar *
2427 get_string_header (GDBusMessage *message,
2428 GDBusMessageHeaderField header_field)
2434 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2435 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
2436 ret = g_variant_get_string (value, NULL);
2441 static const gchar *
2442 get_object_path_header (GDBusMessage *message,
2443 GDBusMessageHeaderField header_field)
2449 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2450 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_OBJECT_PATH))
2451 ret = g_variant_get_string (value, NULL);
2456 static const gchar *
2457 get_signature_header (GDBusMessage *message,
2458 GDBusMessageHeaderField header_field)
2464 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2465 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_SIGNATURE))
2466 ret = g_variant_get_string (value, NULL);
2471 /* ---------------------------------------------------------------------------------------------------- */
2474 set_uint32_header (GDBusMessage *message,
2475 GDBusMessageHeaderField header_field,
2478 g_dbus_message_set_header (message,
2480 g_variant_new_uint32 (value));
2484 set_string_header (GDBusMessage *message,
2485 GDBusMessageHeaderField header_field,
2488 g_dbus_message_set_header (message,
2490 value == NULL ? NULL : g_variant_new_string (value));
2494 set_object_path_header (GDBusMessage *message,
2495 GDBusMessageHeaderField header_field,
2498 g_dbus_message_set_header (message,
2500 value == NULL ? NULL : g_variant_new_object_path (value));
2504 set_signature_header (GDBusMessage *message,
2505 GDBusMessageHeaderField header_field,
2508 g_dbus_message_set_header (message,
2510 value == NULL ? NULL : g_variant_new_signature (value));
2513 /* ---------------------------------------------------------------------------------------------------- */
2516 * g_dbus_message_get_reply_serial:
2517 * @message: A #GDBusMessage.
2519 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2521 * Returns: The value.
2526 g_dbus_message_get_reply_serial (GDBusMessage *message)
2528 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2529 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL);
2533 * g_dbus_message_set_reply_serial:
2534 * @message: A #GDBusMessage.
2535 * @value: The value to set.
2537 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2542 g_dbus_message_set_reply_serial (GDBusMessage *message,
2545 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2546 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL, value);
2549 /* ---------------------------------------------------------------------------------------------------- */
2552 * g_dbus_message_get_interface:
2553 * @message: A #GDBusMessage.
2555 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2557 * Returns: The value.
2562 g_dbus_message_get_interface (GDBusMessage *message)
2564 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2565 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE);
2569 * g_dbus_message_set_interface:
2570 * @message: A #GDBusMessage.
2571 * @value: The value to set.
2573 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2578 g_dbus_message_set_interface (GDBusMessage *message,
2581 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2582 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2583 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE, value);
2586 /* ---------------------------------------------------------------------------------------------------- */
2589 * g_dbus_message_get_member:
2590 * @message: A #GDBusMessage.
2592 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2594 * Returns: The value.
2599 g_dbus_message_get_member (GDBusMessage *message)
2601 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2602 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER);
2606 * g_dbus_message_set_member:
2607 * @message: A #GDBusMessage.
2608 * @value: The value to set.
2610 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2615 g_dbus_message_set_member (GDBusMessage *message,
2618 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2619 g_return_if_fail (value == NULL || g_dbus_is_member_name (value));
2620 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER, value);
2623 /* ---------------------------------------------------------------------------------------------------- */
2626 * g_dbus_message_get_path:
2627 * @message: A #GDBusMessage.
2629 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2631 * Returns: The value.
2636 g_dbus_message_get_path (GDBusMessage *message)
2638 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2639 return get_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH);
2643 * g_dbus_message_set_path:
2644 * @message: A #GDBusMessage.
2645 * @value: The value to set.
2647 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2652 g_dbus_message_set_path (GDBusMessage *message,
2655 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2656 g_return_if_fail (value == NULL || g_variant_is_object_path (value));
2657 set_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH, value);
2660 /* ---------------------------------------------------------------------------------------------------- */
2663 * g_dbus_message_get_sender:
2664 * @message: A #GDBusMessage.
2666 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2668 * Returns: The value.
2673 g_dbus_message_get_sender (GDBusMessage *message)
2675 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2676 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER);
2680 * g_dbus_message_set_sender:
2681 * @message: A #GDBusMessage.
2682 * @value: The value to set.
2684 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2689 g_dbus_message_set_sender (GDBusMessage *message,
2692 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2693 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2694 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER, value);
2697 /* ---------------------------------------------------------------------------------------------------- */
2700 * g_dbus_message_get_destination:
2701 * @message: A #GDBusMessage.
2703 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2705 * Returns: The value.
2710 g_dbus_message_get_destination (GDBusMessage *message)
2712 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2713 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION);
2717 * g_dbus_message_set_destination:
2718 * @message: A #GDBusMessage.
2719 * @value: The value to set.
2721 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2726 g_dbus_message_set_destination (GDBusMessage *message,
2729 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2730 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2731 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION, value);
2734 /* ---------------------------------------------------------------------------------------------------- */
2737 * g_dbus_message_get_error_name:
2738 * @message: A #GDBusMessage.
2740 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2742 * Returns: The value.
2747 g_dbus_message_get_error_name (GDBusMessage *message)
2749 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2750 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME);
2754 * g_dbus_message_set_error_name:
2755 * @message: A #GDBusMessage.
2756 * @value: The value to set.
2758 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2763 g_dbus_message_set_error_name (GDBusMessage *message,
2766 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2767 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2768 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME, value);
2771 /* ---------------------------------------------------------------------------------------------------- */
2774 * g_dbus_message_get_signature:
2775 * @message: A #GDBusMessage.
2777 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2779 * Returns: The value.
2784 g_dbus_message_get_signature (GDBusMessage *message)
2787 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2788 ret = get_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2795 * g_dbus_message_set_signature:
2796 * @message: A #GDBusMessage.
2797 * @value: The value to set.
2799 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2804 g_dbus_message_set_signature (GDBusMessage *message,
2807 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2808 g_return_if_fail (value == NULL || g_variant_is_signature (value));
2809 set_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE, value);
2812 /* ---------------------------------------------------------------------------------------------------- */
2815 * g_dbus_message_get_arg0:
2816 * @message: A #GDBusMessage.
2818 * Convenience to get the first item in the body of @message.
2820 * Returns: The string item or %NULL if the first item in the body of
2821 * @message is not a string.
2826 g_dbus_message_get_arg0 (GDBusMessage *message)
2830 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2834 if (message->body != NULL && g_variant_is_of_type (message->body, G_VARIANT_TYPE_TUPLE))
2837 item = g_variant_get_child_value (message->body, 0);
2838 if (g_variant_is_of_type (item, G_VARIANT_TYPE_STRING))
2839 ret = g_variant_get_string (item, NULL);
2840 g_variant_unref (item);
2846 /* ---------------------------------------------------------------------------------------------------- */
2849 * g_dbus_message_get_num_unix_fds:
2850 * @message: A #GDBusMessage.
2852 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2854 * Returns: The value.
2859 g_dbus_message_get_num_unix_fds (GDBusMessage *message)
2861 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2862 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS);
2866 * g_dbus_message_set_num_unix_fds:
2867 * @message: A #GDBusMessage.
2868 * @value: The value to set.
2870 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2875 g_dbus_message_set_num_unix_fds (GDBusMessage *message,
2878 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2879 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS, value);
2882 /* ---------------------------------------------------------------------------------------------------- */
2885 * g_dbus_message_to_gerror:
2886 * @message: A #GDBusMessage.
2887 * @error: The #GError to set.
2889 * If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does
2890 * nothing and returns %FALSE.
2892 * Otherwise this method encodes the error in @message as a #GError
2893 * using g_dbus_error_set_dbus_error() using the information in the
2894 * %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of @message as
2895 * well as the first string item in @message's body.
2897 * Returns: %TRUE if @error was set, %FALSE otherwise.
2902 g_dbus_message_to_gerror (GDBusMessage *message,
2906 const gchar *error_name;
2908 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2911 if (message->type != G_DBUS_MESSAGE_TYPE_ERROR)
2914 error_name = g_dbus_message_get_error_name (message);
2915 if (error_name != NULL)
2919 body = g_dbus_message_get_body (message);
2921 if (body != NULL && g_variant_is_of_type (body, G_VARIANT_TYPE ("(s)")))
2923 const gchar *error_message;
2924 g_variant_get (body, "(&s)", &error_message);
2925 g_dbus_error_set_dbus_error (error,
2932 /* these two situations are valid, yet pretty rare */
2935 g_dbus_error_set_dbus_error (error,
2938 _("Error return with body of type `%s'"),
2939 g_variant_get_type_string (body));
2943 g_dbus_error_set_dbus_error (error,
2946 _("Error return with empty body"));
2952 /* TOOD: this shouldn't happen - should check this at message serialization
2953 * time and disconnect the peer.
2958 "Error return without error-name header!");
2967 /* ---------------------------------------------------------------------------------------------------- */
2970 flags_to_string (GType flags_type, guint value)
2976 klass = g_type_class_ref (flags_type);
2977 s = g_string_new (NULL);
2978 for (n = 0; n < 32; n++)
2980 if ((value & (1<<n)) != 0)
2982 GFlagsValue *flags_value;
2983 flags_value = g_flags_get_first_value (klass, (1<<n));
2985 g_string_append_c (s, ',');
2986 if (flags_value != NULL)
2987 g_string_append (s, flags_value->value_nick);
2989 g_string_append_printf (s, "unknown (bit %d)", n);
2993 g_string_append (s, "none");
2994 g_type_class_unref (klass);
2995 return g_string_free (s, FALSE);
2999 _sort_keys_func (gconstpointer a,
3005 ia = GPOINTER_TO_INT (a);
3006 ib = GPOINTER_TO_INT (b);
3012 * g_dbus_message_print:
3013 * @message: A #GDBusMessage.
3014 * @indent: Indentation level.
3016 * Produces a human-readable multi-line description of @message.
3018 * The contents of the description has no ABI guarantees, the contents
3019 * and formatting is subject to change at any time. Typical output
3020 * looks something like this:
3027 * path -> objectpath '/org/gtk/GDBus/TestObject'
3028 * interface -> 'org.gtk.GDBus.TestInterface'
3029 * member -> 'GimmeStdout'
3030 * destination -> ':1.146'
3032 * UNIX File Descriptors:
3037 * Type: method-return
3038 * Flags: no-reply-expected
3042 * reply-serial -> uint32 4
3043 * destination -> ':1.159'
3044 * sender -> ':1.146'
3045 * num-unix-fds -> uint32 1
3047 * UNIX File Descriptors:
3048 * fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635
3051 * Returns: A string that should be freed with g_free().
3056 g_dbus_message_print (GDBusMessage *message,
3064 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
3066 str = g_string_new (NULL);
3068 s = _g_dbus_enum_to_string (G_TYPE_DBUS_MESSAGE_TYPE, message->type);
3069 g_string_append_printf (str, "%*sType: %s\n", indent, "", s);
3071 s = flags_to_string (G_TYPE_DBUS_MESSAGE_FLAGS, message->flags);
3072 g_string_append_printf (str, "%*sFlags: %s\n", indent, "", s);
3074 g_string_append_printf (str, "%*sVersion: %d\n", indent, "", message->major_protocol_version);
3075 g_string_append_printf (str, "%*sSerial: %d\n", indent, "", message->serial);
3077 g_string_append_printf (str, "%*sHeaders:\n", indent, "");
3078 keys = g_hash_table_get_keys (message->headers);
3079 keys = g_list_sort (keys, _sort_keys_func);
3082 for (l = keys; l != NULL; l = l->next)
3084 gint key = GPOINTER_TO_INT (l->data);
3088 value = g_hash_table_lookup (message->headers, l->data);
3089 g_assert (value != NULL);
3091 s = _g_dbus_enum_to_string (G_TYPE_DBUS_MESSAGE_HEADER_FIELD, key);
3092 value_str = g_variant_print (value, TRUE);
3093 g_string_append_printf (str, "%*s %s -> %s\n", indent, "", s, value_str);
3100 g_string_append_printf (str, "%*s (none)\n", indent, "");
3102 g_string_append_printf (str, "%*sBody: ", indent, "");
3103 if (message->body != NULL)
3105 g_variant_print_string (message->body,
3111 g_string_append (str, "()");
3113 g_string_append (str, "\n");
3115 g_string_append_printf (str, "%*sUNIX File Descriptors:\n", indent, "");
3116 if (message->fd_list != NULL)
3122 fds = g_unix_fd_list_peek_fds (message->fd_list, &num_fds);
3125 for (n = 0; n < num_fds; n++)
3128 struct stat statbuf;
3129 fs = g_string_new (NULL);
3130 if (fstat (fds[n], &statbuf) == 0)
3132 g_string_append_printf (fs, "%s" "dev=%d:%d", fs->len > 0 ? "," : "",
3133 major (statbuf.st_dev), minor (statbuf.st_dev));
3134 g_string_append_printf (fs, "%s" "mode=0%o", fs->len > 0 ? "," : "",
3136 g_string_append_printf (fs, "%s" "ino=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3137 (guint64) statbuf.st_ino);
3138 g_string_append_printf (fs, "%s" "uid=%d", fs->len > 0 ? "," : "",
3140 g_string_append_printf (fs, "%s" "gid=%d", fs->len > 0 ? "," : "",
3142 g_string_append_printf (fs, "%s" "rdev=%d:%d", fs->len > 0 ? "," : "",
3143 major (statbuf.st_rdev), minor (statbuf.st_rdev));
3144 g_string_append_printf (fs, "%s" "size=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3145 (guint64) statbuf.st_size);
3146 g_string_append_printf (fs, "%s" "atime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3147 (guint64) statbuf.st_atime);
3148 g_string_append_printf (fs, "%s" "mtime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3149 (guint64) statbuf.st_mtime);
3150 g_string_append_printf (fs, "%s" "ctime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3151 (guint64) statbuf.st_ctime);
3155 g_string_append_printf (fs, "(fstat failed: %s)", strerror (errno));
3157 g_string_append_printf (str, "%*s fd %d: %s\n", indent, "", fds[n], fs->str);
3158 g_string_free (fs, TRUE);
3163 g_string_append_printf (str, "%*s (empty)\n", indent, "");
3168 g_string_append_printf (str, "%*s (none)\n", indent, "");
3172 return g_string_free (str, FALSE);
3176 * g_dbus_message_get_locked:
3177 * @message: A #GDBusMessage.
3179 * Checks whether @message is locked. To monitor changes to this
3180 * value, conncet to the #GObject::notify signal to listen for changes
3181 * on the #GDBusMessage:locked property.
3183 * Returns: %TRUE if @message is locked, %FALSE otherwise.
3188 g_dbus_message_get_locked (GDBusMessage *message)
3190 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
3191 return message->locked;
3195 * g_dbus_message_lock:
3196 * @message: A #GDBusMessage.
3198 * If @message is locked, does nothing. Otherwise locks the message.
3203 g_dbus_message_lock (GDBusMessage *message)
3205 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
3207 if (message->locked)
3210 message->locked = TRUE;
3211 g_object_notify (G_OBJECT (message), "locked");
3218 * g_dbus_message_copy:
3219 * @message: A #GDBusMessage.
3220 * @error: Return location for error or %NULL.
3222 * Copies @message. The copy is a deep copy and the returned
3223 * #GDBusMessage is completely identical except that it is guaranteed
3226 * This operation can fail if e.g. @message contains file descriptors
3227 * and the per-process or system-wide open files limit is reached.
3229 * Returns: (transfer full): A new #GDBusMessage or %NULL if @error is set.
3230 * Free with g_object_unref().
3235 g_dbus_message_copy (GDBusMessage *message,
3239 GHashTableIter iter;
3240 gpointer header_key;
3241 GVariant *header_value;
3243 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
3244 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3246 ret = g_dbus_message_new ();
3247 ret->type = message->type;
3248 ret->flags = message->flags;
3249 ret->byte_order = message->byte_order;
3250 ret->major_protocol_version = message->major_protocol_version;
3251 ret->serial = message->serial;
3254 if (message->fd_list != NULL)
3260 ret->fd_list = g_unix_fd_list_new ();
3261 fds = g_unix_fd_list_peek_fds (message->fd_list, &num_fds);
3262 for (n = 0; n < num_fds; n++)
3264 if (g_unix_fd_list_append (ret->fd_list,
3268 g_object_unref (ret);
3276 /* see https://bugzilla.gnome.org/show_bug.cgi?id=624546#c8 for why it's fine
3277 * to just ref (as opposed to deep-copying) the GVariant instances
3279 ret->body = message->body != NULL ? g_variant_ref (message->body) : NULL;
3280 g_hash_table_iter_init (&iter, message->headers);
3281 while (g_hash_table_iter_next (&iter, &header_key, (gpointer) &header_value))
3282 g_hash_table_insert (ret->headers, header_key, g_variant_ref (header_value));