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 _("Wanted to read %lu bytes but got EOF"),
1002 remaining -= num_read;
1003 g_string_append_len (s, buf, num_read);
1007 nul = g_data_input_stream_read_byte (dis, NULL, &local_error);
1008 if (local_error != NULL)
1010 g_propagate_error (error, local_error);
1013 if (!g_utf8_validate (s->str, -1, &end_valid))
1017 offset = (gint) (end_valid - s->str);
1018 valid_str = g_strndup (s->str, offset);
1021 G_IO_ERROR_INVALID_ARGUMENT,
1022 _("Expected valid UTF-8 string but found invalid bytes at byte offset %d (length of string is %d). "
1023 "The valid UTF-8 string up until that point was `%s'"),
1034 G_IO_ERROR_INVALID_ARGUMENT,
1035 _("Expected NUL byte after the string `%s' but found byte %d"),
1040 return g_string_free (s, FALSE);
1043 g_string_free (s, TRUE);
1047 /* if just_align==TRUE, don't read a value, just align the input stream wrt padding */
1049 /* returns a non-floating GVariant! */
1051 parse_value_from_blob (GMemoryInputStream *mis,
1052 GDataInputStream *dis,
1053 const GVariantType *type,
1054 gboolean just_align,
1059 GError *local_error;
1062 #ifdef DEBUG_SERIALIZER
1066 s = g_variant_type_dup_string (type);
1067 g_print ("%*sReading type %s from offset 0x%04x",
1070 (gint) g_seekable_tell (G_SEEKABLE (mis)));
1073 #endif /* DEBUG_SERIALIZER */
1079 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
1081 if (!ensure_input_padding (mis, 4, &local_error))
1086 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1087 if (local_error != NULL)
1089 ret = g_variant_new_boolean (v);
1092 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1097 v = g_data_input_stream_read_byte (dis, NULL, &local_error);
1098 if (local_error != NULL)
1100 ret = g_variant_new_byte (v);
1103 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
1105 if (!ensure_input_padding (mis, 2, &local_error))
1110 v = g_data_input_stream_read_int16 (dis, NULL, &local_error);
1111 if (local_error != NULL)
1113 ret = g_variant_new_int16 (v);
1116 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
1118 if (!ensure_input_padding (mis, 2, &local_error))
1123 v = g_data_input_stream_read_uint16 (dis, NULL, &local_error);
1124 if (local_error != NULL)
1126 ret = g_variant_new_uint16 (v);
1129 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
1131 if (!ensure_input_padding (mis, 4, &local_error))
1136 v = g_data_input_stream_read_int32 (dis, NULL, &local_error);
1137 if (local_error != NULL)
1139 ret = g_variant_new_int32 (v);
1142 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
1144 if (!ensure_input_padding (mis, 4, &local_error))
1149 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1150 if (local_error != NULL)
1152 ret = g_variant_new_uint32 (v);
1155 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
1157 if (!ensure_input_padding (mis, 8, &local_error))
1162 v = g_data_input_stream_read_int64 (dis, NULL, &local_error);
1163 if (local_error != NULL)
1165 ret = g_variant_new_int64 (v);
1168 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
1170 if (!ensure_input_padding (mis, 8, &local_error))
1175 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
1176 if (local_error != NULL)
1178 ret = g_variant_new_uint64 (v);
1181 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
1183 if (!ensure_input_padding (mis, 8, &local_error))
1189 G_STATIC_ASSERT (sizeof (gdouble) == sizeof (guint64));
1190 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
1191 if (local_error != NULL)
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);
1529 is_leaf = is_leaf; /* To avoid -Wunused-but-set-variable */
1530 #endif /* DEBUG_SERIALIZER */
1532 /* sink the reference */
1535 g_assert (g_variant_is_floating (ret));
1536 g_variant_ref_sink (ret);
1541 #ifdef DEBUG_SERIALIZER
1543 "%*sFAILURE: %s (%s, %d)\n",
1545 local_error->message,
1546 g_quark_to_string (local_error->domain),
1548 #endif /* DEBUG_SERIALIZER */
1549 g_propagate_error (error, local_error);
1553 /* ---------------------------------------------------------------------------------------------------- */
1555 /* message_header must be at least 16 bytes */
1558 * g_dbus_message_bytes_needed:
1559 * @blob: A blob represent a binary D-Bus message.
1560 * @blob_len: The length of @blob (must be at least 16).
1561 * @error: Return location for error or %NULL.
1563 * Utility function to calculate how many bytes are needed to
1564 * completely deserialize the D-Bus message stored at @blob.
1566 * Returns: Number of bytes needed or -1 if @error is set (e.g. if
1567 * @blob contains invalid data or not enough data is available to
1568 * determine the size).
1573 g_dbus_message_bytes_needed (guchar *blob,
1581 g_return_val_if_fail (blob != NULL, -1);
1582 g_return_val_if_fail (error == NULL || *error == NULL, -1);
1583 g_return_val_if_fail (blob_len >= 16, -1);
1587 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1588 ret = 12 + 4 + GUINT32_FROM_LE (((guint32 *) blob)[3]);
1589 /* round up so it's a multiple of 8 */
1590 ret = 8 * ((ret + 7)/8);
1591 /* finally add the body size */
1592 ret += GUINT32_FROM_LE (((guint32 *) blob)[1]);
1594 else if (blob[0] == 'B')
1596 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1597 ret = 12 + 4 + GUINT32_FROM_BE (((guint32 *) blob)[3]);
1598 /* round up so it's a multiple of 8 */
1599 ret = 8 * ((ret + 7)/8);
1600 /* finally add the body size */
1601 ret += GUINT32_FROM_BE (((guint32 *) blob)[1]);
1607 G_IO_ERROR_INVALID_ARGUMENT,
1608 "Unable to determine message blob length - given blob is malformed");
1615 G_IO_ERROR_INVALID_ARGUMENT,
1616 "Blob indicates that message exceeds maximum message length (128MiB)");
1623 /* ---------------------------------------------------------------------------------------------------- */
1626 * g_dbus_message_new_from_blob:
1627 * @blob: A blob represent a binary D-Bus message.
1628 * @blob_len: The length of @blob.
1629 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
1630 * @error: Return location for error or %NULL.
1632 * Creates a new #GDBusMessage from the data stored at @blob. The byte
1633 * order that the message was in can be retrieved using
1634 * g_dbus_message_get_byte_order().
1636 * Returns: A new #GDBusMessage or %NULL if @error is set. Free with
1642 g_dbus_message_new_from_blob (guchar *blob,
1644 GDBusCapabilityFlags capabilities,
1648 GMemoryInputStream *mis;
1649 GDataInputStream *dis;
1650 GDBusMessage *message;
1652 guchar major_protocol_version;
1653 GDataStreamByteOrder byte_order;
1654 guint32 message_body_len;
1658 GVariant *signature;
1660 /* TODO: check against @capabilities */
1664 g_return_val_if_fail (blob != NULL, NULL);
1665 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1666 g_return_val_if_fail (blob_len >= 12, NULL);
1668 message = g_dbus_message_new ();
1670 mis = G_MEMORY_INPUT_STREAM (g_memory_input_stream_new_from_data (blob, blob_len, NULL));
1671 dis = g_data_input_stream_new (G_INPUT_STREAM (mis));
1673 endianness = g_data_input_stream_read_byte (dis, NULL, NULL);
1677 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1678 message->byte_order = G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN;
1681 byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
1682 message->byte_order = G_DBUS_MESSAGE_BYTE_ORDER_BIG_ENDIAN;
1687 G_IO_ERROR_INVALID_ARGUMENT,
1688 _("Invalid endianness value. Expected 0x6c ('l') or 0x42 ('B') but found value 0x%02x"),
1692 g_data_input_stream_set_byte_order (dis, byte_order);
1694 message->type = g_data_input_stream_read_byte (dis, NULL, NULL);
1695 message->flags = g_data_input_stream_read_byte (dis, NULL, NULL);
1696 major_protocol_version = g_data_input_stream_read_byte (dis, NULL, NULL);
1697 if (major_protocol_version != 1)
1701 G_IO_ERROR_INVALID_ARGUMENT,
1702 _("Invalid major protocol version. Expected 1 but found %d"),
1703 major_protocol_version);
1706 message_body_len = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1707 message->serial = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1709 #ifdef DEBUG_SERIALIZER
1710 g_print ("Parsing blob (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1713 s = _g_dbus_hexdump ((const gchar *) blob, blob_len, 2);
1714 g_print ("%s\n", s);
1717 #endif /* DEBUG_SERIALIZER */
1719 #ifdef DEBUG_SERIALIZER
1720 g_print ("Parsing headers (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1721 #endif /* DEBUG_SERIALIZER */
1722 headers = parse_value_from_blob (mis,
1724 G_VARIANT_TYPE ("a{yv}"),
1728 if (headers == NULL)
1730 g_variant_iter_init (&iter, headers);
1731 while ((item = g_variant_iter_next_value (&iter)) != NULL)
1733 guchar header_field;
1735 g_variant_get (item,
1739 g_dbus_message_set_header (message, header_field, value);
1740 g_variant_unref (value);
1741 g_variant_unref (item);
1743 g_variant_unref (headers);
1745 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
1746 if (signature != NULL)
1748 const gchar *signature_str;
1749 gsize signature_str_len;
1751 signature_str = g_variant_get_string (signature, &signature_str_len);
1753 /* signature but no body */
1754 if (message_body_len == 0 && signature_str_len > 0)
1758 G_IO_ERROR_INVALID_ARGUMENT,
1759 _("Signature header with signature `%s' found but message body is empty"),
1763 else if (signature_str_len > 0)
1765 GVariantType *variant_type;
1766 gchar *tupled_signature_str;
1768 if (!g_variant_is_signature (signature_str))
1772 G_IO_ERROR_INVALID_ARGUMENT,
1773 _("Parsed value `%s' is not a valid D-Bus signature (for body)"),
1777 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
1778 variant_type = g_variant_type_new (tupled_signature_str);
1779 g_free (tupled_signature_str);
1780 #ifdef DEBUG_SERIALIZER
1781 g_print ("Parsing body (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1782 #endif /* DEBUG_SERIALIZER */
1783 message->body = parse_value_from_blob (mis,
1789 g_variant_type_free (variant_type);
1790 if (message->body == NULL)
1796 /* no signature, this is only OK if the body is empty */
1797 if (message_body_len != 0)
1799 /* G_GUINT32_FORMAT doesn't work with gettext, just use %u */
1802 G_IO_ERROR_INVALID_ARGUMENT,
1803 _("No signature header in message but the message body is %u bytes"),
1809 if (!validate_headers (message, error))
1811 g_prefix_error (error, _("Cannot deserialize message: "));
1818 g_object_unref (dis);
1819 g_object_unref (mis);
1827 if (message != NULL)
1828 g_object_unref (message);
1833 /* ---------------------------------------------------------------------------------------------------- */
1836 ensure_output_padding (GMemoryOutputStream *mos,
1837 GDataOutputStream *dos,
1841 gsize wanted_offset;
1842 gsize padding_needed;
1845 offset = g_memory_output_stream_get_data_size (mos);
1846 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
1847 padding_needed = wanted_offset - offset;
1849 for (n = 0; n < padding_needed; n++)
1850 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1852 return padding_needed;
1855 /* note that value can be NULL for e.g. empty arrays - type is never NULL */
1857 append_value_to_blob (GVariant *value,
1858 const GVariantType *type,
1859 GMemoryOutputStream *mos,
1860 GDataOutputStream *dos,
1861 gsize *out_padding_added,
1864 gsize padding_added;
1868 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
1870 padding_added = ensure_output_padding (mos, dos, 4);
1873 gboolean v = g_variant_get_boolean (value);
1874 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1877 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1881 guint8 v = g_variant_get_byte (value);
1882 g_data_output_stream_put_byte (dos, v, NULL, NULL);
1885 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
1887 padding_added = ensure_output_padding (mos, dos, 2);
1890 gint16 v = g_variant_get_int16 (value);
1891 g_data_output_stream_put_int16 (dos, v, NULL, NULL);
1894 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
1896 padding_added = ensure_output_padding (mos, dos, 2);
1899 guint16 v = g_variant_get_uint16 (value);
1900 g_data_output_stream_put_uint16 (dos, v, NULL, NULL);
1903 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
1905 padding_added = ensure_output_padding (mos, dos, 4);
1908 gint32 v = g_variant_get_int32 (value);
1909 g_data_output_stream_put_int32 (dos, v, NULL, NULL);
1912 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
1914 padding_added = ensure_output_padding (mos, dos, 4);
1917 guint32 v = g_variant_get_uint32 (value);
1918 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1921 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
1923 padding_added = ensure_output_padding (mos, dos, 8);
1926 gint64 v = g_variant_get_int64 (value);
1927 g_data_output_stream_put_int64 (dos, v, NULL, NULL);
1930 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
1932 padding_added = ensure_output_padding (mos, dos, 8);
1935 guint64 v = g_variant_get_uint64 (value);
1936 g_data_output_stream_put_uint64 (dos, v, NULL, NULL);
1939 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
1941 padding_added = ensure_output_padding (mos, dos, 8);
1945 gdouble v = g_variant_get_double (value);
1946 G_STATIC_ASSERT (sizeof (gdouble) == sizeof (guint64));
1947 encoded = (guint64 *) &v;
1948 g_data_output_stream_put_uint64 (dos, *encoded, NULL, NULL);
1951 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
1953 padding_added = ensure_output_padding (mos, dos, 4);
1959 v = g_variant_get_string (value, &len);
1960 g_assert (g_utf8_validate (v, -1, &end) && (end == v + len));
1961 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1962 g_data_output_stream_put_string (dos, v, NULL, NULL);
1963 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1966 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
1968 padding_added = ensure_output_padding (mos, dos, 4);
1972 const gchar *v = g_variant_get_string (value, &len);
1973 g_assert (g_variant_is_object_path (v));
1974 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1975 g_data_output_stream_put_string (dos, v, NULL, NULL);
1976 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1979 else if (g_variant_type_equal (type, G_VARIANT_TYPE_SIGNATURE))
1984 const gchar *v = g_variant_get_string (value, &len);
1985 g_assert (g_variant_is_signature (v));
1986 g_data_output_stream_put_byte (dos, len, NULL, NULL);
1987 g_data_output_stream_put_string (dos, v, NULL, NULL);
1988 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1991 else if (g_variant_type_equal (type, G_VARIANT_TYPE_HANDLE))
1993 padding_added = ensure_output_padding (mos, dos, 4);
1996 gint32 v = g_variant_get_handle (value);
1997 g_data_output_stream_put_int32 (dos, v, NULL, NULL);
2000 else if (g_variant_type_is_array (type))
2004 goffset array_len_offset;
2005 goffset array_payload_begin_offset;
2009 padding_added = ensure_output_padding (mos, dos, 4);
2012 /* array length - will be filled in later */
2013 array_len_offset = g_memory_output_stream_get_data_size (mos);
2014 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
2016 /* From the D-Bus spec:
2018 * "A UINT32 giving the length of the array data in bytes,
2019 * followed by alignment padding to the alignment boundary of
2020 * the array element type, followed by each array element. The
2021 * array length is from the end of the alignment padding to
2022 * the end of the last element, i.e. it does not include the
2023 * padding after the length, or any padding after the last
2026 * Thus, we need to count how much padding the first element
2027 * contributes and subtract that from the array length.
2029 array_payload_begin_offset = g_memory_output_stream_get_data_size (mos);
2031 if (g_variant_n_children (value) == 0)
2033 gsize padding_added_for_item;
2034 if (!append_value_to_blob (NULL,
2035 g_variant_type_element (type),
2038 &padding_added_for_item,
2041 array_payload_begin_offset += padding_added_for_item;
2047 g_variant_iter_init (&iter, value);
2048 while ((item = g_variant_iter_next_value (&iter)) != NULL)
2050 gsize padding_added_for_item;
2051 if (!append_value_to_blob (item,
2052 g_variant_get_type (item),
2055 &padding_added_for_item,
2058 g_variant_unref (item);
2061 g_variant_unref (item);
2064 array_payload_begin_offset += padding_added_for_item;
2070 cur_offset = g_memory_output_stream_get_data_size (mos);
2072 array_len = cur_offset - array_payload_begin_offset;
2074 if (!g_seekable_seek (G_SEEKABLE (mos), array_len_offset, G_SEEK_SET, NULL, error))
2077 g_data_output_stream_put_uint32 (dos, array_len, NULL, NULL);
2079 if (!g_seekable_seek (G_SEEKABLE (mos), cur_offset, G_SEEK_SET, NULL, error))
2083 else if (g_variant_type_is_dict_entry (type) || g_variant_type_is_tuple (type))
2085 padding_added = ensure_output_padding (mos, dos, 8);
2090 g_variant_iter_init (&iter, value);
2091 while ((item = g_variant_iter_next_value (&iter)) != NULL)
2093 if (!append_value_to_blob (item,
2094 g_variant_get_type (item),
2100 g_variant_unref (item);
2103 g_variant_unref (item);
2107 else if (g_variant_type_is_variant (type))
2112 const gchar *signature;
2113 child = g_variant_get_child_value (value, 0);
2114 signature = g_variant_get_type_string (child);
2115 g_data_output_stream_put_byte (dos, strlen (signature), NULL, NULL);
2116 g_data_output_stream_put_string (dos, signature, NULL, NULL);
2117 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
2118 if (!append_value_to_blob (child,
2119 g_variant_get_type (child),
2125 g_variant_unref (child);
2128 g_variant_unref (child);
2135 G_IO_ERROR_INVALID_ARGUMENT,
2136 _("Error serializing GVariant with type string `%s' to the D-Bus wire format"),
2137 g_variant_get_type_string (value));
2141 if (out_padding_added != NULL)
2142 *out_padding_added = padding_added;
2151 append_body_to_blob (GVariant *value,
2152 GMemoryOutputStream *mos,
2153 GDataOutputStream *dos,
2159 if (!g_variant_is_of_type (value, G_VARIANT_TYPE_TUPLE))
2163 G_IO_ERROR_INVALID_ARGUMENT,
2164 "Expected a tuple for the body of the GDBusMessage.");
2168 g_variant_iter_init (&iter, value);
2169 while ((item = g_variant_iter_next_value (&iter)) != NULL)
2171 if (!append_value_to_blob (item,
2172 g_variant_get_type (item),
2178 g_variant_unref (item);
2181 g_variant_unref (item);
2189 /* ---------------------------------------------------------------------------------------------------- */
2192 * g_dbus_message_to_blob:
2193 * @message: A #GDBusMessage.
2194 * @out_size: Return location for size of generated blob.
2195 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
2196 * @error: Return location for error.
2198 * Serializes @message to a blob. The byte order returned by
2199 * g_dbus_message_get_byte_order() will be used.
2201 * Returns: A pointer to a valid binary D-Bus message of @out_size bytes
2202 * generated by @message or %NULL if @error is set. Free with g_free().
2207 g_dbus_message_to_blob (GDBusMessage *message,
2209 GDBusCapabilityFlags capabilities,
2212 GMemoryOutputStream *mos;
2213 GDataOutputStream *dos;
2216 GDataStreamByteOrder byte_order;
2217 goffset body_len_offset;
2218 goffset body_start_offset;
2220 GVariant *header_fields;
2221 GVariantBuilder builder;
2222 GHashTableIter hash_iter;
2224 GVariant *header_value;
2225 GVariant *signature;
2226 const gchar *signature_str;
2227 gint num_fds_in_message;
2228 gint num_fds_according_to_header;
2230 /* TODO: check against @capabilities */
2234 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2235 g_return_val_if_fail (out_size != NULL, NULL);
2236 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2238 mos = G_MEMORY_OUTPUT_STREAM (g_memory_output_stream_new (NULL, 0, g_realloc, g_free));
2239 dos = g_data_output_stream_new (G_OUTPUT_STREAM (mos));
2241 byte_order = G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN;
2242 switch (message->byte_order)
2244 case G_DBUS_MESSAGE_BYTE_ORDER_BIG_ENDIAN:
2245 byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
2247 case G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN:
2248 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
2251 g_data_output_stream_set_byte_order (dos, byte_order);
2254 g_data_output_stream_put_byte (dos, (guchar) message->byte_order, NULL, NULL);
2255 g_data_output_stream_put_byte (dos, message->type, NULL, NULL);
2256 g_data_output_stream_put_byte (dos, message->flags, NULL, NULL);
2257 g_data_output_stream_put_byte (dos, 1, NULL, NULL); /* major protocol version */
2258 body_len_offset = g_memory_output_stream_get_data_size (mos);
2259 /* body length - will be filled in later */
2260 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
2261 g_data_output_stream_put_uint32 (dos, message->serial, NULL, NULL);
2263 num_fds_in_message = 0;
2265 if (message->fd_list != NULL)
2266 num_fds_in_message = g_unix_fd_list_get_length (message->fd_list);
2268 num_fds_according_to_header = g_dbus_message_get_num_unix_fds (message);
2269 if (num_fds_in_message != num_fds_according_to_header)
2273 G_IO_ERROR_INVALID_ARGUMENT,
2274 _("Message has %d fds but the header field indicates %d fds"),
2276 num_fds_according_to_header);
2280 if (!validate_headers (message, error))
2282 g_prefix_error (error, _("Cannot serialize message: "));
2286 g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{yv}"));
2287 g_hash_table_iter_init (&hash_iter, message->headers);
2288 while (g_hash_table_iter_next (&hash_iter, &key, (gpointer) &header_value))
2290 g_variant_builder_add (&builder,
2292 (guchar) GPOINTER_TO_UINT (key),
2295 header_fields = g_variant_builder_end (&builder);
2297 if (!append_value_to_blob (header_fields,
2298 g_variant_get_type (header_fields),
2303 g_variant_unref (header_fields);
2306 g_variant_unref (header_fields);
2308 /* header size must be a multiple of 8 */
2309 ensure_output_padding (mos, dos, 8);
2311 body_start_offset = g_memory_output_stream_get_data_size (mos);
2313 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2314 signature_str = NULL;
2315 if (signature != NULL)
2316 signature_str = g_variant_get_string (signature, NULL);
2317 if (message->body != NULL)
2319 gchar *tupled_signature_str;
2320 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
2321 if (signature == NULL)
2325 G_IO_ERROR_INVALID_ARGUMENT,
2326 _("Message body has signature `%s' but there is no signature header"),
2328 g_free (tupled_signature_str);
2331 else if (g_strcmp0 (tupled_signature_str, g_variant_get_type_string (message->body)) != 0)
2335 G_IO_ERROR_INVALID_ARGUMENT,
2336 _("Message body has type signature `%s' but signature in the header field is `%s'"),
2337 tupled_signature_str, g_variant_get_type_string (message->body));
2338 g_free (tupled_signature_str);
2341 g_free (tupled_signature_str);
2342 if (!append_body_to_blob (message->body, mos, dos, error))
2347 if (signature != NULL && strlen (signature_str) > 0)
2351 G_IO_ERROR_INVALID_ARGUMENT,
2352 _("Message body is empty but signature in the header field is `(%s)'"),
2358 /* OK, we're done writing the message - set the body length */
2359 size = g_memory_output_stream_get_data_size (mos);
2360 body_size = size - body_start_offset;
2362 if (!g_seekable_seek (G_SEEKABLE (mos), body_len_offset, G_SEEK_SET, NULL, error))
2365 g_data_output_stream_put_uint32 (dos, body_size, NULL, NULL);
2367 if (!g_output_stream_close (G_OUTPUT_STREAM (dos), NULL, error))
2371 ret = g_memory_output_stream_steal_data (mos);
2374 g_object_unref (dos);
2375 g_object_unref (mos);
2380 /* ---------------------------------------------------------------------------------------------------- */
2383 get_uint32_header (GDBusMessage *message,
2384 GDBusMessageHeaderField header_field)
2390 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2391 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_UINT32))
2392 ret = g_variant_get_uint32 (value);
2397 static const gchar *
2398 get_string_header (GDBusMessage *message,
2399 GDBusMessageHeaderField header_field)
2405 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2406 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
2407 ret = g_variant_get_string (value, NULL);
2412 static const gchar *
2413 get_object_path_header (GDBusMessage *message,
2414 GDBusMessageHeaderField header_field)
2420 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2421 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_OBJECT_PATH))
2422 ret = g_variant_get_string (value, NULL);
2427 static const gchar *
2428 get_signature_header (GDBusMessage *message,
2429 GDBusMessageHeaderField header_field)
2435 value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2436 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_SIGNATURE))
2437 ret = g_variant_get_string (value, NULL);
2442 /* ---------------------------------------------------------------------------------------------------- */
2445 set_uint32_header (GDBusMessage *message,
2446 GDBusMessageHeaderField header_field,
2449 g_dbus_message_set_header (message,
2451 g_variant_new_uint32 (value));
2455 set_string_header (GDBusMessage *message,
2456 GDBusMessageHeaderField header_field,
2459 g_dbus_message_set_header (message,
2461 value == NULL ? NULL : g_variant_new_string (value));
2465 set_object_path_header (GDBusMessage *message,
2466 GDBusMessageHeaderField header_field,
2469 g_dbus_message_set_header (message,
2471 value == NULL ? NULL : g_variant_new_object_path (value));
2475 set_signature_header (GDBusMessage *message,
2476 GDBusMessageHeaderField header_field,
2479 g_dbus_message_set_header (message,
2481 value == NULL ? NULL : g_variant_new_signature (value));
2484 /* ---------------------------------------------------------------------------------------------------- */
2487 * g_dbus_message_get_reply_serial:
2488 * @message: A #GDBusMessage.
2490 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2492 * Returns: The value.
2497 g_dbus_message_get_reply_serial (GDBusMessage *message)
2499 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2500 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL);
2504 * g_dbus_message_set_reply_serial:
2505 * @message: A #GDBusMessage.
2506 * @value: The value to set.
2508 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2513 g_dbus_message_set_reply_serial (GDBusMessage *message,
2516 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2517 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL, value);
2520 /* ---------------------------------------------------------------------------------------------------- */
2523 * g_dbus_message_get_interface:
2524 * @message: A #GDBusMessage.
2526 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2528 * Returns: The value.
2533 g_dbus_message_get_interface (GDBusMessage *message)
2535 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2536 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE);
2540 * g_dbus_message_set_interface:
2541 * @message: A #GDBusMessage.
2542 * @value: The value to set.
2544 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2549 g_dbus_message_set_interface (GDBusMessage *message,
2552 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2553 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2554 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE, value);
2557 /* ---------------------------------------------------------------------------------------------------- */
2560 * g_dbus_message_get_member:
2561 * @message: A #GDBusMessage.
2563 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2565 * Returns: The value.
2570 g_dbus_message_get_member (GDBusMessage *message)
2572 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2573 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER);
2577 * g_dbus_message_set_member:
2578 * @message: A #GDBusMessage.
2579 * @value: The value to set.
2581 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2586 g_dbus_message_set_member (GDBusMessage *message,
2589 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2590 g_return_if_fail (value == NULL || g_dbus_is_member_name (value));
2591 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER, value);
2594 /* ---------------------------------------------------------------------------------------------------- */
2597 * g_dbus_message_get_path:
2598 * @message: A #GDBusMessage.
2600 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2602 * Returns: The value.
2607 g_dbus_message_get_path (GDBusMessage *message)
2609 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2610 return get_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH);
2614 * g_dbus_message_set_path:
2615 * @message: A #GDBusMessage.
2616 * @value: The value to set.
2618 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2623 g_dbus_message_set_path (GDBusMessage *message,
2626 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2627 g_return_if_fail (value == NULL || g_variant_is_object_path (value));
2628 set_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH, value);
2631 /* ---------------------------------------------------------------------------------------------------- */
2634 * g_dbus_message_get_sender:
2635 * @message: A #GDBusMessage.
2637 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2639 * Returns: The value.
2644 g_dbus_message_get_sender (GDBusMessage *message)
2646 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2647 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER);
2651 * g_dbus_message_set_sender:
2652 * @message: A #GDBusMessage.
2653 * @value: The value to set.
2655 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2660 g_dbus_message_set_sender (GDBusMessage *message,
2663 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2664 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2665 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER, value);
2668 /* ---------------------------------------------------------------------------------------------------- */
2671 * g_dbus_message_get_destination:
2672 * @message: A #GDBusMessage.
2674 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2676 * Returns: The value.
2681 g_dbus_message_get_destination (GDBusMessage *message)
2683 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2684 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION);
2688 * g_dbus_message_set_destination:
2689 * @message: A #GDBusMessage.
2690 * @value: The value to set.
2692 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2697 g_dbus_message_set_destination (GDBusMessage *message,
2700 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2701 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2702 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION, value);
2705 /* ---------------------------------------------------------------------------------------------------- */
2708 * g_dbus_message_get_error_name:
2709 * @message: A #GDBusMessage.
2711 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2713 * Returns: The value.
2718 g_dbus_message_get_error_name (GDBusMessage *message)
2720 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2721 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME);
2725 * g_dbus_message_set_error_name:
2726 * @message: A #GDBusMessage.
2727 * @value: The value to set.
2729 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2734 g_dbus_message_set_error_name (GDBusMessage *message,
2737 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2738 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2739 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME, value);
2742 /* ---------------------------------------------------------------------------------------------------- */
2745 * g_dbus_message_get_signature:
2746 * @message: A #GDBusMessage.
2748 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2750 * Returns: The value.
2755 g_dbus_message_get_signature (GDBusMessage *message)
2758 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2759 ret = get_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2766 * g_dbus_message_set_signature:
2767 * @message: A #GDBusMessage.
2768 * @value: The value to set.
2770 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2775 g_dbus_message_set_signature (GDBusMessage *message,
2778 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2779 g_return_if_fail (value == NULL || g_variant_is_signature (value));
2780 set_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE, value);
2783 /* ---------------------------------------------------------------------------------------------------- */
2786 * g_dbus_message_get_arg0:
2787 * @message: A #GDBusMessage.
2789 * Convenience to get the first item in the body of @message.
2791 * Returns: The string item or %NULL if the first item in the body of
2792 * @message is not a string.
2797 g_dbus_message_get_arg0 (GDBusMessage *message)
2801 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2805 if (message->body != NULL && g_variant_is_of_type (message->body, G_VARIANT_TYPE_TUPLE))
2808 item = g_variant_get_child_value (message->body, 0);
2809 if (g_variant_is_of_type (item, G_VARIANT_TYPE_STRING))
2810 ret = g_variant_get_string (item, NULL);
2811 g_variant_unref (item);
2817 /* ---------------------------------------------------------------------------------------------------- */
2820 * g_dbus_message_get_num_unix_fds:
2821 * @message: A #GDBusMessage.
2823 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2825 * Returns: The value.
2830 g_dbus_message_get_num_unix_fds (GDBusMessage *message)
2832 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2833 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS);
2837 * g_dbus_message_set_num_unix_fds:
2838 * @message: A #GDBusMessage.
2839 * @value: The value to set.
2841 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2846 g_dbus_message_set_num_unix_fds (GDBusMessage *message,
2849 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2850 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS, value);
2853 /* ---------------------------------------------------------------------------------------------------- */
2856 * g_dbus_message_to_gerror:
2857 * @message: A #GDBusMessage.
2858 * @error: The #GError to set.
2860 * If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does
2861 * nothing and returns %FALSE.
2863 * Otherwise this method encodes the error in @message as a #GError
2864 * using g_dbus_error_set_dbus_error() using the information in the
2865 * %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of @message as
2866 * well as the first string item in @message's body.
2868 * Returns: %TRUE if @error was set, %FALSE otherwise.
2873 g_dbus_message_to_gerror (GDBusMessage *message,
2877 const gchar *error_name;
2879 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2882 if (message->type != G_DBUS_MESSAGE_TYPE_ERROR)
2885 error_name = g_dbus_message_get_error_name (message);
2886 if (error_name != NULL)
2890 body = g_dbus_message_get_body (message);
2892 if (body != NULL && g_variant_is_of_type (body, G_VARIANT_TYPE ("(s)")))
2894 const gchar *error_message;
2895 g_variant_get (body, "(&s)", &error_message);
2896 g_dbus_error_set_dbus_error (error,
2903 /* these two situations are valid, yet pretty rare */
2906 g_dbus_error_set_dbus_error (error,
2909 _("Error return with body of type `%s'"),
2910 g_variant_get_type_string (body));
2914 g_dbus_error_set_dbus_error (error,
2917 _("Error return with empty body"));
2923 /* TOOD: this shouldn't happen - should check this at message serialization
2924 * time and disconnect the peer.
2929 "Error return without error-name header!");
2938 /* ---------------------------------------------------------------------------------------------------- */
2941 flags_to_string (GType flags_type, guint value)
2947 klass = g_type_class_ref (flags_type);
2948 s = g_string_new (NULL);
2949 for (n = 0; n < 32; n++)
2951 if ((value & (1<<n)) != 0)
2953 GFlagsValue *flags_value;
2954 flags_value = g_flags_get_first_value (klass, (1<<n));
2956 g_string_append_c (s, ',');
2957 if (flags_value != NULL)
2958 g_string_append (s, flags_value->value_nick);
2960 g_string_append_printf (s, "unknown (bit %d)", n);
2964 g_string_append (s, "none");
2965 g_type_class_unref (klass);
2966 return g_string_free (s, FALSE);
2970 _sort_keys_func (gconstpointer a,
2976 ia = GPOINTER_TO_INT (a);
2977 ib = GPOINTER_TO_INT (b);
2983 * g_dbus_message_print:
2984 * @message: A #GDBusMessage.
2985 * @indent: Indentation level.
2987 * Produces a human-readable multi-line description of @message.
2989 * The contents of the description has no ABI guarantees, the contents
2990 * and formatting is subject to change at any time. Typical output
2991 * looks something like this:
2998 * path -> objectpath '/org/gtk/GDBus/TestObject'
2999 * interface -> 'org.gtk.GDBus.TestInterface'
3000 * member -> 'GimmeStdout'
3001 * destination -> ':1.146'
3003 * UNIX File Descriptors:
3008 * Type: method-return
3009 * Flags: no-reply-expected
3013 * reply-serial -> uint32 4
3014 * destination -> ':1.159'
3015 * sender -> ':1.146'
3016 * num-unix-fds -> uint32 1
3018 * UNIX File Descriptors:
3019 * fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635
3022 * Returns: A string that should be freed with g_free().
3027 g_dbus_message_print (GDBusMessage *message,
3035 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
3037 str = g_string_new (NULL);
3039 s = _g_dbus_enum_to_string (G_TYPE_DBUS_MESSAGE_TYPE, message->type);
3040 g_string_append_printf (str, "%*sType: %s\n", indent, "", s);
3042 s = flags_to_string (G_TYPE_DBUS_MESSAGE_FLAGS, message->flags);
3043 g_string_append_printf (str, "%*sFlags: %s\n", indent, "", s);
3045 g_string_append_printf (str, "%*sVersion: %d\n", indent, "", message->major_protocol_version);
3046 g_string_append_printf (str, "%*sSerial: %d\n", indent, "", message->serial);
3048 g_string_append_printf (str, "%*sHeaders:\n", indent, "");
3049 keys = g_hash_table_get_keys (message->headers);
3050 keys = g_list_sort (keys, _sort_keys_func);
3053 for (l = keys; l != NULL; l = l->next)
3055 gint key = GPOINTER_TO_INT (l->data);
3059 value = g_hash_table_lookup (message->headers, l->data);
3060 g_assert (value != NULL);
3062 s = _g_dbus_enum_to_string (G_TYPE_DBUS_MESSAGE_HEADER_FIELD, key);
3063 value_str = g_variant_print (value, TRUE);
3064 g_string_append_printf (str, "%*s %s -> %s\n", indent, "", s, value_str);
3071 g_string_append_printf (str, "%*s (none)\n", indent, "");
3073 g_string_append_printf (str, "%*sBody: ", indent, "");
3074 if (message->body != NULL)
3076 g_variant_print_string (message->body,
3082 g_string_append (str, "()");
3084 g_string_append (str, "\n");
3086 g_string_append_printf (str, "%*sUNIX File Descriptors:\n", indent, "");
3087 if (message->fd_list != NULL)
3093 fds = g_unix_fd_list_peek_fds (message->fd_list, &num_fds);
3096 for (n = 0; n < num_fds; n++)
3099 struct stat statbuf;
3100 fs = g_string_new (NULL);
3101 if (fstat (fds[n], &statbuf) == 0)
3103 g_string_append_printf (fs, "%s" "dev=%d:%d", fs->len > 0 ? "," : "",
3104 major (statbuf.st_dev), minor (statbuf.st_dev));
3105 g_string_append_printf (fs, "%s" "mode=0%o", fs->len > 0 ? "," : "",
3107 g_string_append_printf (fs, "%s" "ino=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3108 (guint64) statbuf.st_ino);
3109 g_string_append_printf (fs, "%s" "uid=%d", fs->len > 0 ? "," : "",
3111 g_string_append_printf (fs, "%s" "gid=%d", fs->len > 0 ? "," : "",
3113 g_string_append_printf (fs, "%s" "rdev=%d:%d", fs->len > 0 ? "," : "",
3114 major (statbuf.st_rdev), minor (statbuf.st_rdev));
3115 g_string_append_printf (fs, "%s" "size=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3116 (guint64) statbuf.st_size);
3117 g_string_append_printf (fs, "%s" "atime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3118 (guint64) statbuf.st_atime);
3119 g_string_append_printf (fs, "%s" "mtime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3120 (guint64) statbuf.st_mtime);
3121 g_string_append_printf (fs, "%s" "ctime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3122 (guint64) statbuf.st_ctime);
3126 g_string_append_printf (fs, "(fstat failed: %s)", strerror (errno));
3128 g_string_append_printf (str, "%*s fd %d: %s\n", indent, "", fds[n], fs->str);
3129 g_string_free (fs, TRUE);
3134 g_string_append_printf (str, "%*s (empty)\n", indent, "");
3139 g_string_append_printf (str, "%*s (none)\n", indent, "");
3143 return g_string_free (str, FALSE);
3147 * g_dbus_message_get_locked:
3148 * @message: A #GDBusMessage.
3150 * Checks whether @message is locked. To monitor changes to this
3151 * value, conncet to the #GObject::notify signal to listen for changes
3152 * on the #GDBusMessage:locked property.
3154 * Returns: %TRUE if @message is locked, %FALSE otherwise.
3159 g_dbus_message_get_locked (GDBusMessage *message)
3161 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
3162 return message->locked;
3166 * g_dbus_message_lock:
3167 * @message: A #GDBusMessage.
3169 * If @message is locked, does nothing. Otherwise locks the message.
3174 g_dbus_message_lock (GDBusMessage *message)
3176 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
3178 if (message->locked)
3181 message->locked = TRUE;
3182 g_object_notify (G_OBJECT (message), "locked");
3189 * g_dbus_message_copy:
3190 * @message: A #GDBusMessage.
3191 * @error: Return location for error or %NULL.
3193 * Copies @message. The copy is a deep copy and the returned
3194 * #GDBusMessage is completely identical except that it is guaranteed
3197 * This operation can fail if e.g. @message contains file descriptors
3198 * and the per-process or system-wide open files limit is reached.
3200 * Returns: (transfer full): A new #GDBusMessage or %NULL if @error is set.
3201 * Free with g_object_unref().
3206 g_dbus_message_copy (GDBusMessage *message,
3210 GHashTableIter iter;
3211 gpointer header_key;
3212 GVariant *header_value;
3214 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
3215 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3217 ret = g_dbus_message_new ();
3218 ret->type = message->type;
3219 ret->flags = message->flags;
3220 ret->byte_order = message->byte_order;
3221 ret->major_protocol_version = message->major_protocol_version;
3222 ret->serial = message->serial;
3225 if (message->fd_list != NULL)
3231 ret->fd_list = g_unix_fd_list_new ();
3232 fds = g_unix_fd_list_peek_fds (message->fd_list, &num_fds);
3233 for (n = 0; n < num_fds; n++)
3235 if (g_unix_fd_list_append (ret->fd_list,
3239 g_object_unref (ret);
3247 /* see https://bugzilla.gnome.org/show_bug.cgi?id=624546#c8 for why it's fine
3248 * to just ref (as opposed to deep-copying) the GVariant instances
3250 ret->body = message->body != NULL ? g_variant_ref (message->body) : NULL;
3251 g_hash_table_iter_init (&iter, message->headers);
3252 while (g_hash_table_iter_next (&iter, &header_key, (gpointer) &header_value))
3253 g_hash_table_insert (ret->headers, header_key, g_variant_ref (header_value));