1 /* GDBus - GLib D-Bus Library
3 * Copyright (C) 2008-2009 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>
27 #include "gdbusutils.h"
28 #include "gdbusmessage.h"
29 #include "gdbuserror.h"
30 #include "gioenumtypes.h"
31 #include "ginputstream.h"
32 #include "gdatainputstream.h"
33 #include "gmemoryinputstream.h"
34 #include "goutputstream.h"
35 #include "gdataoutputstream.h"
36 #include "gmemoryoutputstream.h"
37 #include "gseekable.h"
41 #include <sys/types.h>
51 * SECTION:gdbusmessage
52 * @short_description: D-Bus Message
55 * A type for representing D-Bus messages that can be sent or received
56 * on a #GDBusConnection.
59 struct _GDBusMessagePrivate
61 GDBusMessageType type;
62 GDBusMessageFlags flags;
63 guchar major_protocol_version;
72 G_DEFINE_TYPE (GDBusMessage, g_dbus_message, G_TYPE_OBJECT);
75 g_dbus_message_finalize (GObject *object)
77 GDBusMessage *message = G_DBUS_MESSAGE (object);
79 if (message->priv->headers != NULL)
80 g_hash_table_unref (message->priv->headers);
81 if (message->priv->body != NULL)
82 g_variant_unref (message->priv->body);
84 if (message->priv->fd_list != NULL)
85 g_object_unref (message->priv->fd_list);
88 if (G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize != NULL)
89 G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize (object);
93 g_dbus_message_class_init (GDBusMessageClass *klass)
95 GObjectClass *gobject_class;
97 g_type_class_add_private (klass, sizeof (GDBusMessagePrivate));
99 gobject_class = G_OBJECT_CLASS (klass);
101 gobject_class->finalize = g_dbus_message_finalize;
105 g_dbus_message_init (GDBusMessage *message)
107 message->priv = G_TYPE_INSTANCE_GET_PRIVATE (message, G_TYPE_DBUS_MESSAGE, GDBusMessagePrivate);
109 message->priv->headers = g_hash_table_new_full (g_direct_hash,
112 (GDestroyNotify) g_variant_unref);
116 * g_dbus_message_new:
118 * Creates a new empty #GDBusMessage.
120 * Returns: A #GDBusMessage. Free with g_object_unref().
125 g_dbus_message_new (void)
127 return g_object_new (G_TYPE_DBUS_MESSAGE, NULL);
131 * g_dbus_message_new_method_call:
132 * @name: A valid D-Bus name or %NULL.
133 * @path: A valid object path.
134 * @interface: A valid D-Bus interface name or %NULL.
135 * @method: A valid method name.
137 * Creates a new #GDBusMessage for a method call.
139 * Returns: A #GDBusMessage. Free with g_object_unref().
144 g_dbus_message_new_method_call (const gchar *name,
146 const gchar *interface,
149 GDBusMessage *message;
151 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
152 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
153 g_return_val_if_fail (g_dbus_is_member_name (method), NULL);
154 g_return_val_if_fail (interface == NULL || g_dbus_is_interface_name (interface), NULL);
156 message = g_dbus_message_new ();
157 message->priv->type = G_DBUS_MESSAGE_TYPE_METHOD_CALL;
160 g_dbus_message_set_destination (message, name);
161 g_dbus_message_set_path (message, path);
162 g_dbus_message_set_member (message, method);
163 if (interface != NULL)
164 g_dbus_message_set_interface (message, interface);
170 * g_dbus_message_new_signal:
171 * @path: A valid object path.
172 * @interface: A valid D-Bus interface name or %NULL.
173 * @signal: A valid signal name.
175 * Creates a new #GDBusMessage for a signal emission.
177 * Returns: A #GDBusMessage. Free with g_object_unref().
182 g_dbus_message_new_signal (const gchar *path,
183 const gchar *interface,
186 GDBusMessage *message;
188 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
189 g_return_val_if_fail (g_dbus_is_member_name (signal), NULL);
190 g_return_val_if_fail (interface == NULL || g_dbus_is_interface_name (interface), NULL);
192 message = g_dbus_message_new ();
193 message->priv->type = G_DBUS_MESSAGE_TYPE_SIGNAL;
194 message->priv->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
196 g_dbus_message_set_path (message, path);
197 g_dbus_message_set_member (message, signal);
199 if (interface != NULL)
200 g_dbus_message_set_interface (message, interface);
207 * g_dbus_message_new_method_reply:
208 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
209 * create a reply message to.
211 * Creates a new #GDBusMessage that is a reply to @method_call_message.
213 * Returns: A #GDBusMessage. Free with g_object_unref().
218 g_dbus_message_new_method_reply (GDBusMessage *method_call_message)
220 GDBusMessage *message;
223 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
224 g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
225 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
227 message = g_dbus_message_new ();
228 message->priv->type = G_DBUS_MESSAGE_TYPE_METHOD_RETURN;
229 message->priv->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
231 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
232 sender = g_dbus_message_get_sender (method_call_message);
234 g_dbus_message_set_destination (message, sender);
240 * g_dbus_message_new_method_error:
241 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
242 * create a reply message to.
243 * @error_name: A valid D-Bus error name.
244 * @error_message_format: The D-Bus error message in a printf() format.
245 * @...: Arguments for @error_message_format.
247 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
249 * Returns: A #GDBusMessage. Free with g_object_unref().
254 g_dbus_message_new_method_error (GDBusMessage *method_call_message,
255 const gchar *error_name,
256 const gchar *error_message_format,
262 va_start (var_args, error_message_format);
263 ret = g_dbus_message_new_method_error_valist (method_call_message,
265 error_message_format,
273 * g_dbus_message_new_method_error_literal:
274 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
275 * create a reply message to.
276 * @error_name: A valid D-Bus error name.
277 * @error_message: The D-Bus error message.
279 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
281 * Returns: A #GDBusMessage. Free with g_object_unref().
286 g_dbus_message_new_method_error_literal (GDBusMessage *method_call_message,
287 const gchar *error_name,
288 const gchar *error_message)
290 GDBusMessage *message;
293 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
294 g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
295 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
296 g_return_val_if_fail (g_dbus_is_name (error_name), NULL);
297 g_return_val_if_fail (error_message != NULL, NULL);
299 message = g_dbus_message_new ();
300 message->priv->type = G_DBUS_MESSAGE_TYPE_ERROR;
301 message->priv->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
303 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
304 g_dbus_message_set_error_name (message, error_name);
305 g_dbus_message_set_body (message, g_variant_new ("(s)", error_message));
307 sender = g_dbus_message_get_sender (method_call_message);
309 g_dbus_message_set_destination (message, sender);
315 * g_dbus_message_new_method_error_valist:
316 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
317 * create a reply message to.
318 * @error_name: A valid D-Bus error name.
319 * @error_message_format: The D-Bus error message in a printf() format.
320 * @var_args: Arguments for @error_message_format.
322 * Like g_dbus_message_new_method_error() but intended for language bindings.
324 * Returns: A #GDBusMessage. Free with g_object_unref().
329 g_dbus_message_new_method_error_valist (GDBusMessage *method_call_message,
330 const gchar *error_name,
331 const gchar *error_message_format,
335 gchar *error_message;
336 error_message = g_strdup_vprintf (error_message_format, var_args);
337 ret = g_dbus_message_new_method_error_literal (method_call_message,
340 g_free (error_message);
344 /* ---------------------------------------------------------------------------------------------------- */
346 /* TODO: need GI annotations to specify that any guchar value goes for the type */
349 * g_dbus_message_get_message_type:
350 * @message: A #GDBusMessage.
352 * Gets the type of @message.
354 * Returns: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
359 g_dbus_message_get_message_type (GDBusMessage *message)
361 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_TYPE_INVALID);
362 return message->priv->type;
366 * g_dbus_message_set_message_type:
367 * @message: A #GDBusMessage.
368 * @type: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
370 * Sets @message to be of @type.
375 g_dbus_message_set_message_type (GDBusMessage *message,
376 GDBusMessageType type)
378 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
379 g_return_if_fail (type >=0 && type < 256);
380 message->priv->type = type;
383 /* ---------------------------------------------------------------------------------------------------- */
385 /* TODO: need GI annotations to specify that any guchar value goes for flags */
388 * g_dbus_message_get_flags:
389 * @message: A #GDBusMessage.
391 * Gets the flags for @message.
393 * Returns: Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).
398 g_dbus_message_get_flags (GDBusMessage *message)
400 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_FLAGS_NONE);
401 return message->priv->flags;
405 * g_dbus_message_set_flags:
406 * @message: A #GDBusMessage.
407 * @flags: Flags for @message that are set (typically values from the #GDBusMessageFlags
408 * enumeration bitwise ORed together).
410 * Sets the flags to set on @message.
415 g_dbus_message_set_flags (GDBusMessage *message,
416 GDBusMessageFlags flags)
418 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
419 g_return_if_fail (flags >=0 && flags < 256);
420 message->priv->flags = flags;
423 /* ---------------------------------------------------------------------------------------------------- */
426 * g_dbus_message_get_serial:
427 * @message: A #GDBusMessage.
429 * Gets the serial for @message.
431 * Returns: A #guint32.
436 g_dbus_message_get_serial (GDBusMessage *message)
438 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
439 return message->priv->serial;
443 * g_dbus_message_set_serial:
444 * @message: A #GDBusMessage.
445 * @serial: A #guint32.
447 * Sets the serial for @message.
452 g_dbus_message_set_serial (GDBusMessage *message,
455 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
456 message->priv->serial = serial;
459 /* ---------------------------------------------------------------------------------------------------- */
461 /* TODO: need GI annotations to specify that any guchar value goes for header_field */
464 * g_dbus_message_get_header:
465 * @message: A #GDBusMessage.
466 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
468 * Gets a header field on @message.
470 * Returns: A #GVariant with the value if the header was found, %NULL
471 * otherwise. Do not free, it is owned by @message.
476 g_dbus_message_get_header (GDBusMessage *message,
477 GDBusMessageHeaderField header_field)
479 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
480 g_return_val_if_fail (header_field >=0 && header_field < 256, NULL);
481 return g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
485 * g_dbus_message_set_header:
486 * @message: A #GDBusMessage.
487 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
488 * @value: A #GVariant to set the header field or %NULL to clear the header field.
490 * Sets a header field on @message.
492 * If @value is floating, @message assumes ownership of @value.
497 g_dbus_message_set_header (GDBusMessage *message,
498 GDBusMessageHeaderField header_field,
501 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
502 g_return_if_fail (header_field >=0 && header_field < 256);
505 g_hash_table_remove (message->priv->headers, GUINT_TO_POINTER (header_field));
509 g_hash_table_insert (message->priv->headers, GUINT_TO_POINTER (header_field), g_variant_ref_sink (value));
514 * g_dbus_message_get_header_fields:
515 * @message: A #GDBusMessage.
517 * Gets an array of all header fields on @message that are set.
519 * Returns: An array of header fields terminated by
520 * %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a
521 * #guchar. Free with g_free().
526 g_dbus_message_get_header_fields (GDBusMessage *message)
534 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
536 keys = g_hash_table_get_keys (message->priv->headers);
537 num_keys = g_list_length (keys);
538 ret = g_new (guchar, num_keys + 1);
539 for (l = keys, n = 0; l != NULL; l = l->next, n++)
540 ret[n] = GPOINTER_TO_UINT (l->data);
541 g_assert (n == num_keys);
542 ret[n] = G_DBUS_MESSAGE_HEADER_FIELD_INVALID;
548 /* ---------------------------------------------------------------------------------------------------- */
551 * g_dbus_message_get_body:
552 * @message: A #GDBusMessage.
554 * Gets the body of a message.
556 * Returns: A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message.
561 g_dbus_message_get_body (GDBusMessage *message)
563 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
564 return message->priv->body;
568 * g_dbus_message_set_body:
569 * @message: A #GDBusMessage.
570 * @body: Either %NULL or a #GVariant that is a tuple.
572 * Sets the body @message. As a side-effect the
573 * %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the
574 * type string of @body (or cleared if @body is %NULL).
576 * If @body is floating, @message assumes ownership of @body.
581 g_dbus_message_set_body (GDBusMessage *message,
584 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
585 g_return_if_fail ((body == NULL) || g_variant_is_of_type (body, G_VARIANT_TYPE_TUPLE));
587 if (message->priv->body != NULL)
588 g_variant_unref (message->priv->body);
591 message->priv->body = NULL;
592 g_dbus_message_set_signature (message, NULL);
596 const gchar *type_string;
597 gsize type_string_len;
600 message->priv->body = g_variant_ref_sink (body);
602 type_string = g_variant_get_type_string (body);
603 type_string_len = strlen (type_string);
604 g_assert (type_string_len >= 2);
605 signature = g_strndup (type_string + 1, type_string_len - 2);
606 g_dbus_message_set_signature (message, signature);
611 /* ---------------------------------------------------------------------------------------------------- */
615 * g_dbus_message_get_unix_fd_list:
616 * @message: A #GDBusMessage.
618 * Gets the UNIX file descriptors associated with @message, if any.
620 * This method is only available on UNIX.
622 * Returns: A #GUnixFDList or %NULL if no file descriptors are
623 * associated. Do not free, this object is owned by @message.
628 g_dbus_message_get_unix_fd_list (GDBusMessage *message)
630 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
631 return message->priv->fd_list;
635 * g_dbus_message_set_unix_fd_list:
636 * @message: A #GDBusMessage.
637 * @fd_list: A #GUnixFDList or %NULL.
639 * Sets the UNIX file descriptors associated with @message. As a
640 * side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header
641 * field is set to the number of fds in @fd_list (or cleared if
642 * @fd_list is %NULL).
644 * This method is only available on UNIX.
649 g_dbus_message_set_unix_fd_list (GDBusMessage *message,
650 GUnixFDList *fd_list)
652 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
653 g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
654 if (message->priv->fd_list != NULL)
655 g_object_unref (message->priv->fd_list);
658 message->priv->fd_list = g_object_ref (fd_list);
659 g_dbus_message_set_num_unix_fds (message, g_unix_fd_list_get_length (fd_list));
663 message->priv->fd_list = NULL;
664 g_dbus_message_set_num_unix_fds (message, 0);
669 /* ---------------------------------------------------------------------------------------------------- */
672 ensure_input_padding (GMemoryInputStream *mis,
679 offset = g_seekable_tell (G_SEEKABLE (mis));
680 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
682 return g_seekable_seek (G_SEEKABLE (mis), wanted_offset, G_SEEK_SET, NULL, error);
686 read_string (GMemoryInputStream *mis,
687 GDataInputStream *dis,
697 s = g_string_new (NULL);
700 while (remaining > 0)
705 to_read = MIN (remaining, sizeof (buf));
706 num_read = g_input_stream_read (G_INPUT_STREAM (mis),
717 G_IO_ERROR_INVALID_ARGUMENT,
718 _("Wanted to read %" G_GSIZE_FORMAT " bytes but got EOF"),
723 remaining -= num_read;
724 g_string_append_len (s, buf, num_read);
728 nul = g_data_input_stream_read_byte (dis, NULL, &local_error);
729 if (local_error != NULL)
731 g_propagate_error (error, local_error);
738 G_IO_ERROR_INVALID_ARGUMENT,
739 _("Expected NUL byte after the string `%s' but found `%c' (%d)"),
744 return g_string_free (s, FALSE);
747 g_string_free (s, TRUE);
752 parse_value_from_blob (GMemoryInputStream *mis,
753 GDataInputStream *dis,
754 const GVariantType *type,
761 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
764 if (!ensure_input_padding (mis, 4, &local_error))
766 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
767 if (local_error != NULL)
769 ret = g_variant_new_boolean (v);
771 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
774 v = g_data_input_stream_read_byte (dis, NULL, &local_error);
775 if (local_error != NULL)
777 ret = g_variant_new_byte (v);
779 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
782 if (!ensure_input_padding (mis, 2, &local_error))
784 v = g_data_input_stream_read_int16 (dis, NULL, &local_error);
785 if (local_error != NULL)
787 ret = g_variant_new_int16 (v);
789 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
792 if (!ensure_input_padding (mis, 2, &local_error))
794 v = g_data_input_stream_read_uint16 (dis, NULL, &local_error);
795 if (local_error != NULL)
797 ret = g_variant_new_uint16 (v);
799 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
802 if (!ensure_input_padding (mis, 4, &local_error))
804 v = g_data_input_stream_read_int32 (dis, NULL, &local_error);
805 if (local_error != NULL)
807 ret = g_variant_new_int32 (v);
809 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
812 if (!ensure_input_padding (mis, 4, &local_error))
814 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
815 if (local_error != NULL)
817 ret = g_variant_new_uint32 (v);
819 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
822 if (!ensure_input_padding (mis, 8, &local_error))
824 v = g_data_input_stream_read_int64 (dis, NULL, &local_error);
825 if (local_error != NULL)
827 ret = g_variant_new_int64 (v);
829 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
832 if (!ensure_input_padding (mis, 8, &local_error))
834 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
835 if (local_error != NULL)
837 ret = g_variant_new_uint64 (v);
839 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
843 if (!ensure_input_padding (mis, 8, &local_error))
845 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
846 if (local_error != NULL)
849 encoded = (gdouble *) &v;
850 ret = g_variant_new_double (*encoded);
852 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
856 if (!ensure_input_padding (mis, 4, &local_error))
858 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
859 if (local_error != NULL)
861 v = read_string (mis, dis, (gsize) len, &local_error);
864 ret = g_variant_new_string (v);
866 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
870 if (!ensure_input_padding (mis, 4, &local_error))
872 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
873 if (local_error != NULL)
875 v = read_string (mis, dis, (gsize) len, &local_error);
878 if (!g_variant_is_object_path (v))
880 g_set_error (&local_error,
882 G_IO_ERROR_INVALID_ARGUMENT,
883 _("Parsed value `%s' is not a valid D-Bus object path"),
887 ret = g_variant_new_object_path (v);
889 else if (g_variant_type_equal (type, G_VARIANT_TYPE_SIGNATURE))
893 len = g_data_input_stream_read_byte (dis, NULL, &local_error);
894 if (local_error != NULL)
896 v = read_string (mis, dis, (gsize) len, &local_error);
899 if (!g_variant_is_signature (v))
901 g_set_error (&local_error,
903 G_IO_ERROR_INVALID_ARGUMENT,
904 _("Parsed value `%s' is not a valid D-Bus signature"),
908 ret = g_variant_new_signature (v);
910 else if (g_variant_type_is_array (type))
915 const GVariantType *element_type;
916 GVariantBuilder *builder;
918 if (!ensure_input_padding (mis, 4, &local_error))
920 array_len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
922 if (array_len > (2<<26))
924 g_set_error (&local_error,
926 G_IO_ERROR_INVALID_ARGUMENT,
927 _("Encountered array of length %" G_GUINT32_FORMAT " bytes. Maximum length is 2<<26 bytes."),
932 builder = g_variant_builder_new (type);
933 element_type = g_variant_type_element (type);
935 /* TODO: optimize array of primitive types */
937 offset = g_seekable_tell (G_SEEKABLE (mis));
938 target = offset + array_len;
939 while (offset < target)
942 item = parse_value_from_blob (mis, dis, element_type, &local_error);
945 g_variant_builder_unref (builder);
948 g_variant_builder_add_value (builder, item);
949 offset = g_seekable_tell (G_SEEKABLE (mis));
952 ret = g_variant_builder_end (builder);
954 else if (g_variant_type_is_dict_entry (type))
956 const GVariantType *key_type;
957 const GVariantType *value_type;
961 if (!ensure_input_padding (mis, 8, &local_error))
964 key_type = g_variant_type_key (type);
965 key = parse_value_from_blob (mis, dis, key_type, &local_error);
969 value_type = g_variant_type_value (type);
970 value = parse_value_from_blob (mis, dis, value_type, &local_error);
973 g_variant_unref (key);
976 ret = g_variant_new_dict_entry (key, value);
978 else if (g_variant_type_is_tuple (type))
980 const GVariantType *element_type;
981 GVariantBuilder *builder;
983 if (!ensure_input_padding (mis, 8, &local_error))
986 builder = g_variant_builder_new (type);
987 element_type = g_variant_type_first (type);
988 while (element_type != NULL)
991 item = parse_value_from_blob (mis, dis, element_type, &local_error);
994 g_variant_builder_unref (builder);
997 g_variant_builder_add_value (builder, item);
999 element_type = g_variant_type_next (element_type);
1001 ret = g_variant_builder_end (builder);
1003 else if (g_variant_type_is_variant (type))
1007 GVariantType *variant_type;
1010 siglen = g_data_input_stream_read_byte (dis, NULL, &local_error);
1011 if (local_error != NULL)
1013 sig = read_string (mis, dis, (gsize) siglen, &local_error);
1016 if (!g_variant_is_signature (sig))
1018 g_set_error (&local_error,
1020 G_IO_ERROR_INVALID_ARGUMENT,
1021 _("Parsed value `%s' for variant is not a valid D-Bus signature"),
1025 variant_type = g_variant_type_new (sig);
1026 value = parse_value_from_blob (mis, dis, variant_type, &local_error);
1027 g_variant_type_free (variant_type);
1030 ret = g_variant_new_variant (value);
1035 s = g_variant_type_dup_string (type);
1036 g_set_error (&local_error,
1038 G_IO_ERROR_INVALID_ARGUMENT,
1039 _("Error deserializing GVariant with type-string `%s' from the D-Bus wire format"),
1045 g_assert (ret != NULL);
1049 g_propagate_error (error, local_error);
1053 /* ---------------------------------------------------------------------------------------------------- */
1055 /* message_header must be at least 16 bytes */
1058 * g_dbus_message_bytes_needed:
1059 * @blob: A blob represent a binary D-Bus message.
1060 * @blob_len: The length of @blob (must be at least 16).
1061 * @error: Return location for error or %NULL.
1063 * Utility function to calculate how many bytes are needed to
1064 * completely deserialize the D-Bus message stored at @blob.
1066 * Returns: Number of bytes needed or -1 if @error is set (e.g. if
1067 * @blob contains invalid data or not enough data is available to
1068 * determine the size).
1073 g_dbus_message_bytes_needed (guchar *blob,
1081 g_return_val_if_fail (blob != NULL, -1);
1082 g_return_val_if_fail (error == NULL || *error == NULL, -1);
1083 g_return_val_if_fail (blob_len >= 16, -1);
1087 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1088 ret = 12 + 4 + GUINT32_FROM_LE (((guint32 *) blob)[3]);
1089 /* round up so it's a multiple of 8 */
1090 ret = 8 * ((ret + 7)/8);
1091 /* finally add the body size */
1092 ret += GUINT32_FROM_LE (((guint32 *) blob)[1]);
1094 else if (blob[0] == 'B')
1097 g_assert_not_reached ();
1103 G_IO_ERROR_INVALID_ARGUMENT,
1104 "Unable to determine message blob length - given blob is malformed");
1111 G_IO_ERROR_INVALID_ARGUMENT,
1112 "Blob indicates that message exceeds maximum message length (128MiB)");
1119 /* ---------------------------------------------------------------------------------------------------- */
1122 * g_dbus_message_new_from_blob:
1123 * @blob: A blob represent a binary D-Bus message.
1124 * @blob_len: The length of @blob.
1125 * @error: Return location for error or %NULL.
1127 * Creates a new #GDBusMessage from the data stored at @blob.
1129 * Returns: A new #GDBusMessage or %NULL if @error is set. Free with
1135 g_dbus_message_new_from_blob (guchar *blob,
1140 GMemoryInputStream *mis;
1141 GDataInputStream *dis;
1142 GDBusMessage *message;
1144 guchar major_protocol_version;
1145 GDataStreamByteOrder byte_order;
1146 guint32 message_body_len;
1150 GVariant *signature;
1154 g_return_val_if_fail (blob != NULL, NULL);
1155 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1156 g_return_val_if_fail (blob_len >= 12, NULL);
1158 message = g_dbus_message_new ();
1160 mis = G_MEMORY_INPUT_STREAM (g_memory_input_stream_new_from_data (blob, blob_len, NULL));
1161 dis = g_data_input_stream_new (G_INPUT_STREAM (mis));
1163 endianness = g_data_input_stream_read_byte (dis, NULL, NULL);
1167 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1170 byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
1175 G_IO_ERROR_INVALID_ARGUMENT,
1176 _("Invalid endianness value. Expected 'l' or 'B' but found '%c' (%d)"),
1177 endianness, endianness);
1180 g_data_input_stream_set_byte_order (dis, byte_order);
1182 message->priv->type = g_data_input_stream_read_byte (dis, NULL, NULL);
1183 message->priv->flags = g_data_input_stream_read_byte (dis, NULL, NULL);
1184 major_protocol_version = g_data_input_stream_read_byte (dis, NULL, NULL);
1185 if (major_protocol_version != 1)
1189 G_IO_ERROR_INVALID_ARGUMENT,
1190 _("Invalid major protocol version. Expected 1 but found %d"),
1191 major_protocol_version);
1194 message_body_len = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1195 message->priv->serial = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1197 headers = parse_value_from_blob (mis,
1199 G_VARIANT_TYPE ("a{yv}"),
1201 if (headers == NULL)
1203 g_variant_ref_sink (headers);
1204 g_variant_iter_init (&iter, headers);
1205 while ((item = g_variant_iter_next_value (&iter)))
1207 guchar header_field;
1209 g_variant_get (item,
1213 g_dbus_message_set_header (message, header_field, value);
1215 g_variant_unref (headers);
1217 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
1218 if (signature != NULL)
1220 const gchar *signature_str;
1221 gsize signature_str_len;
1223 signature_str = g_variant_get_string (signature, NULL);
1224 signature_str_len = strlen (signature_str);
1226 /* signature but no body */
1227 if (message_body_len == 0 && signature_str_len > 0)
1231 G_IO_ERROR_INVALID_ARGUMENT,
1232 _("Signature header with signature `%s' found but message body is empty"),
1236 else if (signature_str_len > 0)
1238 GVariantType *variant_type;
1239 gchar *tupled_signature_str;
1241 if (!g_variant_is_signature (signature_str))
1245 G_IO_ERROR_INVALID_ARGUMENT,
1246 _("Parsed value `%s' is not a valid D-Bus signature (for body)"),
1250 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
1251 variant_type = g_variant_type_new (tupled_signature_str);
1252 g_free (tupled_signature_str);
1253 message->priv->body = parse_value_from_blob (mis,
1257 if (message->priv->body == NULL)
1259 g_variant_type_free (variant_type);
1262 g_variant_ref_sink (message->priv->body);
1263 g_variant_type_free (variant_type);
1268 /* no signature, this is only OK if the body is empty */
1269 if (message_body_len != 0)
1273 G_IO_ERROR_INVALID_ARGUMENT,
1274 _("No signature header in message but the message body is %" G_GUINT32_FORMAT " bytes"),
1284 g_object_unref (dis);
1285 g_object_unref (mis);
1293 if (message != NULL)
1294 g_object_unref (message);
1299 /* ---------------------------------------------------------------------------------------------------- */
1302 ensure_output_padding (GMemoryOutputStream *mos,
1303 GDataOutputStream *dos,
1307 gsize wanted_offset;
1308 gsize padding_needed;
1311 offset = g_memory_output_stream_get_data_size (mos);
1312 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
1313 padding_needed = wanted_offset - offset;
1315 for (n = 0; n < padding_needed; n++)
1316 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1318 return padding_needed;
1322 append_value_to_blob (GVariant *value,
1323 GMemoryOutputStream *mos,
1324 GDataOutputStream *dos,
1325 gsize *out_padding_added,
1328 const GVariantType *type;
1329 gsize padding_added;
1333 type = g_variant_get_type (value);
1334 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
1336 gboolean v = g_variant_get_boolean (value);
1337 padding_added = ensure_output_padding (mos, dos, 4);
1338 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1340 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1342 guint8 v = g_variant_get_byte (value);
1343 g_data_output_stream_put_byte (dos, v, NULL, NULL);
1345 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
1347 gint16 v = g_variant_get_int16 (value);
1348 padding_added = ensure_output_padding (mos, dos, 2);
1349 g_data_output_stream_put_int16 (dos, v, NULL, NULL);
1351 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
1353 guint16 v = g_variant_get_uint16 (value);
1354 padding_added = ensure_output_padding (mos, dos, 2);
1355 g_data_output_stream_put_uint16 (dos, v, NULL, NULL);
1357 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
1359 gint32 v = g_variant_get_int32 (value);
1360 padding_added = ensure_output_padding (mos, dos, 4);
1361 g_data_output_stream_put_int32 (dos, v, NULL, NULL);
1363 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
1365 guint32 v = g_variant_get_uint32 (value);
1366 padding_added = ensure_output_padding (mos, dos, 4);
1367 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1369 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
1371 gint64 v = g_variant_get_int64 (value);
1372 padding_added = ensure_output_padding (mos, dos, 8);
1373 g_data_output_stream_put_int64 (dos, v, NULL, NULL);
1375 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
1377 guint64 v = g_variant_get_uint64 (value);
1378 padding_added = ensure_output_padding (mos, dos, 8);
1379 g_data_output_stream_put_uint64 (dos, v, NULL, NULL);
1381 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
1384 gdouble v = g_variant_get_double (value);
1385 padding_added = ensure_output_padding (mos, dos, 8);
1387 encoded = (guint64 *) &v;
1388 g_data_output_stream_put_uint64 (dos, *encoded, NULL, NULL);
1390 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
1392 const gchar *v = g_variant_get_string (value, NULL);
1394 padding_added = ensure_output_padding (mos, dos, 4);
1396 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1397 g_data_output_stream_put_string (dos, v, NULL, NULL);
1398 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1400 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
1402 /* TODO: validate object path */
1403 const gchar *v = g_variant_get_string (value, NULL);
1405 padding_added = ensure_output_padding (mos, dos, 4);
1407 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1408 g_data_output_stream_put_string (dos, v, NULL, NULL);
1409 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1411 else if (g_variant_type_equal (type, G_VARIANT_TYPE_SIGNATURE))
1413 /* TODO: validate signature (including max len being 255) */
1414 const gchar *v = g_variant_get_string (value, NULL);
1417 g_data_output_stream_put_byte (dos, len, NULL, NULL);
1418 g_data_output_stream_put_string (dos, v, NULL, NULL);
1419 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1421 else if (g_variant_type_is_array (type))
1425 goffset array_len_offset;
1426 goffset array_payload_begin_offset;
1431 padding_added = ensure_output_padding (mos, dos, 4);
1433 /* array length - will be filled in later */
1434 array_len_offset = g_memory_output_stream_get_data_size (mos);
1435 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
1437 /* From the D-Bus spec:
1439 * "A UINT32 giving the length of the array data in bytes,
1440 * followed by alignment padding to the alignment boundary of
1441 * the array element type, followed by each array element. The
1442 * array length is from the end of the alignment padding to
1443 * the end of the last element, i.e. it does not include the
1444 * padding after the length, or any padding after the last
1447 * Thus, we need to count how much padding the first element
1448 * contributes and subtract that from the array length.
1450 array_payload_begin_offset = g_memory_output_stream_get_data_size (mos);
1452 g_variant_iter_init (&iter, value);
1454 while ((item = g_variant_iter_next_value (&iter)))
1456 gsize padding_added_for_item;
1457 if (!append_value_to_blob (item, mos, dos, &padding_added_for_item, error))
1461 array_payload_begin_offset += padding_added_for_item;
1466 cur_offset = g_memory_output_stream_get_data_size (mos);
1468 array_len = cur_offset - array_payload_begin_offset;
1470 if (!g_seekable_seek (G_SEEKABLE (mos), array_len_offset, G_SEEK_SET, NULL, error))
1473 g_data_output_stream_put_uint32 (dos, array_len, NULL, NULL);
1475 if (!g_seekable_seek (G_SEEKABLE (mos), cur_offset, G_SEEK_SET, NULL, error))
1478 else if (g_variant_type_is_dict_entry (type) || g_variant_type_is_tuple (type))
1483 padding_added = ensure_output_padding (mos, dos, 8);
1485 g_variant_iter_init (&iter, value);
1487 while ((item = g_variant_iter_next_value (&iter)))
1489 if (!append_value_to_blob (item, mos, dos, NULL, error))
1493 else if (g_variant_type_is_variant (type))
1496 const gchar *signature;
1497 child = g_variant_get_child_value (value, 0);
1498 signature = g_variant_get_type_string (child);
1499 /* TODO: validate signature (including max len being 255) */
1500 g_data_output_stream_put_byte (dos, strlen (signature), NULL, NULL);
1501 g_data_output_stream_put_string (dos, signature, NULL, NULL);
1502 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1503 if (!append_value_to_blob (child, mos, dos, NULL, error))
1505 g_variant_unref (child);
1508 g_variant_unref (child);
1514 G_IO_ERROR_INVALID_ARGUMENT,
1515 _("Error serializing GVariant with type-string `%s' to the D-Bus wire format"),
1516 g_variant_get_type_string (value));
1520 if (out_padding_added != NULL)
1521 *out_padding_added = padding_added;
1530 append_body_to_blob (GVariant *value,
1531 GMemoryOutputStream *mos,
1532 GDataOutputStream *dos,
1541 if (!g_variant_is_of_type (value, G_VARIANT_TYPE_TUPLE))
1545 G_IO_ERROR_INVALID_ARGUMENT,
1546 "Expected a tuple for the body of the GDBusMessage.");
1550 g_variant_iter_init (&iter, value);
1551 while ((item = g_variant_iter_next_value (&iter)))
1553 if (!append_value_to_blob (item, mos, dos, NULL, error))
1562 /* ---------------------------------------------------------------------------------------------------- */
1565 * g_dbus_message_to_blob:
1566 * @message: A #GDBusMessage.
1567 * @out_size: Return location for size of generated blob.
1568 * @error: Return location for error.
1570 * Serializes @message to a blob.
1572 * Returns: A pointer to a valid binary D-Bus message of @out_size bytes
1573 * generated by @message or %NULL if @error is set. Free with g_free().
1578 g_dbus_message_to_blob (GDBusMessage *message,
1582 GMemoryOutputStream *mos;
1583 GDataOutputStream *dos;
1586 GDataStreamByteOrder byte_order;
1587 goffset body_len_offset;
1588 goffset body_start_offset;
1590 GVariant *header_fields;
1591 GVariantBuilder *builder;
1592 GHashTableIter hash_iter;
1594 GVariant *header_value;
1595 GVariant *signature;
1596 const gchar *signature_str;
1597 gint num_fds_in_message;
1598 gint num_fds_according_to_header;
1602 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1603 g_return_val_if_fail (out_size != NULL, NULL);
1604 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1606 mos = G_MEMORY_OUTPUT_STREAM (g_memory_output_stream_new (NULL, 0, g_realloc, g_free));
1607 dos = g_data_output_stream_new (G_OUTPUT_STREAM (mos));
1609 /* TODO: detect endianess... */
1610 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1611 g_data_output_stream_set_byte_order (dos, byte_order);
1614 g_data_output_stream_put_byte (dos, byte_order == G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN ? 'l' : 'B', NULL, NULL);
1615 g_data_output_stream_put_byte (dos, message->priv->type, NULL, NULL);
1616 g_data_output_stream_put_byte (dos, message->priv->flags, NULL, NULL);
1617 g_data_output_stream_put_byte (dos, 1, NULL, NULL); /* major protocol version */
1618 body_len_offset = g_memory_output_stream_get_data_size (mos);
1619 /* body length - will be filled in later */
1620 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
1621 g_data_output_stream_put_uint32 (dos, message->priv->serial, NULL, NULL);
1623 num_fds_in_message = 0;
1625 if (message->priv->fd_list != NULL)
1626 num_fds_in_message = g_unix_fd_list_get_length (message->priv->fd_list);
1628 num_fds_according_to_header = g_dbus_message_get_num_unix_fds (message);
1629 /* TODO: check we have all the right header fields and that they are the correct value etc etc */
1630 if (num_fds_in_message != num_fds_according_to_header)
1634 G_IO_ERROR_INVALID_ARGUMENT,
1635 _("Message has %d fds but the header field indicates %d fds"),
1637 num_fds_according_to_header);
1641 builder = g_variant_builder_new (G_VARIANT_TYPE ("a{yv}"));//G_VARIANT_TYPE_ARRAY);
1642 g_hash_table_iter_init (&hash_iter, message->priv->headers);
1643 while (g_hash_table_iter_next (&hash_iter, &key, (gpointer) &header_value))
1645 g_variant_builder_add (builder,
1647 (guchar) GPOINTER_TO_UINT (key),
1650 header_fields = g_variant_new ("a{yv}", builder);
1652 if (!append_value_to_blob (header_fields, mos, dos, NULL, error))
1654 g_variant_unref (header_fields);
1657 g_variant_unref (header_fields);
1659 /* header size must be a multiple of 8 */
1660 ensure_output_padding (mos, dos, 8);
1662 body_start_offset = g_memory_output_stream_get_data_size (mos);
1664 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
1665 signature_str = NULL;
1666 if (signature != NULL)
1667 signature_str = g_variant_get_string (signature, NULL);
1668 if (message->priv->body != NULL)
1670 gchar *tupled_signature_str;
1671 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
1672 if (signature == NULL)
1676 G_IO_ERROR_INVALID_ARGUMENT,
1677 _("Message body has signature `%s' but there is no signature header"),
1679 g_free (tupled_signature_str);
1682 else if (g_strcmp0 (tupled_signature_str, g_variant_get_type_string (message->priv->body)) != 0)
1686 G_IO_ERROR_INVALID_ARGUMENT,
1687 _("Message body has type signature `%s' but signature in the header field is `%s'"),
1688 tupled_signature_str, g_variant_get_type_string (message->priv->body));
1689 g_free (tupled_signature_str);
1692 g_free (tupled_signature_str);
1693 if (!append_body_to_blob (message->priv->body, mos, dos, error))
1698 if (signature != NULL)
1702 G_IO_ERROR_INVALID_ARGUMENT,
1703 _("Message body is empty but signature in the header field is `(%s)'"),
1709 /* OK, we're done writing the message - set the body length */
1710 size = g_memory_output_stream_get_data_size (mos);
1711 body_size = size - body_start_offset;
1713 if (!g_seekable_seek (G_SEEKABLE (mos), body_len_offset, G_SEEK_SET, NULL, error))
1716 g_data_output_stream_put_uint32 (dos, body_size, NULL, NULL);
1719 ret = g_memdup (g_memory_output_stream_get_data (mos), size);
1722 g_object_unref (dos);
1723 g_object_unref (mos);
1728 /* ---------------------------------------------------------------------------------------------------- */
1731 get_uint32_header (GDBusMessage *message,
1732 GDBusMessageHeaderField header_field)
1738 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
1739 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_UINT32))
1740 ret = g_variant_get_uint32 (value);
1745 static const gchar *
1746 get_string_header (GDBusMessage *message,
1747 GDBusMessageHeaderField header_field)
1753 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
1754 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
1755 ret = g_variant_get_string (value, NULL);
1760 static const gchar *
1761 get_object_path_header (GDBusMessage *message,
1762 GDBusMessageHeaderField header_field)
1768 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
1769 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_OBJECT_PATH))
1770 ret = g_variant_get_string (value, NULL);
1775 static const gchar *
1776 get_signature_header (GDBusMessage *message,
1777 GDBusMessageHeaderField header_field)
1783 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
1784 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_SIGNATURE))
1785 ret = g_variant_get_string (value, NULL);
1790 /* ---------------------------------------------------------------------------------------------------- */
1793 set_uint32_header (GDBusMessage *message,
1794 GDBusMessageHeaderField header_field,
1797 g_dbus_message_set_header (message,
1799 g_variant_new_uint32 (value));
1803 set_string_header (GDBusMessage *message,
1804 GDBusMessageHeaderField header_field,
1807 g_dbus_message_set_header (message,
1809 value == NULL ? NULL : g_variant_new_string (value));
1813 set_object_path_header (GDBusMessage *message,
1814 GDBusMessageHeaderField header_field,
1817 g_dbus_message_set_header (message,
1819 value == NULL ? NULL : g_variant_new_object_path (value));
1823 set_signature_header (GDBusMessage *message,
1824 GDBusMessageHeaderField header_field,
1827 g_dbus_message_set_header (message,
1829 value == NULL ? NULL : g_variant_new_signature (value));
1832 /* ---------------------------------------------------------------------------------------------------- */
1835 * g_dbus_message_get_reply_serial:
1836 * @message: A #GDBusMessage.
1838 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
1840 * Returns: The value.
1845 g_dbus_message_get_reply_serial (GDBusMessage *message)
1847 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
1848 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL);
1852 * g_dbus_message_set_reply_serial:
1853 * @message: A #GDBusMessage.
1854 * @value: The value to set.
1856 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
1861 g_dbus_message_set_reply_serial (GDBusMessage *message,
1864 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1865 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL, value);
1868 /* ---------------------------------------------------------------------------------------------------- */
1871 * g_dbus_message_get_interface:
1872 * @message: A #GDBusMessage.
1874 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
1876 * Returns: The value.
1881 g_dbus_message_get_interface (GDBusMessage *message)
1883 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1884 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE);
1888 * g_dbus_message_set_interface:
1889 * @message: A #GDBusMessage.
1890 * @value: The value to set.
1892 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
1897 g_dbus_message_set_interface (GDBusMessage *message,
1900 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1901 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
1902 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE, value);
1905 /* ---------------------------------------------------------------------------------------------------- */
1908 * g_dbus_message_get_member:
1909 * @message: A #GDBusMessage.
1911 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
1913 * Returns: The value.
1918 g_dbus_message_get_member (GDBusMessage *message)
1920 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1921 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER);
1925 * g_dbus_message_set_member:
1926 * @message: A #GDBusMessage.
1927 * @value: The value to set.
1929 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
1934 g_dbus_message_set_member (GDBusMessage *message,
1937 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1938 g_return_if_fail (value == NULL || g_dbus_is_member_name (value));
1939 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER, value);
1942 /* ---------------------------------------------------------------------------------------------------- */
1945 * g_dbus_message_get_path:
1946 * @message: A #GDBusMessage.
1948 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
1950 * Returns: The value.
1955 g_dbus_message_get_path (GDBusMessage *message)
1957 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1958 return get_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH);
1962 * g_dbus_message_set_path:
1963 * @message: A #GDBusMessage.
1964 * @value: The value to set.
1966 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
1971 g_dbus_message_set_path (GDBusMessage *message,
1974 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1975 g_return_if_fail (value == NULL || g_variant_is_object_path (value));
1976 set_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH, value);
1979 /* ---------------------------------------------------------------------------------------------------- */
1982 * g_dbus_message_get_sender:
1983 * @message: A #GDBusMessage.
1985 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
1987 * Returns: The value.
1992 g_dbus_message_get_sender (GDBusMessage *message)
1994 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1995 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER);
1999 * g_dbus_message_set_sender:
2000 * @message: A #GDBusMessage.
2001 * @value: The value to set.
2003 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2008 g_dbus_message_set_sender (GDBusMessage *message,
2011 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2012 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2013 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER, value);
2016 /* ---------------------------------------------------------------------------------------------------- */
2019 * g_dbus_message_get_destination:
2020 * @message: A #GDBusMessage.
2022 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2024 * Returns: The value.
2029 g_dbus_message_get_destination (GDBusMessage *message)
2031 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2032 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION);
2036 * g_dbus_message_set_destination:
2037 * @message: A #GDBusMessage.
2038 * @value: The value to set.
2040 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2045 g_dbus_message_set_destination (GDBusMessage *message,
2048 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2049 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2050 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION, value);
2053 /* ---------------------------------------------------------------------------------------------------- */
2056 * g_dbus_message_get_error_name:
2057 * @message: A #GDBusMessage.
2059 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2061 * Returns: The value.
2066 g_dbus_message_get_error_name (GDBusMessage *message)
2068 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2069 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME);
2073 * g_dbus_message_set_error_name:
2074 * @message: A #GDBusMessage.
2075 * @value: The value to set.
2077 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2082 g_dbus_message_set_error_name (GDBusMessage *message,
2085 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2086 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2087 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME, value);
2090 /* ---------------------------------------------------------------------------------------------------- */
2093 * g_dbus_message_get_signature:
2094 * @message: A #GDBusMessage.
2096 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2098 * Returns: The value.
2103 g_dbus_message_get_signature (GDBusMessage *message)
2106 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2107 ret = get_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2114 * g_dbus_message_set_signature:
2115 * @message: A #GDBusMessage.
2116 * @value: The value to set.
2118 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2123 g_dbus_message_set_signature (GDBusMessage *message,
2126 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2127 g_return_if_fail (value == NULL || g_variant_is_signature (value));
2128 set_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE, value);
2131 /* ---------------------------------------------------------------------------------------------------- */
2134 * g_dbus_message_get_arg0:
2135 * @message: A #GDBusMessage.
2137 * Convenience to get the first item in the body of @message.
2139 * Returns: The string item or %NULL if the first item in the body of
2140 * @message is not a string.
2145 g_dbus_message_get_arg0 (GDBusMessage *message)
2149 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2153 if (message->priv->body != NULL && g_variant_is_of_type (message->priv->body, G_VARIANT_TYPE_TUPLE))
2156 item = g_variant_get_child_value (message->priv->body, 0);
2157 if (g_variant_is_of_type (item, G_VARIANT_TYPE_STRING))
2158 ret = g_variant_get_string (item, NULL);
2164 /* ---------------------------------------------------------------------------------------------------- */
2167 * g_dbus_message_get_num_unix_fds:
2168 * @message: A #GDBusMessage.
2170 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2172 * Returns: The value.
2177 g_dbus_message_get_num_unix_fds (GDBusMessage *message)
2179 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2180 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS);
2184 * g_dbus_message_set_num_unix_fds:
2185 * @message: A #GDBusMessage.
2186 * @value: The value to set.
2188 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2193 g_dbus_message_set_num_unix_fds (GDBusMessage *message,
2196 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2197 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS, value);
2200 /* ---------------------------------------------------------------------------------------------------- */
2203 * g_dbus_message_to_gerror:
2204 * @message: A #GDBusMessage.
2205 * @error: The #GError to set.
2207 * If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does
2208 * nothing and returns %FALSE.
2210 * Otherwise this method encodes the error in @message as a #GError
2211 * using g_dbus_error_set_dbus_error() using the information in the
2212 * %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of @message as
2213 * well as the first string item in @message's body.
2215 * Returns: %TRUE if @error was set, %FALSE otherwise.
2220 g_dbus_message_to_gerror (GDBusMessage *message,
2224 const gchar *error_name;
2226 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2229 if (message->priv->type != G_DBUS_MESSAGE_TYPE_ERROR)
2232 error_name = g_dbus_message_get_error_name (message);
2233 if (error_name != NULL)
2237 body = g_dbus_message_get_body (message);
2239 if (body != NULL && g_variant_is_of_type (body, G_VARIANT_TYPE ("(s)")))
2241 const gchar *error_message;
2242 g_variant_get (body, "(s)", &error_message);
2243 g_dbus_error_set_dbus_error (error,
2250 /* these two situations are valid, yet pretty rare */
2253 g_dbus_error_set_dbus_error (error,
2256 _("Error return with body of type `%s'"),
2257 g_variant_get_type_string (body));
2261 g_dbus_error_set_dbus_error (error,
2264 _("Error return with empty body"));
2270 /* TOOD: this shouldn't happen - should check this at message serialization
2271 * time and disconnect the peer.
2276 "Error return without error-name header!");
2285 /* ---------------------------------------------------------------------------------------------------- */
2288 enum_to_string (GType enum_type, gint value)
2292 GEnumValue *enum_value;
2294 klass = g_type_class_ref (enum_type);
2295 enum_value = g_enum_get_value (klass, value);
2296 if (enum_value != NULL)
2297 ret = g_strdup (enum_value->value_nick);
2299 ret = g_strdup_printf ("unknown (value %d)", value);
2300 g_type_class_unref (klass);
2305 flags_to_string (GType flags_type, guint value)
2311 klass = g_type_class_ref (flags_type);
2312 s = g_string_new (NULL);
2313 for (n = 0; n < 32; n++)
2315 if ((value & (1<<n)) != 0)
2317 GFlagsValue *flags_value;
2318 flags_value = g_flags_get_first_value (klass, (1<<n));
2320 g_string_append_c (s, ',');
2321 if (flags_value != NULL)
2322 g_string_append (s, flags_value->value_nick);
2324 g_string_append_printf (s, "unknown (bit %d)", n);
2328 g_string_append (s, "none");
2329 g_type_class_unref (klass);
2330 return g_string_free (s, FALSE);;
2334 _sort_keys_func (gconstpointer a,
2340 ia = GPOINTER_TO_INT (a);
2341 ib = GPOINTER_TO_INT (b);
2347 * g_dbus_message_print:
2348 * @message: A #GDBusMessage.
2349 * @indent: Indentation level.
2351 * Produces a human-readable multi-line description of @message.
2353 * The contents of the description has no ABI guarantees, the contents
2354 * and formatting is subject to change at any time. Typical output
2355 * looks something like this:
2362 * path -> objectpath '/org/gtk/GDBus/TestObject'
2363 * interface -> 'org.gtk.GDBus.TestInterface'
2364 * member -> 'GimmeStdout'
2365 * destination -> ':1.146'
2367 * UNIX File Descriptors:
2372 * Type: method-return
2373 * Flags: no-reply-expected
2377 * reply-serial -> uint32 4
2378 * destination -> ':1.159'
2379 * sender -> ':1.146'
2380 * num-unix-fds -> uint32 1
2382 * UNIX File Descriptors:
2383 * fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635
2386 * Returns: A string that should be freed with g_free().
2391 g_dbus_message_print (GDBusMessage *message,
2399 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2401 str = g_string_new (NULL);
2403 s = enum_to_string (G_TYPE_DBUS_MESSAGE_TYPE, message->priv->type);
2404 g_string_append_printf (str, "%*sType: %s\n", indent, "", s);
2406 s = flags_to_string (G_TYPE_DBUS_MESSAGE_FLAGS, message->priv->flags);
2407 g_string_append_printf (str, "%*sFlags: %s\n", indent, "", s);
2409 g_string_append_printf (str, "%*sVersion: %d\n", indent, "", message->priv->major_protocol_version);
2410 g_string_append_printf (str, "%*sSerial: %d\n", indent, "", message->priv->serial);
2412 g_string_append_printf (str, "%*sHeaders:\n", indent, "");
2413 keys = g_hash_table_get_keys (message->priv->headers);
2414 keys = g_list_sort (keys, _sort_keys_func);
2417 for (l = keys; l != NULL; l = l->next)
2419 gint key = GPOINTER_TO_INT (l->data);
2423 value = g_hash_table_lookup (message->priv->headers, l->data);
2424 g_assert (value != NULL);
2426 s = enum_to_string (G_TYPE_DBUS_MESSAGE_HEADER_FIELD, key);
2427 value_str = g_variant_print (value, TRUE);
2428 g_string_append_printf (str, "%*s %s -> %s\n", indent, "", s, value_str);
2435 g_string_append_printf (str, "%*s (none)\n", indent, "");
2437 g_string_append_printf (str, "%*sBody: ", indent, "");
2438 if (message->priv->body != NULL)
2440 g_variant_print_string (message->priv->body,
2446 g_string_append (str, "()");
2448 g_string_append (str, "\n");
2450 g_string_append_printf (str, "%*sUNIX File Descriptors:\n", indent, "");
2451 if (message->priv->fd_list != NULL)
2457 fds = g_unix_fd_list_peek_fds (message->priv->fd_list, &num_fds);
2460 for (n = 0; n < num_fds; n++)
2463 struct stat statbuf;
2464 fs = g_string_new (NULL);
2465 if (fstat (fds[n], &statbuf) == 0)
2467 g_string_append_printf (fs, "%s" "dev=%d:%d", fs->len > 0 ? "," : "",
2468 major (statbuf.st_dev), minor (statbuf.st_dev));
2469 g_string_append_printf (fs, "%s" "mode=0%o", fs->len > 0 ? "," : "",
2471 g_string_append_printf (fs, "%s" "ino=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2472 (guint64) statbuf.st_ino);
2473 g_string_append_printf (fs, "%s" "uid=%d", fs->len > 0 ? "," : "",
2475 g_string_append_printf (fs, "%s" "gid=%d", fs->len > 0 ? "," : "",
2477 g_string_append_printf (fs, "%s" "rdev=%d:%d", fs->len > 0 ? "," : "",
2478 major (statbuf.st_rdev), minor (statbuf.st_rdev));
2479 g_string_append_printf (fs, "%s" "size=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2480 (guint64) statbuf.st_size);
2481 g_string_append_printf (fs, "%s" "atime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2482 (guint64) statbuf.st_atime);
2483 g_string_append_printf (fs, "%s" "mtime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2484 (guint64) statbuf.st_mtime);
2485 g_string_append_printf (fs, "%s" "ctime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2486 (guint64) statbuf.st_ctime);
2490 g_string_append_printf (fs, "(fstat failed: %s)", strerror (errno));
2492 g_string_append_printf (str, "%*s fd %d: %s\n", indent, "", fds[n], fs->str);
2493 g_string_free (fs, TRUE);
2498 g_string_append_printf (str, "%*s (empty)\n", indent, "");
2503 g_string_append_printf (str, "%*s (none)\n", indent, "");
2507 return g_string_free (str, FALSE);
2511 #define __G_DBUS_MESSAGE_C__
2512 #include "gioaliasdef.c"