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>
27 #include <sys/types.h>
33 #include "gdbusutils.h"
34 #include "gdbusmessage.h"
35 #include "gdbuserror.h"
36 #include "gioenumtypes.h"
37 #include "ginputstream.h"
38 #include "gdatainputstream.h"
39 #include "gmemoryinputstream.h"
40 #include "goutputstream.h"
41 #include "gdataoutputstream.h"
42 #include "gmemoryoutputstream.h"
43 #include "gseekable.h"
47 #include "gunixfdlist.h"
54 * SECTION:gdbusmessage
55 * @short_description: D-Bus Message
58 * A type for representing D-Bus messages that can be sent or received
59 * on a #GDBusConnection.
62 struct _GDBusMessagePrivate
64 GDBusMessageType type;
65 GDBusMessageFlags flags;
66 guchar major_protocol_version;
75 G_DEFINE_TYPE (GDBusMessage, g_dbus_message, G_TYPE_OBJECT);
78 g_dbus_message_finalize (GObject *object)
80 GDBusMessage *message = G_DBUS_MESSAGE (object);
82 if (message->priv->headers != NULL)
83 g_hash_table_unref (message->priv->headers);
84 if (message->priv->body != NULL)
85 g_variant_unref (message->priv->body);
87 if (message->priv->fd_list != NULL)
88 g_object_unref (message->priv->fd_list);
91 if (G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize != NULL)
92 G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize (object);
96 g_dbus_message_class_init (GDBusMessageClass *klass)
98 GObjectClass *gobject_class;
100 g_type_class_add_private (klass, sizeof (GDBusMessagePrivate));
102 gobject_class = G_OBJECT_CLASS (klass);
104 gobject_class->finalize = g_dbus_message_finalize;
108 g_dbus_message_init (GDBusMessage *message)
110 message->priv = G_TYPE_INSTANCE_GET_PRIVATE (message, G_TYPE_DBUS_MESSAGE, GDBusMessagePrivate);
112 message->priv->headers = g_hash_table_new_full (g_direct_hash,
115 (GDestroyNotify) g_variant_unref);
119 * g_dbus_message_new:
121 * Creates a new empty #GDBusMessage.
123 * Returns: A #GDBusMessage. Free with g_object_unref().
128 g_dbus_message_new (void)
130 return g_object_new (G_TYPE_DBUS_MESSAGE, NULL);
134 * g_dbus_message_new_method_call:
135 * @name: A valid D-Bus name or %NULL.
136 * @path: A valid object path.
137 * @interface: A valid D-Bus interface name or %NULL.
138 * @method: A valid method name.
140 * Creates a new #GDBusMessage for a method call.
142 * Returns: A #GDBusMessage. Free with g_object_unref().
147 g_dbus_message_new_method_call (const gchar *name,
149 const gchar *interface,
152 GDBusMessage *message;
154 g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
155 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
156 g_return_val_if_fail (g_dbus_is_member_name (method), NULL);
157 g_return_val_if_fail (interface == NULL || g_dbus_is_interface_name (interface), NULL);
159 message = g_dbus_message_new ();
160 message->priv->type = G_DBUS_MESSAGE_TYPE_METHOD_CALL;
163 g_dbus_message_set_destination (message, name);
164 g_dbus_message_set_path (message, path);
165 g_dbus_message_set_member (message, method);
166 if (interface != NULL)
167 g_dbus_message_set_interface (message, interface);
173 * g_dbus_message_new_signal:
174 * @path: A valid object path.
175 * @interface: A valid D-Bus interface name or %NULL.
176 * @signal: A valid signal name.
178 * Creates a new #GDBusMessage for a signal emission.
180 * Returns: A #GDBusMessage. Free with g_object_unref().
185 g_dbus_message_new_signal (const gchar *path,
186 const gchar *interface,
189 GDBusMessage *message;
191 g_return_val_if_fail (g_variant_is_object_path (path), NULL);
192 g_return_val_if_fail (g_dbus_is_member_name (signal), NULL);
193 g_return_val_if_fail (interface == NULL || g_dbus_is_interface_name (interface), NULL);
195 message = g_dbus_message_new ();
196 message->priv->type = G_DBUS_MESSAGE_TYPE_SIGNAL;
197 message->priv->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
199 g_dbus_message_set_path (message, path);
200 g_dbus_message_set_member (message, signal);
202 if (interface != NULL)
203 g_dbus_message_set_interface (message, interface);
210 * g_dbus_message_new_method_reply:
211 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
212 * create a reply message to.
214 * Creates a new #GDBusMessage that is a reply to @method_call_message.
216 * Returns: A #GDBusMessage. Free with g_object_unref().
221 g_dbus_message_new_method_reply (GDBusMessage *method_call_message)
223 GDBusMessage *message;
226 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
227 g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
228 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
230 message = g_dbus_message_new ();
231 message->priv->type = G_DBUS_MESSAGE_TYPE_METHOD_RETURN;
232 message->priv->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
234 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
235 sender = g_dbus_message_get_sender (method_call_message);
237 g_dbus_message_set_destination (message, sender);
243 * g_dbus_message_new_method_error:
244 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
245 * create a reply message to.
246 * @error_name: A valid D-Bus error name.
247 * @error_message_format: The D-Bus error message in a printf() format.
248 * @...: Arguments for @error_message_format.
250 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
252 * Returns: A #GDBusMessage. Free with g_object_unref().
257 g_dbus_message_new_method_error (GDBusMessage *method_call_message,
258 const gchar *error_name,
259 const gchar *error_message_format,
265 va_start (var_args, error_message_format);
266 ret = g_dbus_message_new_method_error_valist (method_call_message,
268 error_message_format,
276 * g_dbus_message_new_method_error_literal:
277 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
278 * create a reply message to.
279 * @error_name: A valid D-Bus error name.
280 * @error_message: The D-Bus error message.
282 * Creates a new #GDBusMessage that is an error reply to @method_call_message.
284 * Returns: A #GDBusMessage. Free with g_object_unref().
289 g_dbus_message_new_method_error_literal (GDBusMessage *method_call_message,
290 const gchar *error_name,
291 const gchar *error_message)
293 GDBusMessage *message;
296 g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
297 g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
298 g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
299 g_return_val_if_fail (g_dbus_is_name (error_name), NULL);
300 g_return_val_if_fail (error_message != NULL, NULL);
302 message = g_dbus_message_new ();
303 message->priv->type = G_DBUS_MESSAGE_TYPE_ERROR;
304 message->priv->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
306 g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
307 g_dbus_message_set_error_name (message, error_name);
308 g_dbus_message_set_body (message, g_variant_new ("(s)", error_message));
310 sender = g_dbus_message_get_sender (method_call_message);
312 g_dbus_message_set_destination (message, sender);
318 * g_dbus_message_new_method_error_valist:
319 * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
320 * create a reply message to.
321 * @error_name: A valid D-Bus error name.
322 * @error_message_format: The D-Bus error message in a printf() format.
323 * @var_args: Arguments for @error_message_format.
325 * Like g_dbus_message_new_method_error() but intended for language bindings.
327 * Returns: A #GDBusMessage. Free with g_object_unref().
332 g_dbus_message_new_method_error_valist (GDBusMessage *method_call_message,
333 const gchar *error_name,
334 const gchar *error_message_format,
338 gchar *error_message;
339 error_message = g_strdup_vprintf (error_message_format, var_args);
340 ret = g_dbus_message_new_method_error_literal (method_call_message,
343 g_free (error_message);
347 /* ---------------------------------------------------------------------------------------------------- */
349 /* TODO: need GI annotations to specify that any guchar value goes for the type */
352 * g_dbus_message_get_message_type:
353 * @message: A #GDBusMessage.
355 * Gets the type of @message.
357 * Returns: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
362 g_dbus_message_get_message_type (GDBusMessage *message)
364 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_TYPE_INVALID);
365 return message->priv->type;
369 * g_dbus_message_set_message_type:
370 * @message: A #GDBusMessage.
371 * @type: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
373 * Sets @message to be of @type.
378 g_dbus_message_set_message_type (GDBusMessage *message,
379 GDBusMessageType type)
381 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
382 g_return_if_fail (type >=0 && type < 256);
383 message->priv->type = type;
386 /* ---------------------------------------------------------------------------------------------------- */
388 /* TODO: need GI annotations to specify that any guchar value goes for flags */
391 * g_dbus_message_get_flags:
392 * @message: A #GDBusMessage.
394 * Gets the flags for @message.
396 * Returns: Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).
401 g_dbus_message_get_flags (GDBusMessage *message)
403 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_FLAGS_NONE);
404 return message->priv->flags;
408 * g_dbus_message_set_flags:
409 * @message: A #GDBusMessage.
410 * @flags: Flags for @message that are set (typically values from the #GDBusMessageFlags
411 * enumeration bitwise ORed together).
413 * Sets the flags to set on @message.
418 g_dbus_message_set_flags (GDBusMessage *message,
419 GDBusMessageFlags flags)
421 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
422 g_return_if_fail (flags >=0 && flags < 256);
423 message->priv->flags = flags;
426 /* ---------------------------------------------------------------------------------------------------- */
429 * g_dbus_message_get_serial:
430 * @message: A #GDBusMessage.
432 * Gets the serial for @message.
434 * Returns: A #guint32.
439 g_dbus_message_get_serial (GDBusMessage *message)
441 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
442 return message->priv->serial;
446 * g_dbus_message_set_serial:
447 * @message: A #GDBusMessage.
448 * @serial: A #guint32.
450 * Sets the serial for @message.
455 g_dbus_message_set_serial (GDBusMessage *message,
458 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
459 message->priv->serial = serial;
462 /* ---------------------------------------------------------------------------------------------------- */
464 /* TODO: need GI annotations to specify that any guchar value goes for header_field */
467 * g_dbus_message_get_header:
468 * @message: A #GDBusMessage.
469 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
471 * Gets a header field on @message.
473 * Returns: A #GVariant with the value if the header was found, %NULL
474 * otherwise. Do not free, it is owned by @message.
479 g_dbus_message_get_header (GDBusMessage *message,
480 GDBusMessageHeaderField header_field)
482 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
483 g_return_val_if_fail (header_field >=0 && header_field < 256, NULL);
484 return g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
488 * g_dbus_message_set_header:
489 * @message: A #GDBusMessage.
490 * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
491 * @value: A #GVariant to set the header field or %NULL to clear the header field.
493 * Sets a header field on @message.
495 * If @value is floating, @message assumes ownership of @value.
500 g_dbus_message_set_header (GDBusMessage *message,
501 GDBusMessageHeaderField header_field,
504 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
505 g_return_if_fail (header_field >=0 && header_field < 256);
508 g_hash_table_remove (message->priv->headers, GUINT_TO_POINTER (header_field));
512 g_hash_table_insert (message->priv->headers, GUINT_TO_POINTER (header_field), g_variant_ref_sink (value));
517 * g_dbus_message_get_header_fields:
518 * @message: A #GDBusMessage.
520 * Gets an array of all header fields on @message that are set.
522 * Returns: An array of header fields terminated by
523 * %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a
524 * #guchar. Free with g_free().
529 g_dbus_message_get_header_fields (GDBusMessage *message)
537 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
539 keys = g_hash_table_get_keys (message->priv->headers);
540 num_keys = g_list_length (keys);
541 ret = g_new (guchar, num_keys + 1);
542 for (l = keys, n = 0; l != NULL; l = l->next, n++)
543 ret[n] = GPOINTER_TO_UINT (l->data);
544 g_assert (n == num_keys);
545 ret[n] = G_DBUS_MESSAGE_HEADER_FIELD_INVALID;
551 /* ---------------------------------------------------------------------------------------------------- */
554 * g_dbus_message_get_body:
555 * @message: A #GDBusMessage.
557 * Gets the body of a message.
559 * Returns: A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message.
564 g_dbus_message_get_body (GDBusMessage *message)
566 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
567 return message->priv->body;
571 * g_dbus_message_set_body:
572 * @message: A #GDBusMessage.
573 * @body: Either %NULL or a #GVariant that is a tuple.
575 * Sets the body @message. As a side-effect the
576 * %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the
577 * type string of @body (or cleared if @body is %NULL).
579 * If @body is floating, @message assumes ownership of @body.
584 g_dbus_message_set_body (GDBusMessage *message,
587 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
588 g_return_if_fail ((body == NULL) || g_variant_is_of_type (body, G_VARIANT_TYPE_TUPLE));
590 if (message->priv->body != NULL)
591 g_variant_unref (message->priv->body);
594 message->priv->body = NULL;
595 g_dbus_message_set_signature (message, NULL);
599 const gchar *type_string;
600 gsize type_string_len;
603 message->priv->body = g_variant_ref_sink (body);
605 type_string = g_variant_get_type_string (body);
606 type_string_len = strlen (type_string);
607 g_assert (type_string_len >= 2);
608 signature = g_strndup (type_string + 1, type_string_len - 2);
609 g_dbus_message_set_signature (message, signature);
614 /* ---------------------------------------------------------------------------------------------------- */
618 * g_dbus_message_get_unix_fd_list:
619 * @message: A #GDBusMessage.
621 * Gets the UNIX file descriptors associated with @message, if any.
623 * This method is only available on UNIX.
625 * Returns: A #GUnixFDList or %NULL if no file descriptors are
626 * associated. Do not free, this object is owned by @message.
631 g_dbus_message_get_unix_fd_list (GDBusMessage *message)
633 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
634 return message->priv->fd_list;
638 * g_dbus_message_set_unix_fd_list:
639 * @message: A #GDBusMessage.
640 * @fd_list: A #GUnixFDList or %NULL.
642 * Sets the UNIX file descriptors associated with @message. As a
643 * side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header
644 * field is set to the number of fds in @fd_list (or cleared if
645 * @fd_list is %NULL).
647 * This method is only available on UNIX.
652 g_dbus_message_set_unix_fd_list (GDBusMessage *message,
653 GUnixFDList *fd_list)
655 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
656 g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
657 if (message->priv->fd_list != NULL)
658 g_object_unref (message->priv->fd_list);
661 message->priv->fd_list = g_object_ref (fd_list);
662 g_dbus_message_set_num_unix_fds (message, g_unix_fd_list_get_length (fd_list));
666 message->priv->fd_list = NULL;
667 g_dbus_message_set_num_unix_fds (message, 0);
672 /* ---------------------------------------------------------------------------------------------------- */
675 ensure_input_padding (GMemoryInputStream *mis,
682 offset = g_seekable_tell (G_SEEKABLE (mis));
683 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
685 return g_seekable_seek (G_SEEKABLE (mis), wanted_offset, G_SEEK_SET, NULL, error);
689 read_string (GMemoryInputStream *mis,
690 GDataInputStream *dis,
700 s = g_string_new (NULL);
703 while (remaining > 0)
708 to_read = MIN (remaining, sizeof (buf));
709 num_read = g_input_stream_read (G_INPUT_STREAM (mis),
720 G_IO_ERROR_INVALID_ARGUMENT,
721 _("Wanted to read %" G_GSIZE_FORMAT " bytes but got EOF"),
726 remaining -= num_read;
727 g_string_append_len (s, buf, num_read);
731 nul = g_data_input_stream_read_byte (dis, NULL, &local_error);
732 if (local_error != NULL)
734 g_propagate_error (error, local_error);
741 G_IO_ERROR_INVALID_ARGUMENT,
742 _("Expected NUL byte after the string `%s' but found `%c' (%d)"),
747 return g_string_free (s, FALSE);
750 g_string_free (s, TRUE);
755 parse_value_from_blob (GMemoryInputStream *mis,
756 GDataInputStream *dis,
757 const GVariantType *type,
764 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
767 if (!ensure_input_padding (mis, 4, &local_error))
769 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
770 if (local_error != NULL)
772 ret = g_variant_new_boolean (v);
774 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
777 v = g_data_input_stream_read_byte (dis, NULL, &local_error);
778 if (local_error != NULL)
780 ret = g_variant_new_byte (v);
782 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
785 if (!ensure_input_padding (mis, 2, &local_error))
787 v = g_data_input_stream_read_int16 (dis, NULL, &local_error);
788 if (local_error != NULL)
790 ret = g_variant_new_int16 (v);
792 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
795 if (!ensure_input_padding (mis, 2, &local_error))
797 v = g_data_input_stream_read_uint16 (dis, NULL, &local_error);
798 if (local_error != NULL)
800 ret = g_variant_new_uint16 (v);
802 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
805 if (!ensure_input_padding (mis, 4, &local_error))
807 v = g_data_input_stream_read_int32 (dis, NULL, &local_error);
808 if (local_error != NULL)
810 ret = g_variant_new_int32 (v);
812 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
815 if (!ensure_input_padding (mis, 4, &local_error))
817 v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
818 if (local_error != NULL)
820 ret = g_variant_new_uint32 (v);
822 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
825 if (!ensure_input_padding (mis, 8, &local_error))
827 v = g_data_input_stream_read_int64 (dis, NULL, &local_error);
828 if (local_error != NULL)
830 ret = g_variant_new_int64 (v);
832 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
835 if (!ensure_input_padding (mis, 8, &local_error))
837 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
838 if (local_error != NULL)
840 ret = g_variant_new_uint64 (v);
842 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
846 if (!ensure_input_padding (mis, 8, &local_error))
848 v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
849 if (local_error != NULL)
852 encoded = (gdouble *) &v;
853 ret = g_variant_new_double (*encoded);
855 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
859 if (!ensure_input_padding (mis, 4, &local_error))
861 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
862 if (local_error != NULL)
864 v = read_string (mis, dis, (gsize) len, &local_error);
867 ret = g_variant_new_string (v);
869 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
873 if (!ensure_input_padding (mis, 4, &local_error))
875 len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
876 if (local_error != NULL)
878 v = read_string (mis, dis, (gsize) len, &local_error);
881 if (!g_variant_is_object_path (v))
883 g_set_error (&local_error,
885 G_IO_ERROR_INVALID_ARGUMENT,
886 _("Parsed value `%s' is not a valid D-Bus object path"),
890 ret = g_variant_new_object_path (v);
892 else if (g_variant_type_equal (type, G_VARIANT_TYPE_SIGNATURE))
896 len = g_data_input_stream_read_byte (dis, NULL, &local_error);
897 if (local_error != NULL)
899 v = read_string (mis, dis, (gsize) len, &local_error);
902 if (!g_variant_is_signature (v))
904 g_set_error (&local_error,
906 G_IO_ERROR_INVALID_ARGUMENT,
907 _("Parsed value `%s' is not a valid D-Bus signature"),
911 ret = g_variant_new_signature (v);
913 else if (g_variant_type_is_array (type))
918 const GVariantType *element_type;
919 GVariantBuilder *builder;
921 if (!ensure_input_padding (mis, 4, &local_error))
923 array_len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
925 if (array_len > (2<<26))
927 g_set_error (&local_error,
929 G_IO_ERROR_INVALID_ARGUMENT,
930 _("Encountered array of length %" G_GUINT32_FORMAT " bytes. Maximum length is 2<<26 bytes."),
935 builder = g_variant_builder_new (type);
936 element_type = g_variant_type_element (type);
938 /* TODO: optimize array of primitive types */
940 offset = g_seekable_tell (G_SEEKABLE (mis));
941 target = offset + array_len;
942 while (offset < target)
945 item = parse_value_from_blob (mis, dis, element_type, &local_error);
948 g_variant_builder_unref (builder);
951 g_variant_builder_add_value (builder, item);
952 offset = g_seekable_tell (G_SEEKABLE (mis));
955 ret = g_variant_builder_end (builder);
957 else if (g_variant_type_is_dict_entry (type))
959 const GVariantType *key_type;
960 const GVariantType *value_type;
964 if (!ensure_input_padding (mis, 8, &local_error))
967 key_type = g_variant_type_key (type);
968 key = parse_value_from_blob (mis, dis, key_type, &local_error);
972 value_type = g_variant_type_value (type);
973 value = parse_value_from_blob (mis, dis, value_type, &local_error);
976 g_variant_unref (key);
979 ret = g_variant_new_dict_entry (key, value);
981 else if (g_variant_type_is_tuple (type))
983 const GVariantType *element_type;
984 GVariantBuilder *builder;
986 if (!ensure_input_padding (mis, 8, &local_error))
989 builder = g_variant_builder_new (type);
990 element_type = g_variant_type_first (type);
991 while (element_type != NULL)
994 item = parse_value_from_blob (mis, dis, element_type, &local_error);
997 g_variant_builder_unref (builder);
1000 g_variant_builder_add_value (builder, item);
1002 element_type = g_variant_type_next (element_type);
1004 ret = g_variant_builder_end (builder);
1006 else if (g_variant_type_is_variant (type))
1010 GVariantType *variant_type;
1013 siglen = g_data_input_stream_read_byte (dis, NULL, &local_error);
1014 if (local_error != NULL)
1016 sig = read_string (mis, dis, (gsize) siglen, &local_error);
1019 if (!g_variant_is_signature (sig))
1021 g_set_error (&local_error,
1023 G_IO_ERROR_INVALID_ARGUMENT,
1024 _("Parsed value `%s' for variant is not a valid D-Bus signature"),
1028 variant_type = g_variant_type_new (sig);
1029 value = parse_value_from_blob (mis, dis, variant_type, &local_error);
1030 g_variant_type_free (variant_type);
1033 ret = g_variant_new_variant (value);
1038 s = g_variant_type_dup_string (type);
1039 g_set_error (&local_error,
1041 G_IO_ERROR_INVALID_ARGUMENT,
1042 _("Error deserializing GVariant with type-string `%s' from the D-Bus wire format"),
1048 g_assert (ret != NULL);
1052 g_propagate_error (error, local_error);
1056 /* ---------------------------------------------------------------------------------------------------- */
1058 /* message_header must be at least 16 bytes */
1061 * g_dbus_message_bytes_needed:
1062 * @blob: A blob represent a binary D-Bus message.
1063 * @blob_len: The length of @blob (must be at least 16).
1064 * @error: Return location for error or %NULL.
1066 * Utility function to calculate how many bytes are needed to
1067 * completely deserialize the D-Bus message stored at @blob.
1069 * Returns: Number of bytes needed or -1 if @error is set (e.g. if
1070 * @blob contains invalid data or not enough data is available to
1071 * determine the size).
1076 g_dbus_message_bytes_needed (guchar *blob,
1084 g_return_val_if_fail (blob != NULL, -1);
1085 g_return_val_if_fail (error == NULL || *error == NULL, -1);
1086 g_return_val_if_fail (blob_len >= 16, -1);
1090 /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1091 ret = 12 + 4 + GUINT32_FROM_LE (((guint32 *) blob)[3]);
1092 /* round up so it's a multiple of 8 */
1093 ret = 8 * ((ret + 7)/8);
1094 /* finally add the body size */
1095 ret += GUINT32_FROM_LE (((guint32 *) blob)[1]);
1097 else if (blob[0] == 'B')
1100 g_assert_not_reached ();
1106 G_IO_ERROR_INVALID_ARGUMENT,
1107 "Unable to determine message blob length - given blob is malformed");
1114 G_IO_ERROR_INVALID_ARGUMENT,
1115 "Blob indicates that message exceeds maximum message length (128MiB)");
1122 /* ---------------------------------------------------------------------------------------------------- */
1125 * g_dbus_message_new_from_blob:
1126 * @blob: A blob represent a binary D-Bus message.
1127 * @blob_len: The length of @blob.
1128 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
1129 * @error: Return location for error or %NULL.
1131 * Creates a new #GDBusMessage from the data stored at @blob.
1133 * Returns: A new #GDBusMessage or %NULL if @error is set. Free with
1139 g_dbus_message_new_from_blob (guchar *blob,
1141 GDBusCapabilityFlags capabilities,
1145 GMemoryInputStream *mis;
1146 GDataInputStream *dis;
1147 GDBusMessage *message;
1149 guchar major_protocol_version;
1150 GDataStreamByteOrder byte_order;
1151 guint32 message_body_len;
1155 GVariant *signature;
1157 /* TODO: check against @capabilities */
1161 g_return_val_if_fail (blob != NULL, NULL);
1162 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1163 g_return_val_if_fail (blob_len >= 12, NULL);
1165 message = g_dbus_message_new ();
1167 mis = G_MEMORY_INPUT_STREAM (g_memory_input_stream_new_from_data (blob, blob_len, NULL));
1168 dis = g_data_input_stream_new (G_INPUT_STREAM (mis));
1170 endianness = g_data_input_stream_read_byte (dis, NULL, NULL);
1174 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1177 byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
1182 G_IO_ERROR_INVALID_ARGUMENT,
1183 _("Invalid endianness value. Expected 'l' or 'B' but found '%c' (%d)"),
1184 endianness, endianness);
1187 g_data_input_stream_set_byte_order (dis, byte_order);
1189 message->priv->type = g_data_input_stream_read_byte (dis, NULL, NULL);
1190 message->priv->flags = g_data_input_stream_read_byte (dis, NULL, NULL);
1191 major_protocol_version = g_data_input_stream_read_byte (dis, NULL, NULL);
1192 if (major_protocol_version != 1)
1196 G_IO_ERROR_INVALID_ARGUMENT,
1197 _("Invalid major protocol version. Expected 1 but found %d"),
1198 major_protocol_version);
1201 message_body_len = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1202 message->priv->serial = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1204 headers = parse_value_from_blob (mis,
1206 G_VARIANT_TYPE ("a{yv}"),
1208 if (headers == NULL)
1210 g_variant_ref_sink (headers);
1211 g_variant_iter_init (&iter, headers);
1212 while ((item = g_variant_iter_next_value (&iter)))
1214 guchar header_field;
1216 g_variant_get (item,
1220 g_dbus_message_set_header (message, header_field, value);
1222 g_variant_unref (headers);
1224 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
1225 if (signature != NULL)
1227 const gchar *signature_str;
1228 gsize signature_str_len;
1230 signature_str = g_variant_get_string (signature, NULL);
1231 signature_str_len = strlen (signature_str);
1233 /* signature but no body */
1234 if (message_body_len == 0 && signature_str_len > 0)
1238 G_IO_ERROR_INVALID_ARGUMENT,
1239 _("Signature header with signature `%s' found but message body is empty"),
1243 else if (signature_str_len > 0)
1245 GVariantType *variant_type;
1246 gchar *tupled_signature_str;
1248 if (!g_variant_is_signature (signature_str))
1252 G_IO_ERROR_INVALID_ARGUMENT,
1253 _("Parsed value `%s' is not a valid D-Bus signature (for body)"),
1257 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
1258 variant_type = g_variant_type_new (tupled_signature_str);
1259 g_free (tupled_signature_str);
1260 message->priv->body = parse_value_from_blob (mis,
1264 if (message->priv->body == NULL)
1266 g_variant_type_free (variant_type);
1269 g_variant_ref_sink (message->priv->body);
1270 g_variant_type_free (variant_type);
1275 /* no signature, this is only OK if the body is empty */
1276 if (message_body_len != 0)
1280 G_IO_ERROR_INVALID_ARGUMENT,
1281 _("No signature header in message but the message body is %" G_GUINT32_FORMAT " bytes"),
1291 g_object_unref (dis);
1292 g_object_unref (mis);
1300 if (message != NULL)
1301 g_object_unref (message);
1306 /* ---------------------------------------------------------------------------------------------------- */
1309 ensure_output_padding (GMemoryOutputStream *mos,
1310 GDataOutputStream *dos,
1314 gsize wanted_offset;
1315 gsize padding_needed;
1318 offset = g_memory_output_stream_get_data_size (mos);
1319 wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
1320 padding_needed = wanted_offset - offset;
1322 for (n = 0; n < padding_needed; n++)
1323 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1325 return padding_needed;
1329 append_value_to_blob (GVariant *value,
1330 GMemoryOutputStream *mos,
1331 GDataOutputStream *dos,
1332 gsize *out_padding_added,
1335 const GVariantType *type;
1336 gsize padding_added;
1340 type = g_variant_get_type (value);
1341 if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
1343 gboolean v = g_variant_get_boolean (value);
1344 padding_added = ensure_output_padding (mos, dos, 4);
1345 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1347 else if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1349 guint8 v = g_variant_get_byte (value);
1350 g_data_output_stream_put_byte (dos, v, NULL, NULL);
1352 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT16))
1354 gint16 v = g_variant_get_int16 (value);
1355 padding_added = ensure_output_padding (mos, dos, 2);
1356 g_data_output_stream_put_int16 (dos, v, NULL, NULL);
1358 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT16))
1360 guint16 v = g_variant_get_uint16 (value);
1361 padding_added = ensure_output_padding (mos, dos, 2);
1362 g_data_output_stream_put_uint16 (dos, v, NULL, NULL);
1364 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT32))
1366 gint32 v = g_variant_get_int32 (value);
1367 padding_added = ensure_output_padding (mos, dos, 4);
1368 g_data_output_stream_put_int32 (dos, v, NULL, NULL);
1370 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT32))
1372 guint32 v = g_variant_get_uint32 (value);
1373 padding_added = ensure_output_padding (mos, dos, 4);
1374 g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1376 else if (g_variant_type_equal (type, G_VARIANT_TYPE_INT64))
1378 gint64 v = g_variant_get_int64 (value);
1379 padding_added = ensure_output_padding (mos, dos, 8);
1380 g_data_output_stream_put_int64 (dos, v, NULL, NULL);
1382 else if (g_variant_type_equal (type, G_VARIANT_TYPE_UINT64))
1384 guint64 v = g_variant_get_uint64 (value);
1385 padding_added = ensure_output_padding (mos, dos, 8);
1386 g_data_output_stream_put_uint64 (dos, v, NULL, NULL);
1388 else if (g_variant_type_equal (type, G_VARIANT_TYPE_DOUBLE))
1391 gdouble v = g_variant_get_double (value);
1392 padding_added = ensure_output_padding (mos, dos, 8);
1394 encoded = (guint64 *) &v;
1395 g_data_output_stream_put_uint64 (dos, *encoded, NULL, NULL);
1397 else if (g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
1399 const gchar *v = g_variant_get_string (value, NULL);
1401 padding_added = ensure_output_padding (mos, dos, 4);
1403 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1404 g_data_output_stream_put_string (dos, v, NULL, NULL);
1405 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1407 else if (g_variant_type_equal (type, G_VARIANT_TYPE_OBJECT_PATH))
1409 /* TODO: validate object path */
1410 const gchar *v = g_variant_get_string (value, NULL);
1412 padding_added = ensure_output_padding (mos, dos, 4);
1414 g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1415 g_data_output_stream_put_string (dos, v, NULL, NULL);
1416 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1418 else if (g_variant_type_equal (type, G_VARIANT_TYPE_SIGNATURE))
1420 /* TODO: validate signature (including max len being 255) */
1421 const gchar *v = g_variant_get_string (value, NULL);
1424 g_data_output_stream_put_byte (dos, len, NULL, NULL);
1425 g_data_output_stream_put_string (dos, v, NULL, NULL);
1426 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1428 else if (g_variant_type_is_array (type))
1432 goffset array_len_offset;
1433 goffset array_payload_begin_offset;
1438 padding_added = ensure_output_padding (mos, dos, 4);
1440 /* array length - will be filled in later */
1441 array_len_offset = g_memory_output_stream_get_data_size (mos);
1442 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
1444 /* From the D-Bus spec:
1446 * "A UINT32 giving the length of the array data in bytes,
1447 * followed by alignment padding to the alignment boundary of
1448 * the array element type, followed by each array element. The
1449 * array length is from the end of the alignment padding to
1450 * the end of the last element, i.e. it does not include the
1451 * padding after the length, or any padding after the last
1454 * Thus, we need to count how much padding the first element
1455 * contributes and subtract that from the array length.
1457 array_payload_begin_offset = g_memory_output_stream_get_data_size (mos);
1459 g_variant_iter_init (&iter, value);
1461 while ((item = g_variant_iter_next_value (&iter)))
1463 gsize padding_added_for_item;
1464 if (!append_value_to_blob (item, mos, dos, &padding_added_for_item, error))
1468 array_payload_begin_offset += padding_added_for_item;
1473 cur_offset = g_memory_output_stream_get_data_size (mos);
1475 array_len = cur_offset - array_payload_begin_offset;
1477 if (!g_seekable_seek (G_SEEKABLE (mos), array_len_offset, G_SEEK_SET, NULL, error))
1480 g_data_output_stream_put_uint32 (dos, array_len, NULL, NULL);
1482 if (!g_seekable_seek (G_SEEKABLE (mos), cur_offset, G_SEEK_SET, NULL, error))
1485 else if (g_variant_type_is_dict_entry (type) || g_variant_type_is_tuple (type))
1490 padding_added = ensure_output_padding (mos, dos, 8);
1492 g_variant_iter_init (&iter, value);
1494 while ((item = g_variant_iter_next_value (&iter)))
1496 if (!append_value_to_blob (item, mos, dos, NULL, error))
1500 else if (g_variant_type_is_variant (type))
1503 const gchar *signature;
1504 child = g_variant_get_child_value (value, 0);
1505 signature = g_variant_get_type_string (child);
1506 /* TODO: validate signature (including max len being 255) */
1507 g_data_output_stream_put_byte (dos, strlen (signature), NULL, NULL);
1508 g_data_output_stream_put_string (dos, signature, NULL, NULL);
1509 g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1510 if (!append_value_to_blob (child, mos, dos, NULL, error))
1512 g_variant_unref (child);
1515 g_variant_unref (child);
1521 G_IO_ERROR_INVALID_ARGUMENT,
1522 _("Error serializing GVariant with type-string `%s' to the D-Bus wire format"),
1523 g_variant_get_type_string (value));
1527 if (out_padding_added != NULL)
1528 *out_padding_added = padding_added;
1537 append_body_to_blob (GVariant *value,
1538 GMemoryOutputStream *mos,
1539 GDataOutputStream *dos,
1548 if (!g_variant_is_of_type (value, G_VARIANT_TYPE_TUPLE))
1552 G_IO_ERROR_INVALID_ARGUMENT,
1553 "Expected a tuple for the body of the GDBusMessage.");
1557 g_variant_iter_init (&iter, value);
1558 while ((item = g_variant_iter_next_value (&iter)))
1560 if (!append_value_to_blob (item, mos, dos, NULL, error))
1569 /* ---------------------------------------------------------------------------------------------------- */
1572 * g_dbus_message_to_blob:
1573 * @message: A #GDBusMessage.
1574 * @out_size: Return location for size of generated blob.
1575 * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
1576 * @error: Return location for error.
1578 * Serializes @message to a blob.
1580 * Returns: A pointer to a valid binary D-Bus message of @out_size bytes
1581 * generated by @message or %NULL if @error is set. Free with g_free().
1586 g_dbus_message_to_blob (GDBusMessage *message,
1588 GDBusCapabilityFlags capabilities,
1591 GMemoryOutputStream *mos;
1592 GDataOutputStream *dos;
1595 GDataStreamByteOrder byte_order;
1596 goffset body_len_offset;
1597 goffset body_start_offset;
1599 GVariant *header_fields;
1600 GVariantBuilder *builder;
1601 GHashTableIter hash_iter;
1603 GVariant *header_value;
1604 GVariant *signature;
1605 const gchar *signature_str;
1606 gint num_fds_in_message;
1607 gint num_fds_according_to_header;
1609 /* TODO: check against @capabilities */
1613 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1614 g_return_val_if_fail (out_size != NULL, NULL);
1615 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1617 mos = G_MEMORY_OUTPUT_STREAM (g_memory_output_stream_new (NULL, 0, g_realloc, g_free));
1618 dos = g_data_output_stream_new (G_OUTPUT_STREAM (mos));
1620 /* TODO: detect endianess... */
1621 byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1622 g_data_output_stream_set_byte_order (dos, byte_order);
1625 g_data_output_stream_put_byte (dos, byte_order == G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN ? 'l' : 'B', NULL, NULL);
1626 g_data_output_stream_put_byte (dos, message->priv->type, NULL, NULL);
1627 g_data_output_stream_put_byte (dos, message->priv->flags, NULL, NULL);
1628 g_data_output_stream_put_byte (dos, 1, NULL, NULL); /* major protocol version */
1629 body_len_offset = g_memory_output_stream_get_data_size (mos);
1630 /* body length - will be filled in later */
1631 g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
1632 g_data_output_stream_put_uint32 (dos, message->priv->serial, NULL, NULL);
1634 num_fds_in_message = 0;
1636 if (message->priv->fd_list != NULL)
1637 num_fds_in_message = g_unix_fd_list_get_length (message->priv->fd_list);
1639 num_fds_according_to_header = g_dbus_message_get_num_unix_fds (message);
1640 /* TODO: check we have all the right header fields and that they are the correct value etc etc */
1641 if (num_fds_in_message != num_fds_according_to_header)
1645 G_IO_ERROR_INVALID_ARGUMENT,
1646 _("Message has %d fds but the header field indicates %d fds"),
1648 num_fds_according_to_header);
1652 builder = g_variant_builder_new (G_VARIANT_TYPE ("a{yv}"));//G_VARIANT_TYPE_ARRAY);
1653 g_hash_table_iter_init (&hash_iter, message->priv->headers);
1654 while (g_hash_table_iter_next (&hash_iter, &key, (gpointer) &header_value))
1656 g_variant_builder_add (builder,
1658 (guchar) GPOINTER_TO_UINT (key),
1661 header_fields = g_variant_new ("a{yv}", builder);
1663 if (!append_value_to_blob (header_fields, mos, dos, NULL, error))
1665 g_variant_unref (header_fields);
1668 g_variant_unref (header_fields);
1670 /* header size must be a multiple of 8 */
1671 ensure_output_padding (mos, dos, 8);
1673 body_start_offset = g_memory_output_stream_get_data_size (mos);
1675 signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
1676 signature_str = NULL;
1677 if (signature != NULL)
1678 signature_str = g_variant_get_string (signature, NULL);
1679 if (message->priv->body != NULL)
1681 gchar *tupled_signature_str;
1682 tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
1683 if (signature == NULL)
1687 G_IO_ERROR_INVALID_ARGUMENT,
1688 _("Message body has signature `%s' but there is no signature header"),
1690 g_free (tupled_signature_str);
1693 else if (g_strcmp0 (tupled_signature_str, g_variant_get_type_string (message->priv->body)) != 0)
1697 G_IO_ERROR_INVALID_ARGUMENT,
1698 _("Message body has type signature `%s' but signature in the header field is `%s'"),
1699 tupled_signature_str, g_variant_get_type_string (message->priv->body));
1700 g_free (tupled_signature_str);
1703 g_free (tupled_signature_str);
1704 if (!append_body_to_blob (message->priv->body, mos, dos, error))
1709 if (signature != NULL)
1713 G_IO_ERROR_INVALID_ARGUMENT,
1714 _("Message body is empty but signature in the header field is `(%s)'"),
1720 /* OK, we're done writing the message - set the body length */
1721 size = g_memory_output_stream_get_data_size (mos);
1722 body_size = size - body_start_offset;
1724 if (!g_seekable_seek (G_SEEKABLE (mos), body_len_offset, G_SEEK_SET, NULL, error))
1727 g_data_output_stream_put_uint32 (dos, body_size, NULL, NULL);
1730 ret = g_memdup (g_memory_output_stream_get_data (mos), size);
1733 g_object_unref (dos);
1734 g_object_unref (mos);
1739 /* ---------------------------------------------------------------------------------------------------- */
1742 get_uint32_header (GDBusMessage *message,
1743 GDBusMessageHeaderField header_field)
1749 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
1750 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_UINT32))
1751 ret = g_variant_get_uint32 (value);
1756 static const gchar *
1757 get_string_header (GDBusMessage *message,
1758 GDBusMessageHeaderField header_field)
1764 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
1765 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
1766 ret = g_variant_get_string (value, NULL);
1771 static const gchar *
1772 get_object_path_header (GDBusMessage *message,
1773 GDBusMessageHeaderField header_field)
1779 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
1780 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_OBJECT_PATH))
1781 ret = g_variant_get_string (value, NULL);
1786 static const gchar *
1787 get_signature_header (GDBusMessage *message,
1788 GDBusMessageHeaderField header_field)
1794 value = g_hash_table_lookup (message->priv->headers, GUINT_TO_POINTER (header_field));
1795 if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_SIGNATURE))
1796 ret = g_variant_get_string (value, NULL);
1801 /* ---------------------------------------------------------------------------------------------------- */
1804 set_uint32_header (GDBusMessage *message,
1805 GDBusMessageHeaderField header_field,
1808 g_dbus_message_set_header (message,
1810 g_variant_new_uint32 (value));
1814 set_string_header (GDBusMessage *message,
1815 GDBusMessageHeaderField header_field,
1818 g_dbus_message_set_header (message,
1820 value == NULL ? NULL : g_variant_new_string (value));
1824 set_object_path_header (GDBusMessage *message,
1825 GDBusMessageHeaderField header_field,
1828 g_dbus_message_set_header (message,
1830 value == NULL ? NULL : g_variant_new_object_path (value));
1834 set_signature_header (GDBusMessage *message,
1835 GDBusMessageHeaderField header_field,
1838 g_dbus_message_set_header (message,
1840 value == NULL ? NULL : g_variant_new_signature (value));
1843 /* ---------------------------------------------------------------------------------------------------- */
1846 * g_dbus_message_get_reply_serial:
1847 * @message: A #GDBusMessage.
1849 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
1851 * Returns: The value.
1856 g_dbus_message_get_reply_serial (GDBusMessage *message)
1858 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
1859 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL);
1863 * g_dbus_message_set_reply_serial:
1864 * @message: A #GDBusMessage.
1865 * @value: The value to set.
1867 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
1872 g_dbus_message_set_reply_serial (GDBusMessage *message,
1875 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1876 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL, value);
1879 /* ---------------------------------------------------------------------------------------------------- */
1882 * g_dbus_message_get_interface:
1883 * @message: A #GDBusMessage.
1885 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
1887 * Returns: The value.
1892 g_dbus_message_get_interface (GDBusMessage *message)
1894 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1895 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE);
1899 * g_dbus_message_set_interface:
1900 * @message: A #GDBusMessage.
1901 * @value: The value to set.
1903 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
1908 g_dbus_message_set_interface (GDBusMessage *message,
1911 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1912 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
1913 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE, value);
1916 /* ---------------------------------------------------------------------------------------------------- */
1919 * g_dbus_message_get_member:
1920 * @message: A #GDBusMessage.
1922 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
1924 * Returns: The value.
1929 g_dbus_message_get_member (GDBusMessage *message)
1931 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1932 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER);
1936 * g_dbus_message_set_member:
1937 * @message: A #GDBusMessage.
1938 * @value: The value to set.
1940 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
1945 g_dbus_message_set_member (GDBusMessage *message,
1948 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1949 g_return_if_fail (value == NULL || g_dbus_is_member_name (value));
1950 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER, value);
1953 /* ---------------------------------------------------------------------------------------------------- */
1956 * g_dbus_message_get_path:
1957 * @message: A #GDBusMessage.
1959 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
1961 * Returns: The value.
1966 g_dbus_message_get_path (GDBusMessage *message)
1968 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
1969 return get_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH);
1973 * g_dbus_message_set_path:
1974 * @message: A #GDBusMessage.
1975 * @value: The value to set.
1977 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
1982 g_dbus_message_set_path (GDBusMessage *message,
1985 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
1986 g_return_if_fail (value == NULL || g_variant_is_object_path (value));
1987 set_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH, value);
1990 /* ---------------------------------------------------------------------------------------------------- */
1993 * g_dbus_message_get_sender:
1994 * @message: A #GDBusMessage.
1996 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
1998 * Returns: The value.
2003 g_dbus_message_get_sender (GDBusMessage *message)
2005 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2006 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER);
2010 * g_dbus_message_set_sender:
2011 * @message: A #GDBusMessage.
2012 * @value: The value to set.
2014 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2019 g_dbus_message_set_sender (GDBusMessage *message,
2022 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2023 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2024 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER, value);
2027 /* ---------------------------------------------------------------------------------------------------- */
2030 * g_dbus_message_get_destination:
2031 * @message: A #GDBusMessage.
2033 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2035 * Returns: The value.
2040 g_dbus_message_get_destination (GDBusMessage *message)
2042 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2043 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION);
2047 * g_dbus_message_set_destination:
2048 * @message: A #GDBusMessage.
2049 * @value: The value to set.
2051 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2056 g_dbus_message_set_destination (GDBusMessage *message,
2059 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2060 g_return_if_fail (value == NULL || g_dbus_is_name (value));
2061 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION, value);
2064 /* ---------------------------------------------------------------------------------------------------- */
2067 * g_dbus_message_get_error_name:
2068 * @message: A #GDBusMessage.
2070 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2072 * Returns: The value.
2077 g_dbus_message_get_error_name (GDBusMessage *message)
2079 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2080 return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME);
2084 * g_dbus_message_set_error_name:
2085 * @message: A #GDBusMessage.
2086 * @value: The value to set.
2088 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2093 g_dbus_message_set_error_name (GDBusMessage *message,
2096 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2097 g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2098 set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME, value);
2101 /* ---------------------------------------------------------------------------------------------------- */
2104 * g_dbus_message_get_signature:
2105 * @message: A #GDBusMessage.
2107 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2109 * Returns: The value.
2114 g_dbus_message_get_signature (GDBusMessage *message)
2117 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2118 ret = get_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2125 * g_dbus_message_set_signature:
2126 * @message: A #GDBusMessage.
2127 * @value: The value to set.
2129 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2134 g_dbus_message_set_signature (GDBusMessage *message,
2137 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2138 g_return_if_fail (value == NULL || g_variant_is_signature (value));
2139 set_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE, value);
2142 /* ---------------------------------------------------------------------------------------------------- */
2145 * g_dbus_message_get_arg0:
2146 * @message: A #GDBusMessage.
2148 * Convenience to get the first item in the body of @message.
2150 * Returns: The string item or %NULL if the first item in the body of
2151 * @message is not a string.
2156 g_dbus_message_get_arg0 (GDBusMessage *message)
2160 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2164 if (message->priv->body != NULL && g_variant_is_of_type (message->priv->body, G_VARIANT_TYPE_TUPLE))
2167 item = g_variant_get_child_value (message->priv->body, 0);
2168 if (g_variant_is_of_type (item, G_VARIANT_TYPE_STRING))
2169 ret = g_variant_get_string (item, NULL);
2175 /* ---------------------------------------------------------------------------------------------------- */
2178 * g_dbus_message_get_num_unix_fds:
2179 * @message: A #GDBusMessage.
2181 * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2183 * Returns: The value.
2188 g_dbus_message_get_num_unix_fds (GDBusMessage *message)
2190 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2191 return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS);
2195 * g_dbus_message_set_num_unix_fds:
2196 * @message: A #GDBusMessage.
2197 * @value: The value to set.
2199 * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2204 g_dbus_message_set_num_unix_fds (GDBusMessage *message,
2207 g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2208 set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS, value);
2211 /* ---------------------------------------------------------------------------------------------------- */
2214 * g_dbus_message_to_gerror:
2215 * @message: A #GDBusMessage.
2216 * @error: The #GError to set.
2218 * If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does
2219 * nothing and returns %FALSE.
2221 * Otherwise this method encodes the error in @message as a #GError
2222 * using g_dbus_error_set_dbus_error() using the information in the
2223 * %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of @message as
2224 * well as the first string item in @message's body.
2226 * Returns: %TRUE if @error was set, %FALSE otherwise.
2231 g_dbus_message_to_gerror (GDBusMessage *message,
2235 const gchar *error_name;
2237 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2240 if (message->priv->type != G_DBUS_MESSAGE_TYPE_ERROR)
2243 error_name = g_dbus_message_get_error_name (message);
2244 if (error_name != NULL)
2248 body = g_dbus_message_get_body (message);
2250 if (body != NULL && g_variant_is_of_type (body, G_VARIANT_TYPE ("(s)")))
2252 const gchar *error_message;
2253 g_variant_get (body, "(&s)", &error_message);
2254 g_dbus_error_set_dbus_error (error,
2261 /* these two situations are valid, yet pretty rare */
2264 g_dbus_error_set_dbus_error (error,
2267 _("Error return with body of type `%s'"),
2268 g_variant_get_type_string (body));
2272 g_dbus_error_set_dbus_error (error,
2275 _("Error return with empty body"));
2281 /* TOOD: this shouldn't happen - should check this at message serialization
2282 * time and disconnect the peer.
2287 "Error return without error-name header!");
2296 /* ---------------------------------------------------------------------------------------------------- */
2299 enum_to_string (GType enum_type, gint value)
2303 GEnumValue *enum_value;
2305 klass = g_type_class_ref (enum_type);
2306 enum_value = g_enum_get_value (klass, value);
2307 if (enum_value != NULL)
2308 ret = g_strdup (enum_value->value_nick);
2310 ret = g_strdup_printf ("unknown (value %d)", value);
2311 g_type_class_unref (klass);
2316 flags_to_string (GType flags_type, guint value)
2322 klass = g_type_class_ref (flags_type);
2323 s = g_string_new (NULL);
2324 for (n = 0; n < 32; n++)
2326 if ((value & (1<<n)) != 0)
2328 GFlagsValue *flags_value;
2329 flags_value = g_flags_get_first_value (klass, (1<<n));
2331 g_string_append_c (s, ',');
2332 if (flags_value != NULL)
2333 g_string_append (s, flags_value->value_nick);
2335 g_string_append_printf (s, "unknown (bit %d)", n);
2339 g_string_append (s, "none");
2340 g_type_class_unref (klass);
2341 return g_string_free (s, FALSE);;
2345 _sort_keys_func (gconstpointer a,
2351 ia = GPOINTER_TO_INT (a);
2352 ib = GPOINTER_TO_INT (b);
2358 * g_dbus_message_print:
2359 * @message: A #GDBusMessage.
2360 * @indent: Indentation level.
2362 * Produces a human-readable multi-line description of @message.
2364 * The contents of the description has no ABI guarantees, the contents
2365 * and formatting is subject to change at any time. Typical output
2366 * looks something like this:
2373 * path -> objectpath '/org/gtk/GDBus/TestObject'
2374 * interface -> 'org.gtk.GDBus.TestInterface'
2375 * member -> 'GimmeStdout'
2376 * destination -> ':1.146'
2378 * UNIX File Descriptors:
2383 * Type: method-return
2384 * Flags: no-reply-expected
2388 * reply-serial -> uint32 4
2389 * destination -> ':1.159'
2390 * sender -> ':1.146'
2391 * num-unix-fds -> uint32 1
2393 * UNIX File Descriptors:
2394 * fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635
2397 * Returns: A string that should be freed with g_free().
2402 g_dbus_message_print (GDBusMessage *message,
2410 g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2412 str = g_string_new (NULL);
2414 s = enum_to_string (G_TYPE_DBUS_MESSAGE_TYPE, message->priv->type);
2415 g_string_append_printf (str, "%*sType: %s\n", indent, "", s);
2417 s = flags_to_string (G_TYPE_DBUS_MESSAGE_FLAGS, message->priv->flags);
2418 g_string_append_printf (str, "%*sFlags: %s\n", indent, "", s);
2420 g_string_append_printf (str, "%*sVersion: %d\n", indent, "", message->priv->major_protocol_version);
2421 g_string_append_printf (str, "%*sSerial: %d\n", indent, "", message->priv->serial);
2423 g_string_append_printf (str, "%*sHeaders:\n", indent, "");
2424 keys = g_hash_table_get_keys (message->priv->headers);
2425 keys = g_list_sort (keys, _sort_keys_func);
2428 for (l = keys; l != NULL; l = l->next)
2430 gint key = GPOINTER_TO_INT (l->data);
2434 value = g_hash_table_lookup (message->priv->headers, l->data);
2435 g_assert (value != NULL);
2437 s = enum_to_string (G_TYPE_DBUS_MESSAGE_HEADER_FIELD, key);
2438 value_str = g_variant_print (value, TRUE);
2439 g_string_append_printf (str, "%*s %s -> %s\n", indent, "", s, value_str);
2446 g_string_append_printf (str, "%*s (none)\n", indent, "");
2448 g_string_append_printf (str, "%*sBody: ", indent, "");
2449 if (message->priv->body != NULL)
2451 g_variant_print_string (message->priv->body,
2457 g_string_append (str, "()");
2459 g_string_append (str, "\n");
2461 g_string_append_printf (str, "%*sUNIX File Descriptors:\n", indent, "");
2462 if (message->priv->fd_list != NULL)
2468 fds = g_unix_fd_list_peek_fds (message->priv->fd_list, &num_fds);
2471 for (n = 0; n < num_fds; n++)
2474 struct stat statbuf;
2475 fs = g_string_new (NULL);
2476 if (fstat (fds[n], &statbuf) == 0)
2478 g_string_append_printf (fs, "%s" "dev=%d:%d", fs->len > 0 ? "," : "",
2479 major (statbuf.st_dev), minor (statbuf.st_dev));
2480 g_string_append_printf (fs, "%s" "mode=0%o", fs->len > 0 ? "," : "",
2482 g_string_append_printf (fs, "%s" "ino=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2483 (guint64) statbuf.st_ino);
2484 g_string_append_printf (fs, "%s" "uid=%d", fs->len > 0 ? "," : "",
2486 g_string_append_printf (fs, "%s" "gid=%d", fs->len > 0 ? "," : "",
2488 g_string_append_printf (fs, "%s" "rdev=%d:%d", fs->len > 0 ? "," : "",
2489 major (statbuf.st_rdev), minor (statbuf.st_rdev));
2490 g_string_append_printf (fs, "%s" "size=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2491 (guint64) statbuf.st_size);
2492 g_string_append_printf (fs, "%s" "atime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2493 (guint64) statbuf.st_atime);
2494 g_string_append_printf (fs, "%s" "mtime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2495 (guint64) statbuf.st_mtime);
2496 g_string_append_printf (fs, "%s" "ctime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
2497 (guint64) statbuf.st_ctime);
2501 g_string_append_printf (fs, "(fstat failed: %s)", strerror (errno));
2503 g_string_append_printf (str, "%*s fd %d: %s\n", indent, "", fds[n], fs->str);
2504 g_string_free (fs, TRUE);
2509 g_string_append_printf (str, "%*s (empty)\n", indent, "");
2514 g_string_append_printf (str, "%*s (none)\n", indent, "");
2518 return g_string_free (str, FALSE);
2522 #define __G_DBUS_MESSAGE_C__
2523 #include "gioaliasdef.c"