#include "dbus-message-internal.h"
#include "dbus-memory.h"
#include "dbus-list.h"
+#include "dbus-message-builder.h"
#include <string.h>
/**
* @{
*/
+enum
+{
+ FIELD_HEADER_LENGTH,
+ FIELD_BODY_LENGTH,
+ FIELD_CLIENT_SERIAL,
+ FIELD_NAME,
+ FIELD_SERVICE,
+ FIELD_SENDER,
+ FIELD_REPLY_SERIAL,
+
+ FIELD_LAST
+};
+
+static dbus_bool_t field_is_named[FIELD_LAST] =
+{
+ FALSE, /* FIELD_HEADER_LENGTH */
+ FALSE, /* FIELD_BODY_LENGTH */
+ FALSE, /* FIELD_CLIENT_SERIAL */
+ TRUE, /* FIELD_NAME */
+ TRUE, /* FIELD_SERVICE */
+ TRUE, /* FIELD_SENDER */
+ TRUE /* FIELD_REPLY_SERIAL */
+};
+
+typedef struct
+{
+ int offset; /**< Offset to start of field (location of name of field
+ * for named fields)
+ */
+} HeaderField;
+
/**
* @brief Internals of DBusMessage
*
*/
struct DBusMessage
{
- int refcount; /**< Reference count */
+ dbus_atomic_t refcount; /**< Reference count */
DBusString header; /**< Header network data, stored
* separately from body so we can
* independently realloc it.
*/
- DBusString body; /**< Body network data. */
+ HeaderField header_fields[FIELD_LAST]; /**< Track the location
+ * of each field in "header"
+ */
- char byte_order; /**< Message byte order. */
+ dbus_uint32_t client_serial; /**< Cached client serial value for speed */
+ dbus_uint32_t reply_serial; /**< Cached reply serial value for speed */
- char *name; /**< Message name. */
- char *service; /**< Message destination service. */
- char *sender; /**< Message sender service. */
+ int header_padding; /**< bytes of alignment in header */
- dbus_int32_t client_serial; /**< Client serial or -1 if not set */
- dbus_int32_t reply_serial; /**< Reply serial or -1 if not set */
+ DBusString body; /**< Body network data. */
+
+ char byte_order; /**< Message byte order. */
+
+ DBusList *size_counters; /**< 0-N DBusCounter used to track message size. */
+ long size_counter_delta; /**< Size we incremented the size counters by. */
- DBusCounter *size_counter; /**< Counter for the size of the message, or #NULL */
- long size_counter_delta; /**< Size we incremented the size counter by. */
+ dbus_uint32_t changed_stamp; /**< Incremented when iterators are invalidated. */
unsigned int locked : 1; /**< Message being sent, no modifications allowed. */
};
+enum {
+ DBUS_MESSAGE_ITER_TYPE_MESSAGE,
+ DBUS_MESSAGE_ITER_TYPE_ARRAY,
+ DBUS_MESSAGE_ITER_TYPE_DICT
+};
+
+/** typedef for internals of message iterator */
+typedef struct DBusMessageRealIter DBusMessageRealIter;
+
/**
* @brief Internals of DBusMessageIter
*
* Object representing a position in a message. All fields are internal.
*/
-struct DBusMessageIter
+struct DBusMessageRealIter
{
- int refcount; /**< Reference count */
-
+ DBusMessageRealIter *parent_iter; /**< parent iter, or NULL */
+ DBusMessage *message; /**< Message used */
+ dbus_uint32_t changed_stamp; /**< stamp to detect invalid iters */
+
+ /* This is an int instead of an enum to get a guaranteed size for the dummy: */
+ int type; /**< type of iter */
+
int pos; /**< Current position in the string */
+ int end; /**< position right after the container */
+ int container_start; /**< offset of the start of the container */
+ int container_length_pos; /**< offset of the length of the container */
- DBusMessage *message; /**< Message used */
+ int wrote_dict_key; /**< whether we wrote the dict key for the current dict element */
+
+ int array_type_pos; /**< pointer to the position of the array element type */
+ int array_type_done; /**< TRUE if the array type is fully finished */
};
/**
*body = &message->body;
}
-/**
- * Sets the client serial of a message.
- * This can only be done once on a message.
- *
- * @param message the message
- * @param client_serial the client serial
- */
-void
-_dbus_message_set_client_serial (DBusMessage *message,
- dbus_int32_t client_serial)
+static void
+clear_header_padding (DBusMessage *message)
+{
+ _dbus_string_shorten (&message->header,
+ message->header_padding);
+ message->header_padding = 0;
+}
+
+static dbus_bool_t
+append_header_padding (DBusMessage *message)
+{
+ int old_len;
+ old_len = _dbus_string_get_length (&message->header);
+ if (!_dbus_string_align_length (&message->header, 8))
+ return FALSE;
+
+ message->header_padding = _dbus_string_get_length (&message->header) - old_len;
+
+ return TRUE;
+}
+
+static void
+adjust_field_offsets (DBusMessage *message,
+ int offsets_after,
+ int delta)
{
- _dbus_assert (message->client_serial == -1);
+ int i;
+
+ if (delta == 0)
+ return;
- message->client_serial = client_serial;
+ i = 0;
+ while (i < FIELD_LAST)
+ {
+ if (message->header_fields[i].offset > offsets_after)
+ message->header_fields[i].offset += delta;
+
+ ++i;
+ }
}
-/**
- * Returns the client serial of a message or
- * -1 if none has been specified.
- *
- * @param message the message
- * @returns the client serial
- */
-dbus_int32_t
-_dbus_message_get_client_serial (DBusMessage *message)
+#ifdef DBUS_BUILD_TESTS
+/* tests-only until it's actually used */
+static dbus_int32_t
+get_int_field (DBusMessage *message,
+ int field)
{
- return message->client_serial;
+ int offset;
+
+ _dbus_assert (field < FIELD_LAST);
+
+ offset = message->header_fields[field].offset;
+
+ if (offset < 0)
+ return -1; /* useless if -1 is a valid value of course */
+
+ return _dbus_demarshal_int32 (&message->header,
+ message->byte_order,
+ offset,
+ NULL);
}
+#endif
-/**
- * Returns the serial that the message is
- * a reply to.
- *
- * @param message the message
- * @returns the reply serial
- */
-dbus_int32_t
-_dbus_message_get_reply_serial (DBusMessage *message)
+static dbus_uint32_t
+get_uint_field (DBusMessage *message,
+ int field)
{
- return message->reply_serial;
+ int offset;
+
+ _dbus_assert (field < FIELD_LAST);
+
+ offset = message->header_fields[field].offset;
+
+ if (offset < 0)
+ return -1; /* useless if -1 is a valid value of course */
+
+ return _dbus_demarshal_uint32 (&message->header,
+ message->byte_order,
+ offset,
+ NULL);
}
-/**
- * Adds a counter to be incremented immediately with the
- * size of this message, and decremented by the size
- * of this message when this message if finalized.
- *
- * @param message the message
- * @param counter the counter
- */
-void
-_dbus_message_add_size_counter (DBusMessage *message,
- DBusCounter *counter)
+static const char*
+get_string_field (DBusMessage *message,
+ int field,
+ int *len)
{
- _dbus_assert (message->size_counter == NULL); /* If this fails we may need to keep a list of
- * counters instead of just one
- */
+ int offset;
+ const char *data;
- message->size_counter = counter;
- _dbus_counter_ref (message->size_counter);
+ offset = message->header_fields[field].offset;
- /* When we can change message size, we may want to
- * update this each time we do so, or we may want to
- * just KISS like this.
+ _dbus_assert (field < FIELD_LAST);
+
+ if (offset < 0)
+ return NULL;
+
+ /* offset points to string length, string data follows it */
+ /* FIXME _dbus_demarshal_const_string() that returned
+ * a reference to the string plus its len might be nice.
*/
- message->size_counter_delta =
- _dbus_string_get_length (&message->header) +
- _dbus_string_get_length (&message->body);
+
+ if (len)
+ *len = _dbus_demarshal_uint32 (&message->header,
+ message->byte_order,
+ offset,
+ NULL);
- _dbus_verbose ("message has size %ld\n",
- message->size_counter_delta);
+ data = _dbus_string_get_const_data (&message->header);
- _dbus_counter_adjust (message->size_counter, message->size_counter_delta);
+ return data + (offset + 4);
}
-static void
-dbus_message_write_header (DBusMessage *message)
+#ifdef DBUS_BUILD_TESTS
+static dbus_bool_t
+append_int_field (DBusMessage *message,
+ int field,
+ const char *name,
+ int value)
{
- char *len_data;
+ int orig_len;
+
+ _dbus_assert (!message->locked);
+
+ clear_header_padding (message);
- _dbus_assert (message->client_serial != -1);
+ orig_len = _dbus_string_get_length (&message->header);
- _dbus_string_append_byte (&message->header, DBUS_COMPILER_BYTE_ORDER);
- _dbus_string_append_len (&message->header, "\0\0\0", 3);
-
- /* We just lengthen the string here and pack in the real length later */
- _dbus_string_lengthen (&message->header, 4);
+ if (!_dbus_string_align_length (&message->header, 4))
+ goto failed;
- _dbus_marshal_int32 (&message->header, DBUS_COMPILER_BYTE_ORDER,
- _dbus_string_get_length (&message->body));
+ if (!_dbus_string_append_len (&message->header, name, 4))
+ goto failed;
- /* Marshal client serial */
- _dbus_assert (message->client_serial >= 0);
- _dbus_marshal_int32 (&message->header, DBUS_COMPILER_BYTE_ORDER,
- message->client_serial);
+ if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_INT32))
+ goto failed;
- /* Marshal message service */
- if (message->service)
- {
- _dbus_string_align_length (&message->header, 4);
- _dbus_string_append_len (&message->header, DBUS_HEADER_FIELD_SERVICE, 4);
- _dbus_string_append_byte (&message->header, DBUS_TYPE_STRING);
-
- _dbus_marshal_string (&message->header, DBUS_COMPILER_BYTE_ORDER,
- message->service);
- }
+ if (!_dbus_string_align_length (&message->header, 4))
+ goto failed;
+
+ message->header_fields[FIELD_REPLY_SERIAL].offset =
+ _dbus_string_get_length (&message->header);
+
+ if (!_dbus_marshal_int32 (&message->header, message->byte_order,
+ value))
+ goto failed;
- /* Marshal message name */
- _dbus_assert (message->name != NULL);
- _dbus_string_align_length (&message->header, 4);
- _dbus_string_append_len (&message->header, DBUS_HEADER_FIELD_NAME, 4);
- _dbus_string_append_byte (&message->header, DBUS_TYPE_STRING);
+ if (!append_header_padding (message))
+ goto failed;
+
+ return TRUE;
+
+ failed:
+ message->header_fields[field].offset = -1;
+ _dbus_string_set_length (&message->header, orig_len);
- _dbus_marshal_string (&message->header, DBUS_COMPILER_BYTE_ORDER, message->name);
+ /* this must succeed because it was allocated on function entry and
+ * DBusString doesn't ever realloc smaller
+ */
+ if (!append_header_padding (message))
+ _dbus_assert_not_reached ("failed to reappend header padding");
+ return FALSE;
+}
+#endif
- /* Marshal reply serial */
- if (message->reply_serial != -1)
- {
- _dbus_string_align_length (&message->header, 4);
- _dbus_string_append_len (&message->header, DBUS_HEADER_FIELD_REPLY, 4);
+static dbus_bool_t
+append_uint_field (DBusMessage *message,
+ int field,
+ const char *name,
+ int value)
+{
+ int orig_len;
- _dbus_string_append_byte (&message->header, DBUS_TYPE_INT32);
- _dbus_marshal_int32 (&message->header, DBUS_COMPILER_BYTE_ORDER,
- message->reply_serial);
- }
+ _dbus_assert (!message->locked);
- /* Marshal sender */
- if (message->sender)
- {
- _dbus_string_align_length (&message->header, 4);
- _dbus_string_append_len (&message->header, DBUS_HEADER_FIELD_SENDER, 4);
- _dbus_string_append_byte (&message->header, DBUS_TYPE_STRING);
+ clear_header_padding (message);
+
+ orig_len = _dbus_string_get_length (&message->header);
+
+ if (!_dbus_string_align_length (&message->header, 4))
+ goto failed;
+
+ if (!_dbus_string_append_len (&message->header, name, 4))
+ goto failed;
- _dbus_marshal_string (&message->header, DBUS_COMPILER_BYTE_ORDER,
- message->sender);
- }
+ if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_UINT32))
+ goto failed;
+
+ if (!_dbus_string_align_length (&message->header, 4))
+ goto failed;
- /* Fill in the length */
- _dbus_string_get_data_len (&message->header, &len_data, 4, 4);
- _dbus_pack_int32 (_dbus_string_get_length (&message->header),
- DBUS_COMPILER_BYTE_ORDER, len_data);
-}
+ message->header_fields[FIELD_REPLY_SERIAL].offset =
+ _dbus_string_get_length (&message->header);
+
+ if (!_dbus_marshal_uint32 (&message->header, message->byte_order,
+ value))
+ goto failed;
-/**
- * Locks a message. Allows checking that applications don't keep a
- * reference to a message in the outgoing queue and change it
- * underneath us. Messages are locked when they enter the outgoing
- * queue (dbus_connection_send_message()), and the library complains
- * if the message is modified while locked.
- *
- * @param message the message to lock.
- */
-void
-_dbus_message_lock (DBusMessage *message)
-{
- if (!message->locked)
- dbus_message_write_header (message);
+ if (!append_header_padding (message))
+ goto failed;
+
+ return TRUE;
- message->locked = TRUE;
+ failed:
+ message->header_fields[field].offset = -1;
+ _dbus_string_set_length (&message->header, orig_len);
+
+ /* this must succeed because it was allocated on function entry and
+ * DBusString doesn't ever realloc smaller
+ */
+ if (!append_header_padding (message))
+ _dbus_assert_not_reached ("failed to reappend header padding");
+ return FALSE;
}
-/** @} */
+static dbus_bool_t
+append_string_field (DBusMessage *message,
+ int field,
+ const char *name,
+ const char *value)
+{
+ int orig_len;
-/**
- * @defgroup DBusMessage DBusMessage
- * @ingroup DBus
- * @brief Message to be sent or received over a DBusConnection.
- *
- * A DBusMessage is the most basic unit of communication over a
- * DBusConnection. A DBusConnection represents a stream of messages
- * received from a remote application, and a stream of messages
- * sent to a remote application.
- *
- * @{
- */
+ _dbus_assert (!message->locked);
-/**
- * @typedef DBusMessage
- *
- * Opaque data type representing a message received from or to be
- * sent to another application.
- */
+ clear_header_padding (message);
+
+ orig_len = _dbus_string_get_length (&message->header);
-/**
- * Constructs a new message. Returns #NULL if memory
- * can't be allocated for the message.
- *
- * @todo use DBusString internally to store service and name.
- *
- * @param service service that the message should be sent to
- * @param name name of the message
- * @returns a new DBusMessage, free with dbus_message_unref()
- * @see dbus_message_unref()
- */
-DBusMessage*
-dbus_message_new (const char *service,
- const char *name)
-{
- DBusMessage *message;
+ if (!_dbus_string_align_length (&message->header, 4))
+ goto failed;
+
+ if (!_dbus_string_append_len (&message->header, name, 4))
+ goto failed;
+
+ if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_STRING))
+ goto failed;
- message = dbus_new0 (DBusMessage, 1);
- if (message == NULL)
- return NULL;
+ if (!_dbus_string_align_length (&message->header, 4))
+ goto failed;
- message->refcount = 1;
- message->byte_order = DBUS_COMPILER_BYTE_ORDER;
+ message->header_fields[field].offset =
+ _dbus_string_get_length (&message->header);
+
+ if (!_dbus_marshal_string (&message->header, message->byte_order,
+ value))
+ goto failed;
- message->service = _dbus_strdup (service);
- message->name = _dbus_strdup (name);
+ if (!append_header_padding (message))
+ goto failed;
- message->client_serial = -1;
- message->reply_serial = -1;
+ return TRUE;
- if (!_dbus_string_init (&message->header, _DBUS_INT_MAX))
- {
- dbus_free (message->service);
- dbus_free (message->name);
- dbus_free (message);
- return NULL;
- }
+ failed:
+ message->header_fields[field].offset = -1;
+ _dbus_string_set_length (&message->header, orig_len);
- if (!_dbus_string_init (&message->body, _DBUS_INT_MAX))
- {
- dbus_free (message->service);
- dbus_free (message->name);
- _dbus_string_free (&message->header);
- dbus_free (message);
- return NULL;
- }
+ /* this must succeed because it was allocated on function entry and
+ * DBusString doesn't ever realloc smaller
+ */
+ if (!append_header_padding (message))
+ _dbus_assert_not_reached ("failed to reappend header padding");
- return message;
+ return FALSE;
}
-/**
- * Constructs a message that is a reply to some other
- * message. Returns #NULL if memory can't be allocated
- * for the message.
- *
- * @param name the name of the message
- * @param original_message the message which the created
- * message is a reply to.
- * @returns a new DBusMessage, free with dbus_message_unref()
- * @see dbus_message_new(), dbus_message_unref()
- */
-DBusMessage*
-dbus_message_new_reply (const char *name,
- DBusMessage *original_message)
+#ifdef DBUS_BUILD_TESTS
+/* This isn't used, but building it when tests are enabled just to
+ * keep it compiling if we need it in future
+ */
+static void
+delete_int_or_uint_field (DBusMessage *message,
+ int field)
{
- DBusMessage *message;
+ int offset = message->header_fields[field].offset;
- _dbus_assert (original_message->sender != NULL);
+ _dbus_assert (!message->locked);
+ _dbus_assert (field_is_named[field]);
- message = dbus_message_new (original_message->sender, name);
+ if (offset < 0)
+ return;
+
+ clear_header_padding (message);
- if (message == NULL)
- return NULL;
+ /* The field typecode and name take up 8 bytes */
+ _dbus_string_delete (&message->header,
+ offset - 8,
+ 12);
- message->reply_serial = original_message->client_serial;
+ message->header_fields[field].offset = -1;
+
+ adjust_field_offsets (message,
+ offset - 8,
+ - 12);
- return message;
+ append_header_padding (message);
}
+#endif
-
-/**
- * Increments the reference count of a DBusMessage.
- *
- * @param message The message
- * @see dbus_message_unref
- */
-void
-dbus_message_ref (DBusMessage *message)
+static void
+delete_string_field (DBusMessage *message,
+ int field)
{
- _dbus_assert (message->refcount > 0);
+ int offset = message->header_fields[field].offset;
+ int len;
+ int delete_len;
+
+ _dbus_assert (!message->locked);
+ _dbus_assert (field_is_named[field]);
+
+ if (offset < 0)
+ return;
+
+ clear_header_padding (message);
+
+ get_string_field (message, field, &len);
- message->refcount += 1;
+ /* The field typecode and name take up 8 bytes, and the nul
+ * termination is 1 bytes, string length integer is 4 bytes
+ */
+ delete_len = 8 + 4 + 1 + len;
+
+ _dbus_string_delete (&message->header,
+ offset - 8,
+ delete_len);
+
+ message->header_fields[field].offset = -1;
+
+ adjust_field_offsets (message,
+ offset - 8,
+ - delete_len);
+
+ append_header_padding (message);
}
-/**
- * Decrements the reference count of a DBusMessage.
- *
- * @param message The message
- * @see dbus_message_ref
- */
-void
-dbus_message_unref (DBusMessage *message)
+#ifdef DBUS_BUILD_TESTS
+static dbus_bool_t
+set_int_field (DBusMessage *message,
+ int field,
+ int value)
{
- _dbus_assert (message->refcount > 0);
+ int offset = message->header_fields[field].offset;
- message->refcount -= 1;
- if (message->refcount == 0)
+ _dbus_assert (!message->locked);
+
+ if (offset < 0)
{
- if (message->size_counter != NULL)
+ /* need to append the field */
+
+ switch (field)
{
- _dbus_counter_adjust (message->size_counter,
- - message->size_counter_delta);
- _dbus_counter_unref (message->size_counter);
+ default:
+ _dbus_assert_not_reached ("appending an int field we don't support appending");
+ return FALSE;
}
-
- _dbus_string_free (&message->header);
- _dbus_string_free (&message->body);
-
- dbus_free (message->sender);
- dbus_free (message->service);
- dbus_free (message->name);
- dbus_free (message);
}
-}
+ else
+ {
+ _dbus_marshal_set_int32 (&message->header,
+ message->byte_order,
+ offset, value);
-/**
- * Gets the name of a message.
- *
- * @param message the message
- * @returns the message name (should not be freed)
- */
-const char*
-dbus_message_get_name (DBusMessage *message)
-{
- return message->name;
+ return TRUE;
+ }
}
+#endif
-/**
- * Gets the destination service of a message.
- *
- * @param message the message
- * @returns the message destination service (should not be freed)
- */
-const char*
-dbus_message_get_service (DBusMessage *message)
+static dbus_bool_t
+set_uint_field (DBusMessage *message,
+ int field,
+ dbus_uint32_t value)
{
- return message->service;
-}
+ int offset = message->header_fields[field].offset;
-/**
- * Appends fields to a message given a variable argument
- * list. The variable argument list should contain the type
- * of the field followed by the value to add.
- * The list is terminated with 0.
- *
- * @param message the message
- * @param first_field_type type of the first field
- * @param ... value of first field, list of additional type-value pairs
- * @returns #TRUE on success
- */
-dbus_bool_t
-dbus_message_append_fields (DBusMessage *message,
- int first_field_type,
- ...)
-{
- dbus_bool_t retval;
- va_list var_args;
+ _dbus_assert (!message->locked);
+
+ if (offset < 0)
+ {
+ /* need to append the field */
- va_start (var_args, first_field_type);
- retval = dbus_message_append_fields_valist (message,
- first_field_type,
- var_args);
- va_end (var_args);
+ switch (field)
+ {
+ case FIELD_REPLY_SERIAL:
+ return append_uint_field (message, field,
+ DBUS_HEADER_FIELD_REPLY,
+ value);
+ default:
+ _dbus_assert_not_reached ("appending a uint field we don't support appending");
+ return FALSE;
+ }
+ }
+ else
+ {
+ _dbus_marshal_set_uint32 (&message->header,
+ message->byte_order,
+ offset, value);
- return retval;
+ return TRUE;
+ }
}
-/**
- * This function takes a va_list for use by language bindings
- *
- * @see dbus_message_append_fields.
- * @param message the message
- * @param first_field_type type of first field
- * @param var_args value of first field, then list of type/value pairs
- * @returns #TRUE on success
- */
-dbus_bool_t
-dbus_message_append_fields_valist (DBusMessage *message,
- int first_field_type,
- va_list var_args)
+static dbus_bool_t
+set_string_field (DBusMessage *message,
+ int field,
+ const char *value)
{
- int type, old_len;
+ int offset = message->header_fields[field].offset;
- old_len = _dbus_string_get_length (&message->body);
+ _dbus_assert (!message->locked);
+ _dbus_assert (value != NULL);
- type = first_field_type;
+ if (offset < 0)
+ {
+ /* need to append the field */
- while (type != 0)
+ switch (field)
+ {
+ case FIELD_SENDER:
+ return append_string_field (message, field,
+ DBUS_HEADER_FIELD_SENDER,
+ value);
+ default:
+ _dbus_assert_not_reached ("appending a string field we don't support appending");
+ return FALSE;
+ }
+ }
+ else
{
- switch (type)
- {
- case DBUS_TYPE_INT32:
- if (!dbus_message_append_int32 (message, va_arg (var_args, dbus_int32_t)))
- goto enomem;
- break;
- case DBUS_TYPE_UINT32:
- if (!dbus_message_append_uint32 (message, va_arg (var_args, dbus_uint32_t)))
- goto enomem;
- break;
- case DBUS_TYPE_DOUBLE:
- if (!dbus_message_append_double (message, va_arg (var_args, double)))
- goto enomem;
- break;
- case DBUS_TYPE_STRING:
- if (!dbus_message_append_string (message, va_arg (var_args, const char *)))
- goto enomem;
- break;
- case DBUS_TYPE_BYTE_ARRAY:
- {
- int len;
- unsigned char *data;
-
- data = va_arg (var_args, unsigned char *);
- len = va_arg (var_args, int);
+ DBusString v;
+ int old_len;
+ int new_len;
+ int len;
+
+ clear_header_padding (message);
+
+ old_len = _dbus_string_get_length (&message->header);
- if (!dbus_message_append_byte_array (message, data, len))
- goto enomem;
- }
- break;
- case DBUS_TYPE_STRING_ARRAY:
- {
- int len;
- const char **data;
-
- data = va_arg (var_args, const char **);
- len = va_arg (var_args, int);
+ len = strlen (value);
+
+ _dbus_string_init_const_len (&v, value,
+ len + 1); /* include nul */
+ if (!_dbus_marshal_set_string (&message->header,
+ message->byte_order,
+ offset, &v,
+ len))
+ goto failed;
+
+ new_len = _dbus_string_get_length (&message->header);
- if (!dbus_message_append_string_array (message, data, len))
- goto enomem;
- }
- break;
-
- default:
- _dbus_warn ("Unknown field type %d\n", type);
- }
+ adjust_field_offsets (message,
+ offset,
+ new_len - old_len);
- type = va_arg (var_args, int);
- }
+ if (!append_header_padding (message))
+ goto failed;
+
+ return TRUE;
- return TRUE;
+ failed:
+ /* this must succeed because it was allocated on function entry and
+ * DBusString doesn't ever realloc smaller
+ */
+ if (!append_header_padding (message))
+ _dbus_assert_not_reached ("failed to reappend header padding");
- enomem:
- _dbus_string_set_length (&message->body, old_len);
- return FALSE;
+ return FALSE;
+ }
}
/**
- * Appends a 32 bit signed integer to the message.
- *
+ * Sets the serial number of a message.
+ * This can only be done once on a message.
+ *
* @param message the message
- * @param value the integer value
- * @returns #TRUE on success
+ * @param serial the serial
*/
-dbus_bool_t
-dbus_message_append_int32 (DBusMessage *message,
- dbus_int32_t value)
+void
+_dbus_message_set_serial (DBusMessage *message,
+ dbus_int32_t serial)
{
_dbus_assert (!message->locked);
-
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_INT32))
- {
- _dbus_string_shorten (&message->body, 1);
- return FALSE;
- }
+ _dbus_assert (dbus_message_get_serial (message) == 0);
- return _dbus_marshal_int32 (&message->body,
- DBUS_COMPILER_BYTE_ORDER, value);
+ set_uint_field (message, FIELD_CLIENT_SERIAL,
+ serial);
+ message->client_serial = serial;
}
/**
- * Appends a 32 bit unsigned integer to the message.
+ * Sets the reply serial of a message (the client serial
+ * of the message this is a reply to).
*
* @param message the message
- * @param value the integer value
- * @returns #TRUE on success
+ * @param reply_serial the client serial
+ * @returns #FALSE if not enough memory
*/
dbus_bool_t
-dbus_message_append_uint32 (DBusMessage *message,
- dbus_uint32_t value)
+dbus_message_set_reply_serial (DBusMessage *message,
+ dbus_uint32_t reply_serial)
{
_dbus_assert (!message->locked);
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_UINT32))
+ if (set_uint_field (message, FIELD_REPLY_SERIAL,
+ reply_serial))
{
- _dbus_string_shorten (&message->body, 1);
- return FALSE;
+ message->reply_serial = reply_serial;
+ return TRUE;
}
-
- return _dbus_marshal_uint32 (&message->body,
- DBUS_COMPILER_BYTE_ORDER, value);
+ else
+ return FALSE;
}
/**
- * Appends a double value to the message.
+ * Returns the serial of a message or -1 if none has been specified.
+ * The message's serial number is provided by the application sending
+ * the message and is used to identify replies to this message.
*
* @param message the message
- * @param value the double value
- * @returns #TRUE on success
+ * @returns the client serial
*/
-dbus_bool_t
-dbus_message_append_double (DBusMessage *message,
- double value)
+dbus_uint32_t
+dbus_message_get_serial (DBusMessage *message)
{
- _dbus_assert (!message->locked);
-
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_DOUBLE))
- {
- _dbus_string_shorten (&message->body, 1);
- return FALSE;
- }
-
- return _dbus_marshal_double (&message->body,
- DBUS_COMPILER_BYTE_ORDER, value);
+ return message->client_serial;
}
/**
- * Appends a UTF-8 string to the message.
+ * Returns the serial that the message is
+ * a reply to or 0 if none.
*
* @param message the message
- * @param value the string
- * @returns #TRUE on success
+ * @returns the reply serial
*/
-dbus_bool_t
-dbus_message_append_string (DBusMessage *message,
- const char *value)
+dbus_uint32_t
+dbus_message_get_reply_serial (DBusMessage *message)
{
- _dbus_assert (!message->locked);
+ return message->reply_serial;
+}
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_STRING))
+/**
+ * Adds a counter to be incremented immediately with the
+ * size of this message, and decremented by the size
+ * of this message when this message if finalized.
+ * The link contains a counter with its refcount already
+ * incremented, but the counter itself not incremented.
+ * Ownership of link and counter refcount is passed to
+ * the message.
+ *
+ * @param message the message
+ * @param link link with counter as data
+ */
+void
+_dbus_message_add_size_counter_link (DBusMessage *message,
+ DBusList *link)
+{
+ /* right now we don't recompute the delta when message
+ * size changes, and that's OK for current purposes
+ * I think, but could be important to change later.
+ * Do recompute it whenever there are no outstanding counters,
+ * since it's basically free.
+ */
+ if (message->size_counters == NULL)
{
- _dbus_string_shorten (&message->body, 1);
- return FALSE;
+ message->size_counter_delta =
+ _dbus_string_get_length (&message->header) +
+ _dbus_string_get_length (&message->body);
+
+#if 0
+ _dbus_verbose ("message has size %ld\n",
+ message->size_counter_delta);
+#endif
}
- return _dbus_marshal_string (&message->body,
- DBUS_COMPILER_BYTE_ORDER, value);
+ _dbus_list_append_link (&message->size_counters, link);
+
+ _dbus_counter_adjust (link->data, message->size_counter_delta);
}
/**
- * Appends a byte array to the message.
+ * Adds a counter to be incremented immediately with the
+ * size of this message, and decremented by the size
+ * of this message when this message if finalized.
*
* @param message the message
- * @param value the array
- * @param len the length of the array
- * @returns #TRUE on success
+ * @param counter the counter
+ * @returns #FALSE if no memory
*/
dbus_bool_t
-dbus_message_append_byte_array (DBusMessage *message,
- unsigned const char *value,
- int len)
+_dbus_message_add_size_counter (DBusMessage *message,
+ DBusCounter *counter)
{
- _dbus_assert (!message->locked);
+ DBusList *link;
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_BYTE_ARRAY))
- {
- _dbus_string_shorten (&message->body, 1);
- return FALSE;
- }
-
- return _dbus_marshal_byte_array (&message->body,
- DBUS_COMPILER_BYTE_ORDER, value, len);
+ link = _dbus_list_alloc_link (counter);
+ if (link == NULL)
+ return FALSE;
+
+ _dbus_counter_ref (counter);
+ _dbus_message_add_size_counter_link (message, link);
+
+ return TRUE;
}
/**
- * Appends a string array to the message.
+ * Removes a counter tracking the size of this message, and decrements
+ * the counter by the size of this message.
*
* @param message the message
- * @param value the array
- * @param len the length of the array
- * @returns #TRUE on success
+ * @param counter the counter
*/
-dbus_bool_t
-dbus_message_append_string_array (DBusMessage *message,
- const char **value,
- int len)
+void
+_dbus_message_remove_size_counter (DBusMessage *message,
+ DBusCounter *counter)
{
- _dbus_assert (!message->locked);
+ if (!_dbus_list_remove_last (&message->size_counters,
+ counter))
+ _dbus_assert_not_reached ("Removed a message size counter that was not added");
+
+ _dbus_counter_adjust (counter, message->size_counter_delta);
+
+ _dbus_counter_unref (counter);
+}
+
+static dbus_bool_t
+dbus_message_create_header (DBusMessage *message,
+ const char *name,
+ const char *service)
+{
+ unsigned int flags;
+
+ if (!_dbus_string_append_byte (&message->header, message->byte_order))
+ return FALSE;
+
+ flags = 0;
+ if (!_dbus_string_append_byte (&message->header, flags))
+ return FALSE;
+
+ if (!_dbus_string_append_byte (&message->header, DBUS_MAJOR_PROTOCOL_VERSION))
+ return FALSE;
+
+ if (!_dbus_string_append_byte (&message->header, 0))
+ return FALSE;
+
+ message->header_fields[FIELD_HEADER_LENGTH].offset = 4;
+ if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
+ return FALSE;
+
+ message->header_fields[FIELD_BODY_LENGTH].offset = 8;
+ if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
+ return FALSE;
- if (!_dbus_string_append_byte (&message->body, DBUS_TYPE_STRING_ARRAY))
+ message->header_fields[FIELD_CLIENT_SERIAL].offset = 12;
+ if (!_dbus_marshal_int32 (&message->header, message->byte_order, -1))
+ return FALSE;
+
+ /* Marshal message service */
+ if (service != NULL)
{
- _dbus_string_shorten (&message->body, 1);
- return FALSE;
+ if (!append_string_field (message,
+ FIELD_SERVICE,
+ DBUS_HEADER_FIELD_SERVICE,
+ service))
+ return FALSE;
}
+
+ _dbus_assert (name != NULL);
+ if (!append_string_field (message,
+ FIELD_NAME,
+ DBUS_HEADER_FIELD_NAME,
+ name))
+ return FALSE;
- return _dbus_marshal_string_array (&message->body,
- DBUS_COMPILER_BYTE_ORDER, value, len);
+ return TRUE;
}
/**
- * Gets fields from a message given a variable argument list.
- * The variable argument list should contain the type of the
- * field followed by a pointer to where the value should be
- * stored. The list is terminated with 0.
+ * Locks a message. Allows checking that applications don't keep a
+ * reference to a message in the outgoing queue and change it
+ * underneath us. Messages are locked when they enter the outgoing
+ * queue (dbus_connection_send_message()), and the library complains
+ * if the message is modified while locked.
*
- * @param message the message
- * @param first_field_type the first field type
- * @param ... location for first field value, then list of type-location pairs
- * @returns result code
+ * @param message the message to lock.
*/
-DBusResultCode
-dbus_message_get_fields (DBusMessage *message,
- int first_field_type,
- ...)
+void
+_dbus_message_lock (DBusMessage *message)
{
- DBusResultCode retval;
- va_list var_args;
+ if (!message->locked)
+ {
+ /* Fill in our lengths */
+ set_uint_field (message,
+ FIELD_HEADER_LENGTH,
+ _dbus_string_get_length (&message->header));
- va_start (var_args, first_field_type);
- retval = dbus_message_get_fields_valist (message, first_field_type, var_args);
- va_end (var_args);
+ set_uint_field (message,
+ FIELD_BODY_LENGTH,
+ _dbus_string_get_length (&message->body));
- return retval;
+ message->locked = TRUE;
+ }
}
+/** @} */
+
/**
- * This function takes a va_list for use by language bindings
- *
- * @todo this function (or some lower-level non-convenience function)
- * needs better error handling; should allow the application to
- * distinguish between out of memory, and bad data from the remote
- * app. It also needs to not leak a bunch of args when it gets
- * to the arg that's bad, as that would be a security hole
- * (allow one app to force another to leak memory)
+ * @defgroup DBusMessage DBusMessage
+ * @ingroup DBus
+ * @brief Message to be sent or received over a DBusConnection.
*
- * @todo We need to free the field data when an error occurs.
+ * A DBusMessage is the most basic unit of communication over a
+ * DBusConnection. A DBusConnection represents a stream of messages
+ * received from a remote application, and a stream of messages
+ * sent to a remote application.
*
- * @see dbus_message_get_fields
- * @param message the message
- * @param first_field_type type of the first field
- * @param var_args return location for first field, followed by list of type/location pairs
- * @returns result code
+ * @{
*/
-DBusResultCode
-dbus_message_get_fields_valist (DBusMessage *message,
- int first_field_type,
- va_list var_args)
-{
- int spec_type, msg_type, i;
- DBusMessageIter *iter;
- iter = dbus_message_get_fields_iter (message);
+/**
+ * @typedef DBusMessage
+ *
+ * Opaque data type representing a message received from or to be
+ * sent to another application.
+ */
- if (iter == NULL)
- return DBUS_RESULT_NO_MEMORY;
+static DBusMessage*
+dbus_message_new_empty_header (void)
+{
+ DBusMessage *message;
+ int i;
- spec_type = first_field_type;
- i = 0;
+ message = dbus_new0 (DBusMessage, 1);
+ if (message == NULL)
+ return NULL;
- while (spec_type != 0)
- {
- msg_type = dbus_message_iter_get_field_type (iter);
-
- if (msg_type != spec_type)
- {
- _dbus_verbose ("Field %d is specified to be of type \"%s\", but "
- "is actually of type \"%s\"\n", i,
- _dbus_type_to_string (spec_type),
- _dbus_type_to_string (msg_type));
- dbus_message_iter_unref (iter);
+ message->refcount = 1;
+ message->byte_order = DBUS_COMPILER_BYTE_ORDER;
+ message->client_serial = 0;
+ message->reply_serial = 0;
+
+ i = 0;
+ while (i < FIELD_LAST)
+ {
+ message->header_fields[i].offset = -1;
+ ++i;
+ }
+
+ if (!_dbus_string_init (&message->header))
+ {
+ dbus_free (message);
+ return NULL;
+ }
+
+ if (!_dbus_string_init (&message->body))
+ {
+ _dbus_string_free (&message->header);
+ dbus_free (message);
+ return NULL;
+ }
+
+ return message;
+}
- return DBUS_RESULT_INVALID_FIELDS;
- }
- switch (spec_type)
- {
- case DBUS_TYPE_INT32:
- {
- dbus_int32_t *ptr;
+/**
+ * Constructs a new message. Returns #NULL if memory can't be
+ * allocated for the message. The service may be #NULL in which case
+ * no service is set; this is appropriate when using D-BUS in a
+ * peer-to-peer context (no message bus).
+ *
+ * @todo reverse the arguments, first 'name' then 'service'
+ * as 'name' is more fundamental
+ *
+ * @param name name of the message
+ * @param destination_service service that the message should be sent to or #NULL
+ * @returns a new DBusMessage, free with dbus_message_unref()
+ * @see dbus_message_unref()
+ */
+DBusMessage*
+dbus_message_new (const char *name,
+ const char *destination_service)
+{
+ DBusMessage *message;
- ptr = va_arg (var_args, dbus_int32_t *);
+ _dbus_return_val_if_fail (name != NULL, NULL);
+
+ message = dbus_message_new_empty_header ();
+ if (message == NULL)
+ return NULL;
+
+ if (!dbus_message_create_header (message, name, destination_service))
+ {
+ dbus_message_unref (message);
+ return NULL;
+ }
+
+ return message;
+}
- *ptr = dbus_message_iter_get_int32 (iter);
- break;
- }
- case DBUS_TYPE_UINT32:
- {
- dbus_uint32_t *ptr;
+/**
+ * Constructs a message that is a reply to some other
+ * message. Returns #NULL if memory can't be allocated
+ * for the message.
+ *
+ * @param original_message the message which the created
+ * message is a reply to.
+ * @returns a new DBusMessage, free with dbus_message_unref()
+ * @see dbus_message_new(), dbus_message_unref()
+ */
+DBusMessage*
+dbus_message_new_reply (DBusMessage *original_message)
+{
+ DBusMessage *message;
+ const char *sender, *name;
- ptr = va_arg (var_args, dbus_uint32_t *);
+ _dbus_return_val_if_fail (original_message != NULL, NULL);
+
+ sender = get_string_field (original_message,
+ FIELD_SENDER, NULL);
+ name = get_string_field (original_message,
+ FIELD_NAME, NULL);
- *ptr = dbus_message_iter_get_uint32 (iter);
- break;
- }
+ /* sender is allowed to be null here in peer-to-peer case */
+
+ message = dbus_message_new (name, sender);
+
+ if (message == NULL)
+ return NULL;
- case DBUS_TYPE_DOUBLE:
- {
- double *ptr;
+ if (!dbus_message_set_reply_serial (message,
+ dbus_message_get_serial (original_message)))
+ {
+ dbus_message_unref (message);
+ return NULL;
+ }
- ptr = va_arg (var_args, double *);
+ return message;
+}
- *ptr = dbus_message_iter_get_double (iter);
- break;
- }
+/**
+ * Creates a new message that is an error reply to a certain message.
+ *
+ * @param original_message the original message
+ * @param error_name the error name
+ * @param error_message the error message string or #NULL for none
+ * @returns a new error message
+ */
+DBusMessage*
+dbus_message_new_error_reply (DBusMessage *original_message,
+ const char *error_name,
+ const char *error_message)
+{
+ DBusMessage *message;
+ const char *sender;
+ DBusMessageIter iter;
- case DBUS_TYPE_STRING:
- {
- char **ptr;
+ _dbus_return_val_if_fail (original_message != NULL, NULL);
+ _dbus_return_val_if_fail (error_name != NULL, NULL);
+
+ sender = get_string_field (original_message,
+ FIELD_SENDER, NULL);
- ptr = va_arg (var_args, char **);
+ /* sender may be NULL for non-message-bus case or
+ * when the message bus is dealing with an unregistered
+ * connection.
+ */
+
+ message = dbus_message_new (error_name, sender);
+
+ if (message == NULL)
+ return NULL;
- *ptr = dbus_message_iter_get_string (iter);
+ if (!dbus_message_set_reply_serial (message,
+ dbus_message_get_serial (original_message)))
+ {
+ dbus_message_unref (message);
+ return NULL;
+ }
- if (!*ptr)
- return DBUS_RESULT_NO_MEMORY;
-
- break;
- }
+ if (error_message != NULL)
+ {
+ dbus_message_append_iter_init (message, &iter);
+ if (!dbus_message_iter_append_string (&iter, error_message))
+ {
+ dbus_message_unref (message);
+ return NULL;
+ }
+ }
- case DBUS_TYPE_BYTE_ARRAY:
- {
- unsigned char **ptr;
- int *len;
+ dbus_message_set_is_error (message, TRUE);
+
+ return message;
+}
- ptr = va_arg (var_args, unsigned char **);
- len = va_arg (var_args, int *);
+/**
+ * Creates a new message that is an exact replica of the message
+ * specified, except that its refcount is set to 1.
+ *
+ * @param message the message.
+ * @returns the new message.
+ */
+DBusMessage *
+dbus_message_copy (const DBusMessage *message)
+{
+ DBusMessage *retval;
+ int i;
- *ptr = dbus_message_iter_get_byte_array (iter, len);
+ _dbus_return_val_if_fail (message != NULL, NULL);
+
+ retval = dbus_new0 (DBusMessage, 1);
+ if (retval == NULL)
+ return NULL;
+
+ retval->refcount = 1;
+ retval->byte_order = message->byte_order;
+ retval->client_serial = message->client_serial;
+ retval->reply_serial = message->reply_serial;
+ retval->header_padding = message->header_padding;
+ retval->locked = FALSE;
+
+ if (!_dbus_string_init (&retval->header))
+ {
+ dbus_free (retval);
+ return NULL;
+ }
+
+ if (!_dbus_string_init (&retval->body))
+ {
+ _dbus_string_free (&retval->header);
+ dbus_free (retval);
+ return NULL;
+ }
- if (!*ptr)
- return DBUS_RESULT_NO_MEMORY;
-
- break;
- }
- case DBUS_TYPE_STRING_ARRAY:
- {
- char ***ptr;
- int *len;
+ if (!_dbus_string_copy (&message->header, 0,
+ &retval->header, 0))
+ {
+ _dbus_string_free (&retval->header);
+ _dbus_string_free (&retval->body);
+ dbus_free (retval);
- ptr = va_arg (var_args, char ***);
- len = va_arg (var_args, int *);
+ return NULL;
+ }
- *ptr = dbus_message_iter_get_string_array (iter, len);
-
- if (!*ptr)
- return DBUS_RESULT_NO_MEMORY;
-
- break;
- }
- default:
- _dbus_warn ("Unknown field type %d\n", spec_type);
- }
-
- spec_type = va_arg (var_args, int);
- if (spec_type != 0 && !dbus_message_iter_next (iter))
- {
- _dbus_verbose ("More fields than exist in the message were specified\n");
+ if (!_dbus_string_copy (&message->body, 0,
+ &retval->body, 0))
+ {
+ _dbus_string_free (&retval->header);
+ _dbus_string_free (&retval->body);
+ dbus_free (retval);
- dbus_message_iter_unref (iter);
- return DBUS_RESULT_INVALID_FIELDS;
- }
- i++;
+ return NULL;
}
- dbus_message_iter_unref (iter);
- return DBUS_RESULT_SUCCESS;
+ for (i = 0; i < FIELD_LAST; i++)
+ {
+ retval->header_fields[i].offset = message->header_fields[i].offset;
+ }
+
+ return retval;
}
+
/**
- * Returns a DBusMessageIter representing the fields of the
- * message passed in.
- *
- * @todo IMO the message iter should follow the GtkTextIter pattern,
- * a static object with a "stamp" value used to detect invalid
- * iter uses (uninitialized or after changing the message).
- * ref/unref is kind of annoying to deal with, and slower too.
- * This implies not ref'ing the message from the iter.
+ * Increments the reference count of a DBusMessage.
*
- * @param message the message
- * @returns a new iter.
+ * @param message The message
+ * @see dbus_message_unref
*/
-DBusMessageIter *
-dbus_message_get_fields_iter (DBusMessage *message)
+void
+dbus_message_ref (DBusMessage *message)
{
- DBusMessageIter *iter;
-
- iter = dbus_new (DBusMessageIter, 1);
+ dbus_atomic_t refcount;
- dbus_message_ref (message);
+ _dbus_return_if_fail (message != NULL);
- iter->refcount = 1;
- iter->message = message;
- iter->pos = 0;
-
- return iter;
+ refcount = _dbus_atomic_inc (&message->refcount);
+ _dbus_assert (refcount > 1);
}
-/**
- * Increments the reference count of a DBusMessageIter.
- *
- * @param iter the message iter
- * @see dbus_message_iter_unref
- */
-void
-dbus_message_iter_ref (DBusMessageIter *iter)
+static void
+free_size_counter (void *element,
+ void *data)
{
- _dbus_assert (iter->refcount > 0);
+ DBusCounter *counter = element;
+ DBusMessage *message = data;
- iter->refcount += 1;
+ _dbus_counter_adjust (counter, - message->size_counter_delta);
+
+ _dbus_counter_unref (counter);
}
/**
- * Decrements the reference count of a DBusMessageIter.
+ * Decrements the reference count of a DBusMessage.
*
- * @param iter The message iter
- * @see dbus_message_iter_ref
+ * @param message The message
+ * @see dbus_message_ref
*/
void
-dbus_message_iter_unref (DBusMessageIter *iter)
+dbus_message_unref (DBusMessage *message)
{
- _dbus_assert (iter->refcount > 0);
+ dbus_atomic_t refcount;
- iter->refcount -= 1;
+ _dbus_return_if_fail (message != NULL);
+
+ refcount = _dbus_atomic_dec (&message->refcount);
+
+ _dbus_assert (refcount >= 0);
- if (iter->refcount == 0)
+ if (refcount == 0)
{
- dbus_message_unref (iter->message);
-
- dbus_free (iter);
+ _dbus_list_foreach (&message->size_counters,
+ free_size_counter, message);
+ _dbus_list_clear (&message->size_counters);
+
+ _dbus_string_free (&message->header);
+ _dbus_string_free (&message->body);
+
+ dbus_free (message);
}
}
/**
- * Checks if an iterator has any more fields.
+ * Gets the name of a message.
*
- * @param iter the message iter
- * @returns #TRUE if there are more fields
- * following
+ * @param message the message
+ * @returns the message name (should not be freed)
*/
-dbus_bool_t
-dbus_message_iter_has_next (DBusMessageIter *iter)
+const char*
+dbus_message_get_name (DBusMessage *message)
{
- int end_pos;
-
- if (!_dbus_marshal_get_field_end_pos (&iter->message->body, iter->message->byte_order,
- iter->pos, &end_pos))
- return FALSE;
+ _dbus_return_val_if_fail (message != NULL, NULL);
- if (end_pos >= _dbus_string_get_length (&iter->message->body))
- return FALSE;
-
- return TRUE;
+ return get_string_field (message, FIELD_NAME, NULL);
}
/**
- * Moves the iterator to the next field.
- *
- * @param iter The message iter
- * @returns #TRUE if the iterator was moved to the next field
+ * Gets the destination service of a message.
+ *
+ * @param message the message
+ * @returns the message destination service (should not be freed)
*/
-dbus_bool_t
-dbus_message_iter_next (DBusMessageIter *iter)
+const char*
+dbus_message_get_destination (DBusMessage *message)
{
- int end_pos;
+ _dbus_return_val_if_fail (message != NULL, NULL);
- if (!_dbus_marshal_get_field_end_pos (&iter->message->body, iter->message->byte_order,
- iter->pos, &end_pos))
- return FALSE;
-
- if (end_pos >= _dbus_string_get_length (&iter->message->body))
- return FALSE;
-
- iter->pos = end_pos;
-
- return TRUE;
+ return get_string_field (message, FIELD_SERVICE, NULL);
}
/**
- * Returns the field type of the field that the
- * message iterator points at.
+ * Appends fields to a message given a variable argument list. The
+ * variable argument list should contain the type of the argument
+ * followed by the value to add. Array values are specified by an int
+ * typecode followed by a pointer to the array followed by an int
+ * giving the length of the array. The argument list must be
+ * terminated with DBUS_TYPE_INVALID.
*
- * @param iter the message iter
- * @returns the field type
+ * This function doesn't support dicts or non-fundamental arrays.
+ *
+ * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64
+ * only if #DBUS_HAVE_INT64 is defined.
+ *
+ * @param message the message
+ * @param first_arg_type type of the first argument
+ * @param ... value of first argument, list of additional type-value pairs
+ * @returns #TRUE on success
*/
-int
-dbus_message_iter_get_field_type (DBusMessageIter *iter)
+dbus_bool_t
+dbus_message_append_args (DBusMessage *message,
+ int first_arg_type,
+ ...)
{
- const char *data;
-
- if (iter->pos >= _dbus_string_get_length (&iter->message->body))
- return DBUS_TYPE_INVALID;
-
- _dbus_string_get_const_data_len (&iter->message->body, &data, iter->pos, 1);
+ dbus_bool_t retval;
+ va_list var_args;
- if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_STRING_ARRAY)
- return *data;
+ _dbus_return_val_if_fail (message != NULL, FALSE);
+
+ va_start (var_args, first_arg_type);
+ retval = dbus_message_append_args_valist (message,
+ first_arg_type,
+ var_args);
+ va_end (var_args);
- return DBUS_TYPE_INVALID;
+ return retval;
}
/**
- * Returns the string value that an iterator may point to.
- * Note that you need to check that the iterator points to
- * a string value before using this function.
+ * This function takes a va_list for use by language bindings.
+ * It's otherwise the same as dbus_message_append_args().
*
- * @see dbus_message_iter_get_field_type
- * @param iter the message iter
- * @returns the string
+ * @todo: Shouldn't this function clean up the changes to the message
+ * on failures? (Yes)
+
+ * @see dbus_message_append_args.
+ * @param message the message
+ * @param first_arg_type type of first argument
+ * @param var_args value of first argument, then list of type/value pairs
+ * @returns #TRUE on success
*/
-char *
-dbus_message_iter_get_string (DBusMessageIter *iter)
+dbus_bool_t
+dbus_message_append_args_valist (DBusMessage *message,
+ int first_arg_type,
+ va_list var_args)
{
- _dbus_assert (dbus_message_iter_get_field_type (iter) == DBUS_TYPE_STRING);
+ int type, old_len;
+ DBusMessageIter iter;
- return _dbus_demarshal_string (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL);
-}
+ _dbus_return_val_if_fail (message != NULL, FALSE);
+
+ old_len = _dbus_string_get_length (&message->body);
+
+ type = first_arg_type;
-/**
- * Returns the 32 bit signed integer value that an iterator may point to.
- * Note that you need to check that the iterator points to
- * a string value before using this function.
- *
- * @see dbus_message_iter_get_field_type
- * @param iter the message iter
- * @returns the integer
- */
-int
-dbus_message_iter_get_int32 (DBusMessageIter *iter)
-{
- return _dbus_demarshal_int32 (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL);
-}
+ dbus_message_append_iter_init (message, &iter);
+
+ while (type != 0)
+ {
+ switch (type)
+ {
+ case DBUS_TYPE_NIL:
+ if (!dbus_message_iter_append_nil (&iter))
+ goto errorout;
+ break;
+ case DBUS_TYPE_BOOLEAN:
+ if (!dbus_message_iter_append_boolean (&iter, va_arg (var_args, dbus_bool_t)))
+ goto errorout;
+ break;
+ case DBUS_TYPE_INT32:
+ if (!dbus_message_iter_append_int32 (&iter, va_arg (var_args, dbus_int32_t)))
+ goto errorout;
+ break;
+ case DBUS_TYPE_UINT32:
+ if (!dbus_message_iter_append_uint32 (&iter, va_arg (var_args, dbus_uint32_t)))
+ goto errorout;
+ break;
+#ifdef DBUS_HAVE_INT64
+ case DBUS_TYPE_INT64:
+ if (!dbus_message_iter_append_int64 (&iter, va_arg (var_args, dbus_int64_t)))
+ goto errorout;
+ break;
+ case DBUS_TYPE_UINT64:
+ if (!dbus_message_iter_append_uint64 (&iter, va_arg (var_args, dbus_uint64_t)))
+ goto errorout;
+ break;
+#endif /* DBUS_HAVE_INT64 */
+ case DBUS_TYPE_DOUBLE:
+ if (!dbus_message_iter_append_double (&iter, va_arg (var_args, double)))
+ goto errorout;
+ break;
+ case DBUS_TYPE_STRING:
+ if (!dbus_message_iter_append_string (&iter, va_arg (var_args, const char *)))
+ goto errorout;
+ break;
+ case DBUS_TYPE_NAMED:
+ {
+ const char *name;
+ unsigned char *data;
+ int len;
+
+ name = va_arg (var_args, const char *);
+ data = va_arg (var_args, unsigned char *);
+ len = va_arg (var_args, int);
-/**
- * Returns the 32 bit unsigned integer value that an iterator may point to.
- * Note that you need to check that the iterator points to
- * a string value before using this function.
- *
- * @see dbus_message_iter_get_field_type
- * @param iter the message iter
- * @returns the integer
- */
-int
-dbus_message_iter_get_uint32 (DBusMessageIter *iter)
-{
- return _dbus_demarshal_uint32 (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL);
-}
+ if (!dbus_message_iter_append_named (&iter, name, data, len))
+ goto errorout;
+ break;
+ }
+ case DBUS_TYPE_ARRAY:
+ {
+ void *data;
+ int len, type;
+
+ type = va_arg (var_args, int);
+ data = va_arg (var_args, void *);
+ len = va_arg (var_args, int);
-/**
- * Returns the double value that an iterator may point to.
- * Note that you need to check that the iterator points to
- * a string value before using this function.
- *
- * @see dbus_message_iter_get_field_type
- * @param iter the message iter
- * @returns the double
- */
-double
-dbus_message_iter_get_double (DBusMessageIter *iter)
-{
- return _dbus_demarshal_double (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL);
+ switch (type)
+ {
+ case DBUS_TYPE_BYTE:
+ if (!dbus_message_iter_append_byte_array (&iter, (unsigned char *)data, len))
+ goto errorout;
+ break;
+ case DBUS_TYPE_BOOLEAN:
+ if (!dbus_message_iter_append_boolean_array (&iter, (unsigned char *)data, len))
+ goto errorout;
+ break;
+ case DBUS_TYPE_INT32:
+ if (!dbus_message_iter_append_int32_array (&iter, (dbus_int32_t *)data, len))
+ goto errorout;
+ break;
+ case DBUS_TYPE_UINT32:
+ if (!dbus_message_iter_append_uint32_array (&iter, (dbus_uint32_t *)data, len))
+ goto errorout;
+ break;
+#ifdef DBUS_HAVE_INT64
+ case DBUS_TYPE_INT64:
+ if (!dbus_message_iter_append_int64_array (&iter, (dbus_int64_t *)data, len))
+ goto errorout;
+ break;
+ case DBUS_TYPE_UINT64:
+ if (!dbus_message_iter_append_uint64_array (&iter, (dbus_uint64_t *)data, len))
+ goto errorout;
+ break;
+#endif /* DBUS_HAVE_INT64 */
+ case DBUS_TYPE_DOUBLE:
+ if (!dbus_message_iter_append_double_array (&iter, (double *)data, len))
+ goto errorout;
+ break;
+ case DBUS_TYPE_STRING:
+ if (!dbus_message_iter_append_string_array (&iter, (const char **)data, len))
+ goto errorout;
+ break;
+ case DBUS_TYPE_NIL:
+ case DBUS_TYPE_ARRAY:
+ case DBUS_TYPE_NAMED:
+ case DBUS_TYPE_DICT:
+ _dbus_warn ("dbus_message_append_args_valist doesn't support recursive arrays\n");
+ goto errorout;
+ default:
+ _dbus_warn ("Unknown field type %d\n", type);
+ goto errorout;
+ }
+ }
+ break;
+
+ case DBUS_TYPE_DICT:
+ _dbus_warn ("dbus_message_append_args_valist doesn't support dicts\n");
+ goto errorout;
+ default:
+ _dbus_warn ("Unknown field type %d\n", type);
+ goto errorout;
+ }
+
+ type = va_arg (var_args, int);
+ }
+
+ return TRUE;
+
+ errorout:
+ return FALSE;
}
+
/**
- * Returns the byte array that the iterator may point to.
- * Note that you need to check that the iterator points
- * to a byte array prior to using this function.
- *
- * @todo this function should probably take "unsigned char **" as
- * an out param argument, and return boolean or result code.
+ * Gets arguments from a message given a variable argument list.
+ * The variable argument list should contain the type of the
+ * argumen followed by a pointer to where the value should be
+ * stored. The list is terminated with 0.
*
- * @param iter the iterator
- * @param len return location for length of byte array
- * @returns the byte array
+ * @param message the message
+ * @param error error to be filled in on failure
+ * @param first_arg_type the first argument type
+ * @param ... location for first argument value, then list of type-location pairs
+ * @returns #FALSE if the error was set
*/
-unsigned char *
-dbus_message_iter_get_byte_array (DBusMessageIter *iter,
- int *len)
+dbus_bool_t
+dbus_message_get_args (DBusMessage *message,
+ DBusError *error,
+ int first_arg_type,
+ ...)
{
- _dbus_assert (dbus_message_iter_get_field_type (iter) == DBUS_TYPE_BYTE_ARRAY);
+ dbus_bool_t retval;
+ va_list var_args;
+
+ _dbus_return_val_if_fail (message != NULL, FALSE);
+ _dbus_return_val_if_error_is_set (error, FALSE);
+
+ va_start (var_args, first_arg_type);
+ retval = dbus_message_get_args_valist (message, error, first_arg_type, var_args);
+ va_end (var_args);
- return _dbus_demarshal_byte_array (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL, len);
+ return retval;
}
/**
- * Returns the string array that the iterator may point to.
- * Note that you need to check that the iterator points
- * to a byte array prior to using this function.
+ * This function takes a va_list for use by language bindings
*
- * @todo this function should probably take "char **" as
- * an out param argument, and return boolean or result code.
+ * @todo We need to free the argument data when an error occurs.
*
- * @param iter the iterator
- * @param len return location for length of byte array
- * @returns the byte array
+ * @see dbus_message_get_args
+ * @param message the message
+ * @param error error to be filled in
+ * @param first_arg_type type of the first argument
+ * @param var_args return location for first argument, followed by list of type/location pairs
+ * @returns #FALSE if error was set
*/
-char **
-dbus_message_iter_get_string_array (DBusMessageIter *iter,
- int *len)
+dbus_bool_t
+dbus_message_get_args_valist (DBusMessage *message,
+ DBusError *error,
+ int first_arg_type,
+ va_list var_args)
{
- _dbus_assert (dbus_message_iter_get_field_type (iter) == DBUS_TYPE_STRING_ARRAY);
+ DBusMessageIter iter;
- return _dbus_demarshal_string_array (&iter->message->body, iter->message->byte_order,
- iter->pos + 1, NULL, len);
+ _dbus_return_val_if_fail (message != NULL, FALSE);
+ _dbus_return_val_if_error_is_set (error, FALSE);
+
+ dbus_message_iter_init (message, &iter);
+ return dbus_message_iter_get_args_valist (&iter, error, first_arg_type, var_args);
}
/**
- * Sets the message sender.
+ * Gets arguments from a message iterator given a variable argument list.
+ * The variable argument list should contain the type of the
+ * argumen followed by a pointer to where the value should be
+ * stored. The list is terminated with 0.
*
- * @param message the message
- * @param sender the sender
+ * @param iter the message iterator
+ * @param error error to be filled in on failure
+ * @param first_arg_type the first argument type
+ * @param ... location for first argument value, then list of type-location pairs
+ * @returns #FALSE if the error was set
*/
-void
-dbus_message_set_sender (DBusMessage *message,
- const char *sender)
+dbus_bool_t
+dbus_message_iter_get_args (DBusMessageIter *iter,
+ DBusError *error,
+ int first_arg_type,
+ ...)
{
- _dbus_assert (!message->locked);
+ dbus_bool_t retval;
+ va_list var_args;
- message->sender = _dbus_strdup (sender);
-}
+ _dbus_return_val_if_fail (iter != NULL, FALSE);
+ _dbus_return_val_if_error_is_set (error, FALSE);
+
+ va_start (var_args, first_arg_type);
+ retval = dbus_message_iter_get_args_valist (iter, error, first_arg_type, var_args);
+ va_end (var_args);
-const char*
-dbus_message_get_sender (DBusMessage *message)
-{
- return message->sender;
+ return retval;
}
-/** @} */
-
/**
- * @addtogroup DBusMessageInternals
+ * This function takes a va_list for use by language bindings
*
- * @{
- */
-/**
- * @typedef DBusMessageLoader
+ * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64
+ * only if #DBUS_HAVE_INT64 is defined.
*
- * The DBusMessageLoader object encapsulates the process of converting
- * a byte stream into a series of DBusMessage. It buffers the incoming
- * bytes as efficiently as possible, and generates a queue of
- * messages. DBusMessageLoader is typically used as part of a
- * DBusTransport implementation. The DBusTransport then hands off
- * the loaded messages to a DBusConnection, making the messages
- * visible to the application.
- *
- */
-
-/**
- * Implementation details of DBusMessageLoader.
- * All members are private.
+ * @todo this function (or some lower-level non-convenience function)
+ * needs better error handling; should allow the application to
+ * distinguish between out of memory, and bad data from the remote
+ * app. It also needs to not leak a bunch of args when it gets
+ * to the arg that's bad, as that would be a security hole
+ * (allow one app to force another to leak memory)
+ *
+ * @todo We need to free the argument data when an error occurs.
+ *
+ * @see dbus_message_get_args
+ * @param iter the message iter
+ * @param error error to be filled in
+ * @param first_arg_type type of the first argument
+ * @param var_args return location for first argument, followed by list of type/location pairs
+ * @returns #FALSE if error was set
*/
-struct DBusMessageLoader
+dbus_bool_t
+dbus_message_iter_get_args_valist (DBusMessageIter *iter,
+ DBusError *error,
+ int first_arg_type,
+ va_list var_args)
{
- int refcount; /**< Reference count. */
+ int spec_type, msg_type, i;
+ dbus_bool_t retval;
- DBusString data; /**< Buffered data */
-
- DBusList *messages; /**< Complete messages. */
+ _dbus_return_val_if_fail (iter != NULL, FALSE);
+ _dbus_return_val_if_error_is_set (error, FALSE);
- long max_message_size; /**< Maximum size of a message */
+ retval = FALSE;
- unsigned int buffer_outstanding : 1; /**< Someone is using the buffer to read */
+ spec_type = first_arg_type;
+ i = 0;
+
+ while (spec_type != 0)
+ {
+ msg_type = dbus_message_iter_get_arg_type (iter);
+
+ if (msg_type != spec_type)
+ {
+ dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
+ "Argument %d is specified to be of type \"%s\", but "
+ "is actually of type \"%s\"\n", i,
+ _dbus_type_to_string (spec_type),
+ _dbus_type_to_string (msg_type));
- unsigned int corrupted : 1; /**< We got broken data, and are no longer working */
-};
+ goto out;
+ }
-/**
- * The initial buffer size of the message loader.
- *
- * @todo this should be based on min header size plus some average
- * body size, or something. Or rather, the min header size only, if we
- * want to try to read only the header, store that in a DBusMessage,
- * then read only the body and store that, etc., depends on
- * how we optimize _dbus_message_loader_get_buffer() and what
- * the exact message format is.
- */
-#define INITIAL_LOADER_DATA_LEN 32
+ switch (spec_type)
+ {
+ case DBUS_TYPE_NIL:
+ break;
+ case DBUS_TYPE_BYTE:
+ {
+ unsigned char *ptr;
-/**
- * Creates a new message loader. Returns #NULL if memory can't
- * be allocated.
- *
- * @returns new loader, or #NULL.
- */
-DBusMessageLoader*
-_dbus_message_loader_new (void)
-{
- DBusMessageLoader *loader;
+ ptr = va_arg (var_args, unsigned char *);
- loader = dbus_new0 (DBusMessageLoader, 1);
- if (loader == NULL)
- return NULL;
-
- loader->refcount = 1;
+ *ptr = dbus_message_iter_get_byte (iter);
+ break;
+ }
+ case DBUS_TYPE_BOOLEAN:
+ {
+ dbus_bool_t *ptr;
- /* Try to cap message size at something that won't *totally* hose
- * the system if we have a couple of them.
- */
- loader->max_message_size = _DBUS_ONE_MEGABYTE * 32;
-
- if (!_dbus_string_init (&loader->data, _DBUS_INT_MAX))
- {
- dbus_free (loader);
- return NULL;
- }
+ ptr = va_arg (var_args, dbus_bool_t *);
- /* preallocate the buffer for speed, ignore failure */
- _dbus_string_set_length (&loader->data, INITIAL_LOADER_DATA_LEN);
- _dbus_string_set_length (&loader->data, 0);
-
- return loader;
-}
+ *ptr = dbus_message_iter_get_boolean (iter);
+ break;
+ }
+ case DBUS_TYPE_INT32:
+ {
+ dbus_int32_t *ptr;
-/**
- * Increments the reference count of the loader.
- *
- * @param loader the loader.
- */
-void
-_dbus_message_loader_ref (DBusMessageLoader *loader)
-{
- loader->refcount += 1;
-}
+ ptr = va_arg (var_args, dbus_int32_t *);
-/**
- * Decrements the reference count of the loader and finalizes the
- * loader when the count reaches zero.
- *
- * @param loader the loader.
- */
-void
-_dbus_message_loader_unref (DBusMessageLoader *loader)
-{
- loader->refcount -= 1;
- if (loader->refcount == 0)
- {
- _dbus_list_foreach (&loader->messages,
- (DBusForeachFunction) dbus_message_unref,
- NULL);
- _dbus_list_clear (&loader->messages);
- _dbus_string_free (&loader->data);
- dbus_free (loader);
+ *ptr = dbus_message_iter_get_int32 (iter);
+ break;
+ }
+ case DBUS_TYPE_UINT32:
+ {
+ dbus_uint32_t *ptr;
+
+ ptr = va_arg (var_args, dbus_uint32_t *);
+
+ *ptr = dbus_message_iter_get_uint32 (iter);
+ break;
+ }
+#ifdef DBUS_HAVE_INT64
+ case DBUS_TYPE_INT64:
+ {
+ dbus_int64_t *ptr;
+
+ ptr = va_arg (var_args, dbus_int64_t *);
+
+ *ptr = dbus_message_iter_get_int64 (iter);
+ break;
+ }
+ case DBUS_TYPE_UINT64:
+ {
+ dbus_uint64_t *ptr;
+
+ ptr = va_arg (var_args, dbus_uint64_t *);
+
+ *ptr = dbus_message_iter_get_uint64 (iter);
+ break;
+ }
+#endif /* DBUS_HAVE_INT64 */
+
+ case DBUS_TYPE_DOUBLE:
+ {
+ double *ptr;
+
+ ptr = va_arg (var_args, double *);
+
+ *ptr = dbus_message_iter_get_double (iter);
+ break;
+ }
+
+ case DBUS_TYPE_STRING:
+ {
+ char **ptr;
+
+ ptr = va_arg (var_args, char **);
+
+ *ptr = dbus_message_iter_get_string (iter);
+
+ if (!*ptr)
+ {
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+ goto out;
+ }
+
+ break;
+ }
+
+ case DBUS_TYPE_NAMED:
+ {
+ char **name;
+ unsigned char **data;
+ int *len;
+
+ name = va_arg (var_args, char **);
+ data = va_arg (var_args, unsigned char **);
+ len = va_arg (var_args, int *);
+
+ if (!dbus_message_iter_get_named (iter, name, data, len))
+ {
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+ goto out;
+ }
+ }
+ break;
+ case DBUS_TYPE_ARRAY:
+ {
+ void **data;
+ int *len, type;
+
+ type = va_arg (var_args, int);
+ data = va_arg (var_args, void *);
+ len = va_arg (var_args, int *);
+
+ if (dbus_message_iter_get_array_type (iter) != type)
+ {
+ dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
+ "Argument %d is specified to be of type \"array of %s\", but "
+ "is actually of type \"array of %s\"\n", i,
+ _dbus_type_to_string (type),
+ _dbus_type_to_string (dbus_message_iter_get_array_type (iter)));
+ goto out;
+ }
+
+ switch (type)
+ {
+ case DBUS_TYPE_BYTE:
+ if (!dbus_message_iter_get_byte_array (iter, (unsigned char **)data, len))
+ {
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+ goto out;
+ }
+ break;
+ case DBUS_TYPE_BOOLEAN:
+ if (!dbus_message_iter_get_boolean_array (iter, (unsigned char **)data, len))
+ {
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+ goto out;
+ }
+ break;
+ case DBUS_TYPE_INT32:
+ if (!dbus_message_iter_get_int32_array (iter, (dbus_int32_t **)data, len))
+ {
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+ goto out;
+ }
+ break;
+ case DBUS_TYPE_UINT32:
+ if (!dbus_message_iter_get_uint32_array (iter, (dbus_uint32_t **)data, len))
+ {
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+ goto out;
+ }
+ break;
+#ifdef DBUS_HAVE_INT64
+ case DBUS_TYPE_INT64:
+ if (!dbus_message_iter_get_int64_array (iter, (dbus_int64_t **)data, len))
+ {
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+ goto out;
+ }
+ break;
+ case DBUS_TYPE_UINT64:
+ if (!dbus_message_iter_get_uint64_array (iter, (dbus_uint64_t **)data, len))
+ {
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+ goto out;
+ }
+ break;
+#endif /* DBUS_HAVE_INT64 */
+ case DBUS_TYPE_DOUBLE:
+ if (!dbus_message_iter_get_double_array (iter, (double **)data, len))
+ {
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+ goto out;
+ }
+ break;
+ case DBUS_TYPE_STRING:
+ if (!dbus_message_iter_get_string_array (iter, (char ***)data, len))
+ {
+ dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+ goto out;
+ }
+ break;
+ case DBUS_TYPE_NIL:
+ case DBUS_TYPE_ARRAY:
+ case DBUS_TYPE_NAMED:
+ case DBUS_TYPE_DICT:
+ _dbus_warn ("dbus_message_get_args_valist doesn't support recursive arrays\n");
+ dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
+ goto out;
+ default:
+ _dbus_warn ("Unknown field type %d\n", type);
+ dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
+ goto out;
+ }
+ }
+ break;
+ case DBUS_TYPE_DICT:
+ _dbus_warn ("dbus_message_get_args_valist doesn't support dicts\n");
+ dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
+ goto out;
+ default:
+ dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
+ _dbus_warn ("Unknown field type %d\n", spec_type);
+ goto out;
+ }
+
+ spec_type = va_arg (var_args, int);
+ if (spec_type != 0 && !dbus_message_iter_next (iter))
+ {
+ dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
+ "Message has only %d arguments, but more were expected", i);
+ goto out;
+ }
+
+ i++;
}
+
+ retval = TRUE;
+
+ out:
+
+ return retval;
}
+
/**
- * Gets the buffer to use for reading data from the network. Network
- * data is read directly into an allocated buffer, which is then used
- * in the DBusMessage, to avoid as many extra memcpy's as possible.
- * The buffer must always be returned immediately using
- * _dbus_message_loader_return_buffer(), even if no bytes are
- * successfully read.
+ * Initializes a DBusMessageIter representing the arguments of the
+ * message passed in.
*
- * @todo this function can be a lot more clever. For example
- * it can probably always return a buffer size to read exactly
- * the body of the next message, thus avoiding any memory wastage
- * or reallocs.
- *
- * @param loader the message loader.
- * @param buffer the buffer
+ * @param message the message
+ * @param iter pointer to an iterator to initialize
*/
void
-_dbus_message_loader_get_buffer (DBusMessageLoader *loader,
- DBusString **buffer)
+dbus_message_iter_init (DBusMessage *message,
+ DBusMessageIter *iter)
{
- _dbus_assert (!loader->buffer_outstanding);
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
- *buffer = &loader->data;
+ _dbus_return_if_fail (message != NULL);
+ _dbus_return_if_fail (iter != NULL);
- loader->buffer_outstanding = TRUE;
+ _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
+
+ real->message = message;
+ real->parent_iter = NULL;
+ real->changed_stamp = message->changed_stamp;
+
+ real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
+ real->pos = 0;
+ real->end = _dbus_string_get_length (&message->body);
+
+ real->container_start = 0;
+ real->container_length_pos = 0;
+ real->wrote_dict_key = 0;
+ real->array_type_pos = 0;
+}
+
+#ifndef DBUS_DISABLE_CHECKS
+static dbus_bool_t
+dbus_message_iter_check (DBusMessageRealIter *iter)
+{
+ if (iter == NULL)
+ {
+ _dbus_warn ("dbus iterator check failed: iterator is NULL\n");
+ return FALSE;
+ }
+
+ if (iter->changed_stamp != iter->message->changed_stamp)
+ {
+ _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message\n");
+ return FALSE;
+ }
+
+ if (iter->pos < 0 || iter->pos > iter->end)
+ {
+ _dbus_warn ("dbus iterator check failed: invalid position\n");
+ return FALSE;
+ }
+
+ return TRUE;
+}
+#endif /* DBUS_DISABLE_CHECKS */
+
+static int
+skip_array_type (DBusMessageRealIter *iter, int pos)
+{
+ const char *data;
+
+ do
+ {
+ data = _dbus_string_get_const_data_len (&iter->message->body,
+ pos++, 1);
+ }
+ while (*data == DBUS_TYPE_ARRAY);
+
+ return pos;
+}
+
+static int
+dbus_message_iter_get_data_start (DBusMessageRealIter *iter, int *type)
+{
+ const char *data;
+ int pos, len;
+
+ switch (iter->type)
+ {
+ case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
+ data = _dbus_string_get_const_data_len (&iter->message->body,
+ iter->pos, 1);
+ if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
+ *type = *data;
+ else
+ *type = DBUS_TYPE_INVALID;
+
+ return skip_array_type (iter, iter->pos);
+
+ case DBUS_MESSAGE_ITER_TYPE_ARRAY:
+ data = _dbus_string_get_const_data_len (&iter->message->body,
+ iter->array_type_pos, 1);
+ if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
+ *type = *data;
+ else
+ *type = DBUS_TYPE_INVALID;
+
+ return iter->pos;
+
+ case DBUS_MESSAGE_ITER_TYPE_DICT:
+ /* Get the length of the string */
+ len = _dbus_demarshal_uint32 (&iter->message->body,
+ iter->message->byte_order,
+ iter->pos, &pos);
+ pos = pos + len + 1;
+
+ data = _dbus_string_get_const_data_len (&iter->message->body,
+ pos, 1);
+ if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
+ *type = *data;
+ else
+ *type = DBUS_TYPE_INVALID;
+
+ return skip_array_type (iter, pos);
+
+ default:
+ _dbus_assert_not_reached ("Invalid iter type");
+ break;
+ }
+ *type = DBUS_TYPE_INVALID;
+ return iter->pos;
}
+
/**
- * The smallest header size that can occur.
- * (It won't be valid)
+ * Checks if an iterator has any more fields.
+ *
+ * @param iter the message iter
+ * @returns #TRUE if there are more fields
+ * following
*/
-#define DBUS_MINIMUM_HEADER_SIZE 16
+dbus_bool_t
+dbus_message_iter_has_next (DBusMessageIter *iter)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int end_pos;
+ int type, pos;
-/** Pack four characters as in "abcd" into a uint32 */
-#define FOUR_CHARS_TO_UINT32(a, b, c, d) \
- ((((dbus_uint32_t)a) << 24) | \
- (((dbus_uint32_t)b) << 16) | \
- (((dbus_uint32_t)c) << 8) | \
- ((dbus_uint32_t)d))
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
-/** DBUS_HEADER_FIELD_NAME packed into a dbus_uint32_t */
-#define DBUS_HEADER_FIELD_NAME_AS_UINT32 \
- FOUR_CHARS_TO_UINT32 ('n', 'a', 'm', 'e')
+ if (real->pos >= real->end)
+ return FALSE;
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
+ real->message->byte_order,
+ type, pos, &end_pos))
+ return FALSE;
+
+ if (end_pos >= real->end)
+ return FALSE;
-/** DBUS_HEADER_FIELD_SERVICE packed into a dbus_uint32_t */
-#define DBUS_HEADER_FIELD_SERVICE_AS_UINT32 \
- FOUR_CHARS_TO_UINT32 ('s', 'r', 'v', 'c')
+ return TRUE;
+}
-/** DBUS_HEADER_FIELD_REPLY packed into a dbus_uint32_t */
-#define DBUS_HEADER_FIELD_REPLY_AS_UINT32 \
- FOUR_CHARS_TO_UINT32 ('r', 'p', 'l', 'y')
+/**
+ * Moves the iterator to the next field.
+ *
+ * @param iter The message iter
+ * @returns #TRUE if the iterator was moved to the next field
+ */
+dbus_bool_t
+dbus_message_iter_next (DBusMessageIter *iter)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int end_pos;
+ int type, pos;
-/** DBUS_HEADER_FIELD_SENDER Packed into a dbus_uint32_t */
-#define DBUS_HEADER_FIELD_SENDER_AS_UINT32 \
- FOUR_CHARS_TO_UINT32 ('s', 'n', 'd', 'r')
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
+ real->message->byte_order,
+ type, pos, &end_pos))
+ return FALSE;
+
+ if (end_pos >= real->end)
+ return FALSE;
+
+ real->pos = end_pos;
+ return TRUE;
+}
-/* FIXME should be using DBusString for the stuff we demarshal. char*
- * evil. Also, out of memory handling here seems suboptimal.
- * Should probably report it as a distinct error from "corrupt message,"
- * so we can postpone parsing this message. Also, we aren't
- * checking for demarshal failure everywhere.
+/**
+ * Returns the argument type of the argument that the
+ * message iterator points at.
+ *
+ * @param iter the message iter
+ * @returns the field type
*/
-static dbus_bool_t
-decode_header_data (DBusString *data,
- int header_len,
- int byte_order,
- dbus_int32_t *client_serial,
- dbus_int32_t *reply_serial,
- char **service,
- char **name,
- char **sender)
+int
+dbus_message_iter_get_arg_type (DBusMessageIter *iter)
{
- const char *field;
- int pos, new_pos;
-
- /* First demarshal the client serial */
- *client_serial = _dbus_demarshal_int32 (data, byte_order, 12, &pos);
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
- *reply_serial = -1;
- *service = NULL;
- *name = NULL;
- *sender = NULL;
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID);
- /* Now handle the fields */
- while (pos < header_len)
- {
- pos = _DBUS_ALIGN_VALUE (pos, 4);
-
- if ((pos + 4) > header_len)
- return FALSE;
-
- _dbus_string_get_const_data_len (data, &field, pos, 4);
- pos += 4;
+ if (real->pos >= real->end)
+ return DBUS_TYPE_INVALID;
- _dbus_assert (_DBUS_ALIGN_ADDRESS (field, 4) == field);
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ return type;
+}
- /* I believe FROM_BE is right, but if not we'll find out
- * I guess. ;-)
- */
- switch (DBUS_UINT32_FROM_BE (*(int*)field))
- {
- case DBUS_HEADER_FIELD_SERVICE_AS_UINT32:
- if (*service != NULL)
- {
- _dbus_verbose ("%s field provided twice\n",
- DBUS_HEADER_FIELD_SERVICE);
- goto failed;
- }
-
- *service = _dbus_demarshal_string (data, byte_order, pos + 1, &new_pos);
- /* FIXME check for demarshal failure SECURITY */
- break;
- case DBUS_HEADER_FIELD_NAME_AS_UINT32:
- if (*name != NULL)
- {
- _dbus_verbose ("%s field provided twice\n",
- DBUS_HEADER_FIELD_NAME);
- goto failed;
- }
-
- *name = _dbus_demarshal_string (data, byte_order, pos + 1, &new_pos);
- /* FIXME check for demarshal failure SECURITY */
- break;
- case DBUS_HEADER_FIELD_SENDER_AS_UINT32:
- if (*sender != NULL)
- {
- _dbus_verbose ("%s field provided twice\n",
- DBUS_HEADER_FIELD_NAME);
- goto failed;
- }
+static int
+iter_get_array_type (DBusMessageRealIter *iter, int *array_type_pos)
+{
+ const char *data;
+ int _array_type_pos;
+ int len, pos;
+
+ switch (iter->type)
+ {
+ case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
+ _array_type_pos = iter->pos + 1;
+ break;
+ case DBUS_MESSAGE_ITER_TYPE_ARRAY:
+ _array_type_pos = iter->array_type_pos + 1;
+ break;
+ case DBUS_MESSAGE_ITER_TYPE_DICT:
+ /* Get the length of the string */
+ len = _dbus_demarshal_uint32 (&iter->message->body,
+ iter->message->byte_order,
+ iter->pos, &pos);
+ pos = pos + len + 1;
+ data = _dbus_string_get_const_data_len (&iter->message->body,
+ pos + 1, 1);
+ _array_type_pos = pos + 1;
+ break;
+ default:
+ _dbus_assert_not_reached ("wrong iter type");
+ return DBUS_TYPE_INVALID;
+ }
- *sender = _dbus_demarshal_string (data, byte_order, pos + 1, &new_pos);
- /* FIXME check for demarshal failure SECURITY */
- break;
- case DBUS_HEADER_FIELD_REPLY_AS_UINT32:
- *reply_serial = _dbus_demarshal_int32 (data, byte_order, pos + 1, &new_pos);
+ if (array_type_pos != NULL)
+ *array_type_pos = _array_type_pos;
+
+ data = _dbus_string_get_const_data_len (&iter->message->body,
+ _array_type_pos, 1);
+ if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
+ return *data;
+
+ return DBUS_TYPE_INVALID;
+}
+
+/**
+ * Returns the element type of the array that the
+ * message iterator points at. Note that you need
+ * to check that the iterator points to an array
+ * prior to using this function.
+ *
+ * @param iter the message iter
+ * @returns the field type
+ */
+int
+dbus_message_iter_get_array_type (DBusMessageIter *iter)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID);
+
+ if (real->pos >= real->end)
+ return DBUS_TYPE_INVALID;
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_ARRAY);
+
+ return iter_get_array_type (real, NULL);
+}
+
+
+/**
+ * Returns the string value that an iterator may point to.
+ * Note that you need to check that the iterator points to
+ * a string value before using this function.
+ *
+ * @see dbus_message_iter_get_arg_type
+ * @param iter the message iter
+ * @returns the string
+ */
+char *
+dbus_message_iter_get_string (DBusMessageIter *iter)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_STRING);
+
+ return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
+ pos, NULL);
+}
+
+/**
+ * Returns the name and data from a named type that an
+ * iterator may point to. Note that you need to check that
+ * the iterator points to a named type before using this
+ * function.
+ *
+ * @see dbus_message_iter_get_arg_type
+ * @param iter the message iter
+ * @param name return location for the name
+ * @param value return location for data
+ * @param len return location for length of data
+ * @returns TRUE if get succeed
+ *
+ */
+dbus_bool_t
+dbus_message_iter_get_named (DBusMessageIter *iter,
+ char **name,
+ unsigned char **value,
+ int *len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+ char *_name;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_NAMED);
+
+ _name = _dbus_demarshal_string (&real->message->body, real->message->byte_order,
+ pos, &pos);
+
+ if (_name == NULL)
+ return FALSE;
+
+ if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
+ pos + 1, NULL, value, len))
+ {
+ dbus_free (_name);
+ return FALSE;
+ }
+
+ *name = _name;
+
+ return TRUE;
+}
+
+/**
+ * Returns the byte value that an iterator may point to.
+ * Note that you need to check that the iterator points to
+ * a byte value before using this function.
+ *
+ * @see dbus_message_iter_get_arg_type
+ * @param iter the message iter
+ * @returns the byte value
+ */
+unsigned char
+dbus_message_iter_get_byte (DBusMessageIter *iter)
+{
+ unsigned char value;
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_BYTE);
+
+ value = _dbus_string_get_byte (&real->message->body, pos);
+
+ return value;
+}
+
+
+/**
+ * Returns the boolean value that an iterator may point to.
+ * Note that you need to check that the iterator points to
+ * a boolean value before using this function.
+ *
+ * @see dbus_message_iter_get_arg_type
+ * @param iter the message iter
+ * @returns the boolean value
+ */
+dbus_bool_t
+dbus_message_iter_get_boolean (DBusMessageIter *iter)
+{
+ unsigned char value;
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_BOOLEAN);
+
+ value = _dbus_string_get_byte (&real->message->body, pos);
+
+ return value;
+}
+
+/**
+ * Returns the 32 bit signed integer value that an iterator may point to.
+ * Note that you need to check that the iterator points to
+ * a 32-bit integer value before using this function.
+ *
+ * @see dbus_message_iter_get_arg_type
+ * @param iter the message iter
+ * @returns the integer
+ */
+dbus_int32_t
+dbus_message_iter_get_int32 (DBusMessageIter *iter)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_INT32);
+
+ return _dbus_demarshal_int32 (&real->message->body, real->message->byte_order,
+ pos, NULL);
+}
+
+/**
+ * Returns the 32 bit unsigned integer value that an iterator may point to.
+ * Note that you need to check that the iterator points to
+ * a 32-bit unsigned integer value before using this function.
+ *
+ * @see dbus_message_iter_get_arg_type
+ * @param iter the message iter
+ * @returns the integer
+ */
+dbus_uint32_t
+dbus_message_iter_get_uint32 (DBusMessageIter *iter)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_UINT32);
+
+ return _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
+ pos, NULL);
+}
+
+#ifdef DBUS_HAVE_INT64
+
+/**
+ * Returns the 64 bit signed integer value that an iterator may point
+ * to. Note that you need to check that the iterator points to a
+ * 64-bit integer value before using this function.
+ *
+ * This function only exists if #DBUS_HAVE_INT64 is defined.
+ *
+ * @see dbus_message_iter_get_arg_type
+ * @param iter the message iter
+ * @returns the integer
+ */
+dbus_int64_t
+dbus_message_iter_get_int64 (DBusMessageIter *iter)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_INT64);
+
+ return _dbus_demarshal_int64 (&real->message->body, real->message->byte_order,
+ pos, NULL);
+}
+
+/**
+ * Returns the 64 bit unsigned integer value that an iterator may point to.
+ * Note that you need to check that the iterator points to
+ * a 64-bit unsigned integer value before using this function.
+ *
+ * This function only exists if #DBUS_HAVE_INT64 is defined.
+ *
+ * @see dbus_message_iter_get_arg_type
+ * @param iter the message iter
+ * @returns the integer
+ */
+dbus_uint64_t
+dbus_message_iter_get_uint64 (DBusMessageIter *iter)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_UINT64);
+
+ return _dbus_demarshal_uint64 (&real->message->body, real->message->byte_order,
+ pos, NULL);
+}
+
+#endif /* DBUS_HAVE_INT64 */
+
+/**
+ * Returns the double value that an iterator may point to.
+ * Note that you need to check that the iterator points to
+ * a string value before using this function.
+ *
+ * @see dbus_message_iter_get_arg_type
+ * @param iter the message iter
+ * @returns the double
+ */
+double
+dbus_message_iter_get_double (DBusMessageIter *iter)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), 0.0);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_DOUBLE);
+
+ return _dbus_demarshal_double (&real->message->body, real->message->byte_order,
+ pos, NULL);
+}
+
+/**
+ * Initializes an iterator for the array that the iterator
+ * may point to. Note that you need to check that the iterator
+ * points to an array prior to using this function.
+ *
+ * The array element type is returned in array_type, and the array
+ * iterator can only be used to get that type of data.
+ *
+ * @param iter the iterator
+ * @param array_iter pointer to an iterator to initialize
+ * @param array_type gets set to the type of the array elements
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
+ DBusMessageIter *array_iter,
+ int *array_type)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
+ int type, pos, len_pos, len, array_type_pos;
+ int _array_type;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_ARRAY);
+
+ _array_type = iter_get_array_type (real, &array_type_pos);
+
+ len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
+ len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
+ pos, &pos);
+
+ array_real->parent_iter = real;
+ array_real->message = real->message;
+ array_real->changed_stamp = real->message->changed_stamp;
+
+ array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
+ array_real->pos = pos;
+ array_real->end = pos + len;
+
+ array_real->container_start = pos;
+ array_real->container_length_pos = len_pos;
+ array_real->wrote_dict_key = 0;
+ array_real->array_type_pos = array_type_pos;
+ array_real->array_type_done = TRUE;
+
+ if (array_type != NULL)
+ *array_type = _array_type;
+
+ return TRUE;
+}
+
+
+/**
+ * Initializes an iterator for the dict that the iterator
+ * may point to. Note that you need to check that the iterator
+ * points to a dict prior to using this function.
+ *
+ * @param iter the iterator
+ * @param dict_iter pointer to an iterator to initialize
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
+ DBusMessageIter *dict_iter)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
+ int type, pos, len_pos, len;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_DICT);
+
+ len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
+ len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
+ pos, &pos);
+
+ dict_real->parent_iter = real;
+ dict_real->message = real->message;
+ dict_real->changed_stamp = real->message->changed_stamp;
+
+ dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
+ dict_real->pos = pos;
+ dict_real->end = pos + len;
+
+ dict_real->container_start = pos;
+ dict_real->container_length_pos = len_pos;
+ dict_real->wrote_dict_key = 0;
+
+ return TRUE;
+}
+
+/**
+ * Returns the byte array that the iterator may point to.
+ * Note that you need to check that the iterator points
+ * to a byte array prior to using this function.
+ *
+ * @param iter the iterator
+ * @param value return location for array values
+ * @param len return location for length of byte array
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_get_byte_array (DBusMessageIter *iter,
+ unsigned char **value,
+ int *len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_ARRAY);
+
+ type = iter_get_array_type (real, NULL);
+
+ _dbus_assert (type == DBUS_TYPE_BYTE);
+
+ if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
+ pos, NULL, value, len))
+ return FALSE;
+ else
+ return TRUE;
+}
+
+/**
+ * Returns the boolean array that the iterator may point to. Note that
+ * you need to check that the iterator points to an array of the
+ * correct type prior to using this function.
+ *
+ * @param iter the iterator
+ * @param value return location for the array
+ * @param len return location for the array length
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
+ unsigned char **value,
+ int *len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_ARRAY);
+
+ type = iter_get_array_type (real, NULL);
+
+ _dbus_assert (type == DBUS_TYPE_BOOLEAN);
+
+ if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
+ pos, NULL, value, len))
+ return FALSE;
+ else
+ return TRUE;
+}
+
+/**
+ * Returns the 32 bit signed integer array that the iterator may point
+ * to. Note that you need to check that the iterator points to an
+ * array of the correct type prior to using this function.
+ *
+ * @param iter the iterator
+ * @param value return location for the array
+ * @param len return location for the array length
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_get_int32_array (DBusMessageIter *iter,
+ dbus_int32_t **value,
+ int *len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_ARRAY);
+
+ type = iter_get_array_type (real, NULL);
+
+ _dbus_assert (type == DBUS_TYPE_INT32);
+
+ if (!_dbus_demarshal_int32_array (&real->message->body, real->message->byte_order,
+ pos, NULL, value, len))
+ return FALSE;
+ else
+ return TRUE;
+}
+
+/**
+ * Returns the 32 bit unsigned integer array that the iterator may point
+ * to. Note that you need to check that the iterator points to an
+ * array of the correct type prior to using this function.
+ *
+ * @param iter the iterator
+ * @param value return location for the array
+ * @param len return location for the array length
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
+ dbus_uint32_t **value,
+ int *len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_ARRAY);
+
+ type = iter_get_array_type (real, NULL);
+ _dbus_assert (type == DBUS_TYPE_UINT32);
+
+ if (!_dbus_demarshal_uint32_array (&real->message->body, real->message->byte_order,
+ pos, NULL, value, len))
+ return FALSE;
+ else
+ return TRUE;
+}
+
+#ifdef DBUS_HAVE_INT64
+
+/**
+ * Returns the 64 bit signed integer array that the iterator may point
+ * to. Note that you need to check that the iterator points to an
+ * array of the correct type prior to using this function.
+ *
+ * This function only exists if #DBUS_HAVE_INT64 is defined.
+ *
+ * @param iter the iterator
+ * @param value return location for the array
+ * @param len return location for the array length
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_get_int64_array (DBusMessageIter *iter,
+ dbus_int64_t **value,
+ int *len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_ARRAY);
+
+ type = iter_get_array_type (real, NULL);
+
+ _dbus_assert (type == DBUS_TYPE_INT64);
+
+ if (!_dbus_demarshal_int64_array (&real->message->body, real->message->byte_order,
+ pos, NULL, value, len))
+ return FALSE;
+ else
+ return TRUE;
+}
+
+/**
+ * Returns the 64 bit unsigned integer array that the iterator may point
+ * to. Note that you need to check that the iterator points to an
+ * array of the correct type prior to using this function.
+ *
+ * This function only exists if #DBUS_HAVE_INT64 is defined.
+ *
+ * @param iter the iterator
+ * @param value return location for the array
+ * @param len return location for the array length
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_get_uint64_array (DBusMessageIter *iter,
+ dbus_uint64_t **value,
+ int *len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_ARRAY);
+
+ type = iter_get_array_type (real, NULL);
+ _dbus_assert (type == DBUS_TYPE_UINT64);
+
+ if (!_dbus_demarshal_uint64_array (&real->message->body, real->message->byte_order,
+ pos, NULL, value, len))
+ return FALSE;
+ else
+ return TRUE;
+}
+
+#endif /* DBUS_HAVE_INT64 */
+
+/**
+ * Returns the double array that the iterator may point to. Note that
+ * you need to check that the iterator points to an array of the
+ * correct type prior to using this function.
+ *
+ * @param iter the iterator
+ * @param value return location for the array
+ * @param len return location for the array length
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_get_double_array (DBusMessageIter *iter,
+ double **value,
+ int *len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_ARRAY);
+
+ type = iter_get_array_type (real, NULL);
+ _dbus_assert (type == DBUS_TYPE_DOUBLE);
+
+ if (!_dbus_demarshal_double_array (&real->message->body, real->message->byte_order,
+ pos, NULL, value, len))
+ return FALSE;
+ else
+ return TRUE;
+}
+
+/**
+ * Returns the string array that the iterator may point to.
+ * Note that you need to check that the iterator points
+ * to a byte array prior to using this function.
+ *
+ * The returned value is a #NULL-terminated array of strings.
+ * Each string is a separate malloc block, and the array
+ * itself is a malloc block. You can free this type of
+ * string array with dbus_free_string_array().
+ *
+ * @param iter the iterator
+ * @param value return location for string values
+ * @param len return location for length of byte array
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_get_string_array (DBusMessageIter *iter,
+ char ***value,
+ int *len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ int type, pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
+
+ pos = dbus_message_iter_get_data_start (real, &type);
+
+ _dbus_assert (type == DBUS_TYPE_ARRAY);
+
+ type = iter_get_array_type (real, NULL);
+ _dbus_assert (type == DBUS_TYPE_STRING);
+
+ if (!_dbus_demarshal_string_array (&real->message->body, real->message->byte_order,
+ pos, NULL, value, len))
+ return FALSE;
+ else
+ return TRUE;
+}
+
+/**
+ * Returns the key name fot the dict entry that an iterator
+ * may point to. Note that you need to check that the iterator
+ * points to a dict entry before using this function.
+ *
+ * @see dbus_message_iter_init_dict_iterator
+ * @param iter the message iter
+ * @returns the key name
+ */
+char *
+dbus_message_iter_get_dict_key (DBusMessageIter *iter)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL);
+
+ _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
+
+ return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
+ real->pos, NULL);
+}
+
+/**
+ * Initializes a DBusMessageIter pointing to the end of the
+ * message. This iterator can be used to append data to the
+ * message.
+ *
+ * @param message the message
+ * @param iter pointer to an iterator to initialize
+ */
+void
+dbus_message_append_iter_init (DBusMessage *message,
+ DBusMessageIter *iter)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_if_fail (message != NULL);
+ _dbus_return_if_fail (iter != NULL);
+
+ real->message = message;
+ real->parent_iter = NULL;
+ real->changed_stamp = message->changed_stamp;
+
+ real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
+ real->end = _dbus_string_get_length (&real->message->body);
+ real->pos = real->end;
+
+ real->container_length_pos = 0;
+ real->wrote_dict_key = 0;
+}
+
+#ifndef DBUS_DISABLE_CHECKS
+static dbus_bool_t
+dbus_message_iter_append_check (DBusMessageRealIter *iter)
+{
+ if (iter == NULL)
+ {
+ _dbus_warn ("dbus iterator check failed: NULL iterator\n");
+ return FALSE;
+ }
+
+ if (iter->message->locked)
+ {
+ _dbus_warn ("dbus iterator check failed: message is locked (has already been sent)\n");
+ return FALSE;
+ }
+
+ if (iter->changed_stamp != iter->message->changed_stamp)
+ {
+ _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message");
+ return FALSE;
+ }
+
+ if (iter->pos != iter->end)
+ {
+ _dbus_warn ("dbus iterator check failed: can only append at end of message");
+ return FALSE;
+ }
+
+ if (iter->pos != _dbus_string_get_length (&iter->message->body))
+ {
+ _dbus_warn ("dbus iterator check failed: append pos not at end of message string");
+ return FALSE;
+ }
+
+ return TRUE;
+}
+#endif /* DBUS_DISABLE_CHECKS */
+
+static dbus_bool_t
+dbus_message_iter_append_type (DBusMessageRealIter *iter,
+ int type)
+{
+ const char *data;
+ switch (iter->type)
+ {
+ case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
+ if (!_dbus_string_append_byte (&iter->message->body, type))
+ return FALSE;
+ break;
+
+ case DBUS_MESSAGE_ITER_TYPE_ARRAY:
+ data = _dbus_string_get_const_data_len (&iter->message->body,
+ iter->array_type_pos, 1);
+ if (type != *data)
+ {
+ _dbus_warn ("Appended element of wrong type for array\n");
+ return FALSE;
+ }
+ break;
+
+ case DBUS_MESSAGE_ITER_TYPE_DICT:
+ if (!iter->wrote_dict_key)
+ {
+ _dbus_warn ("Appending dict data before key name\n");
+ return FALSE;
+ }
+
+ if (!_dbus_string_append_byte (&iter->message->body, type))
+ return FALSE;
+
+ break;
+
+ default:
+ _dbus_assert_not_reached ("Invalid iter type");
+ break;
+ }
+
+ return TRUE;
+}
+
+static void
+dbus_message_iter_update_after_change (DBusMessageRealIter *iter)
+{
+ iter->changed_stamp = iter->message->changed_stamp;
+
+ /* Set new end of iter */
+ iter->end = _dbus_string_get_length (&iter->message->body);
+ iter->pos = iter->end;
+
+ /* Set container length */
+ if (iter->type == DBUS_MESSAGE_ITER_TYPE_DICT ||
+ (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY && iter->array_type_done))
+ _dbus_marshal_set_uint32 (&iter->message->body,
+ iter->message->byte_order,
+ iter->container_length_pos,
+ iter->end - iter->container_start);
+
+ if (iter->parent_iter)
+ dbus_message_iter_update_after_change (iter->parent_iter);
+}
+
+static void
+dbus_message_iter_append_done (DBusMessageRealIter *iter)
+{
+ iter->message->changed_stamp++;
+ dbus_message_iter_update_after_change (iter);
+ iter->wrote_dict_key = FALSE;
+}
+
+/**
+ * Appends a nil value to the message
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_nil (DBusMessageIter *iter)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!dbus_message_iter_append_type (real, DBUS_TYPE_NIL))
+ return FALSE;
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+/**
+ * Appends a boolean value to the message
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the boolean value
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_boolean (DBusMessageIter *iter,
+ dbus_bool_t value)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!dbus_message_iter_append_type (real, DBUS_TYPE_BOOLEAN))
+ return FALSE;
+
+ if (!_dbus_string_append_byte (&real->message->body, (value != FALSE)))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+/**
+ * Appends a byte to the message
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the byte value
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_byte (DBusMessageIter *iter,
+ unsigned char value)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!dbus_message_iter_append_type (real, DBUS_TYPE_BYTE))
+ return FALSE;
+
+ if (!_dbus_string_append_byte (&real->message->body, value))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+
+/**
+ * Appends a 32 bit signed integer to the message.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the integer value
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_int32 (DBusMessageIter *iter,
+ dbus_int32_t value)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT32))
+ return FALSE;
+
+ if (!_dbus_marshal_int32 (&real->message->body, real->message->byte_order, value))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+/**
+ * Appends a 32 bit unsigned integer to the message.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the integer value
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_uint32 (DBusMessageIter *iter,
+ dbus_uint32_t value)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT32))
+ return FALSE;
+
+ if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, value))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+#ifdef DBUS_HAVE_INT64
+
+/**
+ * Appends a 64 bit signed integer to the message.
+ *
+ * This function only exists if #DBUS_HAVE_INT64 is defined.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the integer value
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_int64 (DBusMessageIter *iter,
+ dbus_int64_t value)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT64))
+ return FALSE;
+
+ if (!_dbus_marshal_int64 (&real->message->body, real->message->byte_order, value))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+/**
+ * Appends a 64 bit unsigned integer to the message.
+ *
+ * This function only exists if #DBUS_HAVE_INT64 is defined.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the integer value
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_uint64 (DBusMessageIter *iter,
+ dbus_uint64_t value)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT64))
+ return FALSE;
+
+ if (!_dbus_marshal_uint64 (&real->message->body, real->message->byte_order, value))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+#endif /* DBUS_HAVE_INT64 */
+
+/**
+ * Appends a double value to the message.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the double value
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_double (DBusMessageIter *iter,
+ double value)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!dbus_message_iter_append_type (real, DBUS_TYPE_DOUBLE))
+ return FALSE;
+
+ if (!_dbus_marshal_double (&real->message->body, real->message->byte_order, value))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+/**
+ * Appends a UTF-8 string to the message.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the string
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_string (DBusMessageIter *iter,
+ const char *value)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!dbus_message_iter_append_type (real, DBUS_TYPE_STRING))
+ return FALSE;
+
+ if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+/**
+ * Appends a named type data chunk to the message. A named
+ * type is simply an arbitrary UTF-8 string used as a type
+ * tag, plus an array of arbitrary bytes to be interpreted
+ * according to the type tag.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param name the name of the type
+ * @param data the binary data used to store the value
+ * @param len the length of the binary data in bytes
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_named (DBusMessageIter *iter,
+ const char *name,
+ const unsigned char *data,
+ int len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!dbus_message_iter_append_type (real, DBUS_TYPE_NAMED))
+ return FALSE;
+
+ if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, name))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, data, len))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+
+/**
+ * Appends a dict key name to the message. The iterator used
+ * must point to a dict.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the string
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_dict_key (DBusMessageIter *iter,
+ const char *value)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+ _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
+
+ if (real->wrote_dict_key)
+ {
+ _dbus_warn ("Appendinging multiple dict key names\n");
+ return FALSE;
+ }
+
+ if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
+ {
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+ real->wrote_dict_key = TRUE;
+
+ return TRUE;
+}
+
+static dbus_bool_t
+array_iter_type_mark_done (DBusMessageRealIter *iter)
+{
+ int len_pos;
+
+ if (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY)
+ array_iter_type_mark_done (iter->parent_iter);
+ else
+ return TRUE;
+
+ len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&iter->message->body),
+ sizeof (dbus_uint32_t));
+
+ /* Empty length for now, backfill later */
+ if (!_dbus_marshal_uint32 (&iter->message->body, iter->message->byte_order, 0))
+ {
+ _dbus_string_set_length (&iter->message->body, iter->pos);
+ return FALSE;
+ }
+
+ iter->container_start = _dbus_string_get_length (&iter->message->body);
+ iter->container_length_pos = len_pos;
+ iter->array_type_done = TRUE;
+
+ return TRUE;
+}
+
+static dbus_bool_t
+append_array_type (DBusMessageRealIter *real,
+ int element_type,
+ dbus_bool_t *array_type_done,
+ int *array_type_pos)
+{
+ int existing_element_type;
+
+ if (!dbus_message_iter_append_type (real, DBUS_TYPE_ARRAY))
+ return FALSE;
+
+ if (real->type == DBUS_MESSAGE_ITER_TYPE_ARRAY &&
+ real->array_type_done)
+ {
+ existing_element_type = iter_get_array_type (real, array_type_pos);
+ if (existing_element_type != element_type)
+ {
+ _dbus_warn ("Appending array of %s, when expecting array of %s\n",
+ _dbus_type_to_string (element_type),
+ _dbus_type_to_string (existing_element_type));
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+ if (array_type_done != NULL)
+ *array_type_done = TRUE;
+ }
+ else
+ {
+ if (array_type_pos != NULL)
+ *array_type_pos = _dbus_string_get_length (&real->message->body);
+
+ /* Append element type */
+ if (!_dbus_string_append_byte (&real->message->body, element_type))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ if (array_type_done != NULL)
+ *array_type_done = element_type != DBUS_TYPE_ARRAY;
+
+ if (element_type != DBUS_TYPE_ARRAY &&
+ !array_iter_type_mark_done (real))
+ return FALSE;
+ }
+
+ return TRUE;
+}
+
+/**
+ * Appends an array to the message and initializes an iterator that
+ * can be used to append to the array.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param array_iter pointer to an iter that will be initialized
+ * @param element_type the type of the array elements
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_array (DBusMessageIter *iter,
+ DBusMessageIter *array_iter,
+ int element_type)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
+ int len_pos;
+ int array_type_pos;
+ dbus_bool_t array_type_done;
+
+ if (element_type == DBUS_TYPE_NIL)
+ {
+ _dbus_warn ("Can't create NIL arrays\n");
+ return FALSE;
+ }
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!append_array_type (real, element_type, &array_type_done, &array_type_pos))
+ return FALSE;
+
+ len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
+
+ if (array_type_done)
+ {
+ /* Empty length for now, backfill later */
+ if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+ }
+
+ array_real->parent_iter = real;
+ array_real->message = real->message;
+ array_real->changed_stamp = real->message->changed_stamp;
+
+ array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
+ array_real->pos = _dbus_string_get_length (&real->message->body);
+ array_real->end = array_real->end;
+
+ array_real->container_start = array_real->pos;
+ array_real->container_length_pos = len_pos;
+ array_real->wrote_dict_key = 0;
+ array_real->array_type_done = array_type_done;
+ array_real->array_type_pos = array_type_pos;
+
+ dbus_message_iter_append_done (array_real);
+
+ return TRUE;
+}
+
+/**
+ * Appends a dict to the message and initializes an iterator that
+ * can be used to append to the dict.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param dict_iter pointer to an iter that will be initialized
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_dict (DBusMessageIter *iter,
+ DBusMessageIter *dict_iter)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+ DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
+ int len_pos;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!dbus_message_iter_append_type (real, DBUS_TYPE_DICT))
+ return FALSE;
+
+ len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
+
+ /* Empty length for now, backfill later */
+ if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dict_real->parent_iter = real;
+ dict_real->message = real->message;
+ dict_real->changed_stamp = real->message->changed_stamp;
+
+ dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
+ dict_real->pos = _dbus_string_get_length (&real->message->body);
+ dict_real->end = dict_real->end;
+
+ dict_real->container_start = dict_real->pos;
+ dict_real->container_length_pos = len_pos;
+ dict_real->wrote_dict_key = 0;
+
+ dbus_message_iter_append_done (dict_real);
+
+ return TRUE;
+}
+
+
+/**
+ * Appends a boolean array to the message.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the array
+ * @param len the length of the array
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
+ unsigned const char *value,
+ int len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!append_array_type (real, DBUS_TYPE_BOOLEAN, NULL, NULL))
+ return FALSE;
+
+ if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+/**
+ * Appends a 32 bit signed integer array to the message.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the array
+ * @param len the length of the array
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_int32_array (DBusMessageIter *iter,
+ const dbus_int32_t *value,
+ int len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!append_array_type (real, DBUS_TYPE_INT32, NULL, NULL))
+ return FALSE;
+
+ if (!_dbus_marshal_int32_array (&real->message->body, real->message->byte_order, value, len))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+/**
+ * Appends a 32 bit unsigned integer array to the message.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the array
+ * @param len the length of the array
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
+ const dbus_uint32_t *value,
+ int len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!append_array_type (real, DBUS_TYPE_UINT32, NULL, NULL))
+ return FALSE;
+
+ if (!_dbus_marshal_uint32_array (&real->message->body, real->message->byte_order, value, len))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+#ifdef DBUS_HAVE_INT64
+
+/**
+ * Appends a 64 bit signed integer array to the message.
+ *
+ * This function only exists if #DBUS_HAVE_INT64 is defined.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the array
+ * @param len the length of the array
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_int64_array (DBusMessageIter *iter,
+ const dbus_int64_t *value,
+ int len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!append_array_type (real, DBUS_TYPE_INT64, NULL, NULL))
+ return FALSE;
+
+ if (!_dbus_marshal_int64_array (&real->message->body, real->message->byte_order, value, len))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+/**
+ * Appends a 64 bit unsigned integer array to the message.
+ *
+ * This function only exists if #DBUS_HAVE_INT64 is defined.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the array
+ * @param len the length of the array
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_uint64_array (DBusMessageIter *iter,
+ const dbus_uint64_t *value,
+ int len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!append_array_type (real, DBUS_TYPE_UINT64, NULL, NULL))
+ return FALSE;
+
+ if (!_dbus_marshal_uint64_array (&real->message->body, real->message->byte_order, value, len))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+#endif /* DBUS_HAVE_INT64 */
+
+/**
+ * Appends a double array to the message.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the array
+ * @param len the length of the array
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_double_array (DBusMessageIter *iter,
+ const double *value,
+ int len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!append_array_type (real, DBUS_TYPE_DOUBLE, NULL, NULL))
+ return FALSE;
+
+ if (!_dbus_marshal_double_array (&real->message->body, real->message->byte_order, value, len))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+/**
+ * Appends a byte array to the message.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the array
+ * @param len the length of the array
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_byte_array (DBusMessageIter *iter,
+ unsigned const char *value,
+ int len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!append_array_type (real, DBUS_TYPE_BYTE, NULL, NULL))
+ return FALSE;
+
+ if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+/**
+ * Appends a string array to the message.
+ *
+ * @param iter an iterator pointing to the end of the message
+ * @param value the array
+ * @param len the length of the array
+ * @returns #TRUE on success
+ */
+dbus_bool_t
+dbus_message_iter_append_string_array (DBusMessageIter *iter,
+ const char **value,
+ int len)
+{
+ DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
+
+ _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
+
+ if (!append_array_type (real, DBUS_TYPE_STRING, NULL, NULL))
+ return FALSE;
+
+ if (!_dbus_marshal_string_array (&real->message->body, real->message->byte_order, value, len))
+ {
+ _dbus_string_set_length (&real->message->body, real->pos);
+ return FALSE;
+ }
+
+ dbus_message_iter_append_done (real);
+
+ return TRUE;
+}
+
+/**
+ * Sets the message sender.
+ *
+ * @param message the message
+ * @param sender the sender
+ * @returns #FALSE if not enough memory
+ */
+dbus_bool_t
+dbus_message_set_sender (DBusMessage *message,
+ const char *sender)
+{
+ _dbus_return_val_if_fail (message != NULL, FALSE);
+ _dbus_return_val_if_fail (!message->locked, FALSE);
+
+ if (sender == NULL)
+ {
+ delete_string_field (message, FIELD_SENDER);
+ return TRUE;
+ }
+ else
+ {
+ return set_string_field (message,
+ FIELD_SENDER,
+ sender);
+ }
+}
+
+/**
+ * Sets a flag indicating that the message is an error reply
+ * message, i.e. an "exception" rather than a normal response.
+ *
+ * @param message the message
+ * @param is_error_reply #TRUE if this is an error message.
+ */
+void
+dbus_message_set_is_error (DBusMessage *message,
+ dbus_bool_t is_error_reply)
+{
+ char *header;
+
+ _dbus_return_if_fail (message != NULL);
+ _dbus_return_if_fail (!message->locked);
+
+ header = _dbus_string_get_data_len (&message->header, 1, 1);
+
+ if (is_error_reply)
+ *header |= DBUS_HEADER_FLAG_ERROR;
+ else
+ *header &= ~DBUS_HEADER_FLAG_ERROR;
+}
+
+/**
+ * Returns #TRUE if the message is an error
+ * reply to some previous message we sent.
+ *
+ * @param message the message
+ * @returns #TRUE if the message is an error
+ */
+dbus_bool_t
+dbus_message_get_is_error (DBusMessage *message)
+{
+ const char *header;
+
+ _dbus_return_val_if_fail (message != NULL, FALSE);
+
+ header = _dbus_string_get_const_data_len (&message->header, 1, 1);
+
+ return (*header & DBUS_HEADER_FLAG_ERROR) != 0;
+}
+
+/**
+ * Gets the service which originated this message,
+ * or #NULL if unknown or inapplicable.
+ *
+ * @param message the message
+ * @returns the service name or #NULL
+ */
+const char*
+dbus_message_get_sender (DBusMessage *message)
+{
+ _dbus_return_val_if_fail (message != NULL, NULL);
+
+ return get_string_field (message, FIELD_SENDER, NULL);
+}
+
+/**
+ * Checks whether the message has the given name.
+ * If the message has no name or has a different
+ * name, returns #FALSE.
+ *
+ * @param message the message
+ * @param name the name to check (must not be #NULL)
+ *
+ * @returns #TRUE if the message has the given name
+ */
+dbus_bool_t
+dbus_message_has_name (DBusMessage *message,
+ const char *name)
+{
+ const char *n;
+
+ _dbus_return_val_if_fail (message != NULL, FALSE);
+ _dbus_return_val_if_fail (name != NULL, FALSE);
+
+ n = dbus_message_get_name (message);
+
+ if (n && strcmp (n, name) == 0)
+ return TRUE;
+ else
+ return FALSE;
+}
+
+/**
+ * Checks whether the message was sent to the given service. If the
+ * message has no service specified or has a different name, returns
+ * #FALSE.
+ *
+ * @param message the message
+ * @param service the service to check (must not be #NULL)
+ *
+ * @returns #TRUE if the message has the given destination service
+ */
+dbus_bool_t
+dbus_message_has_destination (DBusMessage *message,
+ const char *service)
+{
+ const char *s;
+
+ _dbus_return_val_if_fail (message != NULL, FALSE);
+ _dbus_return_val_if_fail (service != NULL, FALSE);
+
+ s = dbus_message_get_destination (message);
+
+ if (s && strcmp (s, service) == 0)
+ return TRUE;
+ else
+ return FALSE;
+}
+
+/**
+ * Checks whether the message has the given service as its sender. If
+ * the message has no sender specified or has a different sender,
+ * returns #FALSE. Note that if a peer application owns multiple
+ * services, its messages will have only one of those services as the
+ * sender (usually the base service). So you can't use this
+ * function to prove the sender didn't own service Foo, you can
+ * only use it to prove that it did.
+ *
+ * @param message the message
+ * @param service the service to check (must not be #NULL)
+ *
+ * @returns #TRUE if the message has the given origin service
+ */
+dbus_bool_t
+dbus_message_has_sender (DBusMessage *message,
+ const char *service)
+{
+ const char *s;
+
+ _dbus_assert (service != NULL);
+
+ s = dbus_message_get_sender (message);
+
+ if (s && strcmp (s, service) == 0)
+ return TRUE;
+ else
+ return FALSE;
+}
+
+/**
+ * Sets a #DBusError based on the contents of the given
+ * message. The error is only set if the message
+ * is an error message, as in dbus_message_get_is_error().
+ * The name of the error is set to the name of the message,
+ * and the error message is set to the first argument
+ * if the argument exists and is a string.
+ *
+ * The return value indicates whether the error was set (the error is
+ * set if and only if the message is an error message).
+ * So you can check for an error reply and convert it to DBusError
+ * in one go.
+ *
+ * @param error the error to set
+ * @param message the message to set it from
+ * @returns #TRUE if dbus_message_get_is_error() returns #TRUE for the message
+ */
+dbus_bool_t
+dbus_set_error_from_message (DBusError *error,
+ DBusMessage *message)
+{
+ char *str;
+
+ _dbus_return_val_if_fail (message != NULL, FALSE);
+ _dbus_return_val_if_error_is_set (error, FALSE);
+
+ if (!dbus_message_get_is_error (message))
+ return FALSE;
+
+ str = NULL;
+ dbus_message_get_args (message, NULL,
+ DBUS_TYPE_STRING, &str,
+ DBUS_TYPE_INVALID);
+
+ dbus_set_error (error, dbus_message_get_name (message),
+ str ? "%s" : NULL, str);
+
+ dbus_free (str);
+
+ return TRUE;
+}
+
+/** @} */
+
+/**
+ * @addtogroup DBusMessageInternals
+ *
+ * @{
+ */
+/**
+ * @typedef DBusMessageLoader
+ *
+ * The DBusMessageLoader object encapsulates the process of converting
+ * a byte stream into a series of DBusMessage. It buffers the incoming
+ * bytes as efficiently as possible, and generates a queue of
+ * messages. DBusMessageLoader is typically used as part of a
+ * DBusTransport implementation. The DBusTransport then hands off
+ * the loaded messages to a DBusConnection, making the messages
+ * visible to the application.
+ *
+ * @todo write tests for break-loader that a) randomly delete header
+ * fields and b) set string fields to zero-length and other funky
+ * values.
+ *
+ */
+
+/* we definitely use signed ints for sizes, so don't exceed
+ * _DBUS_INT_MAX; and add 16 for paranoia, since a message
+ * over 128M is pretty nuts anyhow.
+ */
+
+/**
+ * The maximum sane message size.
+ */
+#define MAX_SANE_MESSAGE_SIZE (_DBUS_INT_MAX/16)
+
+/**
+ * Implementation details of DBusMessageLoader.
+ * All members are private.
+ */
+struct DBusMessageLoader
+{
+ int refcount; /**< Reference count. */
+
+ DBusString data; /**< Buffered data */
+
+ DBusList *messages; /**< Complete messages. */
+
+ long max_message_size; /**< Maximum size of a message */
+
+ unsigned int buffer_outstanding : 1; /**< Someone is using the buffer to read */
+
+ unsigned int corrupted : 1; /**< We got broken data, and are no longer working */
+};
+
+/**
+ * The initial buffer size of the message loader.
+ *
+ * @todo this should be based on min header size plus some average
+ * body size, or something. Or rather, the min header size only, if we
+ * want to try to read only the header, store that in a DBusMessage,
+ * then read only the body and store that, etc., depends on
+ * how we optimize _dbus_message_loader_get_buffer() and what
+ * the exact message format is.
+ */
+#define INITIAL_LOADER_DATA_LEN 32
+
+/**
+ * Creates a new message loader. Returns #NULL if memory can't
+ * be allocated.
+ *
+ * @returns new loader, or #NULL.
+ */
+DBusMessageLoader*
+_dbus_message_loader_new (void)
+{
+ DBusMessageLoader *loader;
+
+ loader = dbus_new0 (DBusMessageLoader, 1);
+ if (loader == NULL)
+ return NULL;
+
+ loader->refcount = 1;
+
+ /* Try to cap message size at something that won't *totally* hose
+ * the system if we have a couple of them.
+ */
+ loader->max_message_size = _DBUS_ONE_MEGABYTE * 32;
+
+ if (!_dbus_string_init (&loader->data))
+ {
+ dbus_free (loader);
+ return NULL;
+ }
+
+ /* preallocate the buffer for speed, ignore failure */
+ _dbus_string_set_length (&loader->data, INITIAL_LOADER_DATA_LEN);
+ _dbus_string_set_length (&loader->data, 0);
+
+ return loader;
+}
+
+/**
+ * Increments the reference count of the loader.
+ *
+ * @param loader the loader.
+ */
+void
+_dbus_message_loader_ref (DBusMessageLoader *loader)
+{
+ loader->refcount += 1;
+}
+
+/**
+ * Decrements the reference count of the loader and finalizes the
+ * loader when the count reaches zero.
+ *
+ * @param loader the loader.
+ */
+void
+_dbus_message_loader_unref (DBusMessageLoader *loader)
+{
+ loader->refcount -= 1;
+ if (loader->refcount == 0)
+ {
+ _dbus_list_foreach (&loader->messages,
+ (DBusForeachFunction) dbus_message_unref,
+ NULL);
+ _dbus_list_clear (&loader->messages);
+ _dbus_string_free (&loader->data);
+ dbus_free (loader);
+ }
+}
+
+/**
+ * Gets the buffer to use for reading data from the network. Network
+ * data is read directly into an allocated buffer, which is then used
+ * in the DBusMessage, to avoid as many extra memcpy's as possible.
+ * The buffer must always be returned immediately using
+ * _dbus_message_loader_return_buffer(), even if no bytes are
+ * successfully read.
+ *
+ * @todo this function can be a lot more clever. For example
+ * it can probably always return a buffer size to read exactly
+ * the body of the next message, thus avoiding any memory wastage
+ * or reallocs.
+ *
+ * @todo we need to enforce a max length on strings in header fields.
+ *
+ * @param loader the message loader.
+ * @param buffer the buffer
+ */
+void
+_dbus_message_loader_get_buffer (DBusMessageLoader *loader,
+ DBusString **buffer)
+{
+ _dbus_assert (!loader->buffer_outstanding);
+
+ *buffer = &loader->data;
+
+ loader->buffer_outstanding = TRUE;
+}
+
+/**
+ * The smallest header size that can occur.
+ * (It won't be valid)
+ */
+#define DBUS_MINIMUM_HEADER_SIZE 16
+
+/** Pack four characters as in "abcd" into a uint32 */
+#define FOUR_CHARS_TO_UINT32(a, b, c, d) \
+ ((((dbus_uint32_t)a) << 24) | \
+ (((dbus_uint32_t)b) << 16) | \
+ (((dbus_uint32_t)c) << 8) | \
+ ((dbus_uint32_t)d))
+
+/** DBUS_HEADER_FIELD_NAME packed into a dbus_uint32_t */
+#define DBUS_HEADER_FIELD_NAME_AS_UINT32 \
+ FOUR_CHARS_TO_UINT32 ('n', 'a', 'm', 'e')
+
+/** DBUS_HEADER_FIELD_SERVICE packed into a dbus_uint32_t */
+#define DBUS_HEADER_FIELD_SERVICE_AS_UINT32 \
+ FOUR_CHARS_TO_UINT32 ('s', 'r', 'v', 'c')
+
+/** DBUS_HEADER_FIELD_REPLY packed into a dbus_uint32_t */
+#define DBUS_HEADER_FIELD_REPLY_AS_UINT32 \
+ FOUR_CHARS_TO_UINT32 ('r', 'p', 'l', 'y')
+
+/** DBUS_HEADER_FIELD_SENDER Packed into a dbus_uint32_t */
+#define DBUS_HEADER_FIELD_SENDER_AS_UINT32 \
+ FOUR_CHARS_TO_UINT32 ('s', 'n', 'd', 'r')
+
+static dbus_bool_t
+decode_string_field (const DBusString *data,
+ HeaderField fields[FIELD_LAST],
+ int pos,
+ int type,
+ int field,
+ const char *field_name)
+{
+ DBusString tmp;
+ int string_data_pos;
+
+ if (fields[field].offset >= 0)
+ {
+ _dbus_verbose ("%s field provided twice\n",
+ field_name);
+ return FALSE;
+ }
+
+ if (type != DBUS_TYPE_STRING)
+ {
+ _dbus_verbose ("%s field has wrong type %s\n",
+ field_name, _dbus_type_to_string (type));
+ return FALSE;
+ }
+
+ /* skip padding after typecode, skip string length;
+ * we assume that the string arg has already been validated
+ * for sanity and UTF-8
+ */
+ string_data_pos = _DBUS_ALIGN_VALUE (pos, 4) + 4;
+ _dbus_assert (string_data_pos < _dbus_string_get_length (data));
+
+ _dbus_string_init_const (&tmp,
+ _dbus_string_get_const_data (data) + string_data_pos);
+
+ if (field == FIELD_NAME)
+ {
+ if (!_dbus_string_validate_name (&tmp, 0, _dbus_string_get_length (&tmp)))
+ {
+ _dbus_verbose ("%s field has invalid content \"%s\"\n",
+ field_name, _dbus_string_get_const_data (&tmp));
+ return FALSE;
+ }
+
+ if (_dbus_string_starts_with_c_str (&tmp,
+ DBUS_NAMESPACE_LOCAL_MESSAGE))
+ {
+ _dbus_verbose ("Message is in the local namespace\n");
+ return FALSE;
+ }
+ }
+ else
+ {
+ if (!_dbus_string_validate_service (&tmp, 0, _dbus_string_get_length (&tmp)))
+ {
+ _dbus_verbose ("%s field has invalid content \"%s\"\n",
+ field_name, _dbus_string_get_const_data (&tmp));
+ return FALSE;
+ }
+ }
+
+ fields[field].offset = _DBUS_ALIGN_VALUE (pos, 4);
+
+#if 0
+ _dbus_verbose ("Found field %s name at offset %d\n",
+ field_name, fields[field].offset);
+#endif
+
+ return TRUE;
+}
+
+static dbus_bool_t
+decode_header_data (const DBusString *data,
+ int header_len,
+ int byte_order,
+ HeaderField fields[FIELD_LAST],
+ int *message_padding)
+{
+ const char *field;
+ int pos, new_pos;
+ int i;
+ int type;
+
+ if (header_len < 16)
+ return FALSE;
+
+ i = 0;
+ while (i < FIELD_LAST)
+ {
+ fields[i].offset = -1;
+ ++i;
+ }
+
+ fields[FIELD_HEADER_LENGTH].offset = 4;
+ fields[FIELD_BODY_LENGTH].offset = 8;
+ fields[FIELD_CLIENT_SERIAL].offset = 12;
+
+ /* Now handle the named fields. A real named field is at least 4
+ * bytes for the name, plus a type code (1 byte) plus padding. So
+ * if we have less than 8 bytes left, it must be alignment padding,
+ * not a field. While >= 8 bytes can't be entirely alignment
+ * padding.
+ */
+ pos = 16;
+ while ((pos + 7) < header_len)
+ {
+ pos = _DBUS_ALIGN_VALUE (pos, 4);
+
+ if ((pos + 4) > header_len)
+ return FALSE;
+
+ field =_dbus_string_get_const_data_len (data, pos, 4);
+ pos += 4;
+
+ _dbus_assert (_DBUS_ALIGN_ADDRESS (field, 4) == field);
+
+ if (!_dbus_marshal_validate_type (data, pos, &type, &pos))
+ {
+ _dbus_verbose ("Failed to validate type of named header field\n");
+ return FALSE;
+ }
+
+ if (!_dbus_marshal_validate_arg (data, byte_order, 0, type, -1, pos, &new_pos))
+ {
+ _dbus_verbose ("Failed to validate argument to named header field\n");
+ return FALSE;
+ }
+
+ if (new_pos > header_len)
+ {
+ _dbus_verbose ("Named header field tries to extend beyond header length\n");
+ return FALSE;
+ }
+
+ switch (DBUS_UINT32_FROM_BE (*(int*)field))
+ {
+ case DBUS_HEADER_FIELD_SERVICE_AS_UINT32:
+ if (!decode_string_field (data, fields, pos, type,
+ FIELD_SERVICE,
+ DBUS_HEADER_FIELD_SERVICE))
+ return FALSE;
+ break;
+
+ case DBUS_HEADER_FIELD_NAME_AS_UINT32:
+ if (!decode_string_field (data, fields, pos, type,
+ FIELD_NAME,
+ DBUS_HEADER_FIELD_NAME))
+ return FALSE;
+ break;
+
+ case DBUS_HEADER_FIELD_SENDER_AS_UINT32:
+ if (!decode_string_field (data, fields, pos, type,
+ FIELD_SENDER,
+ DBUS_HEADER_FIELD_SENDER))
+ return FALSE;
+ break;
+
+ case DBUS_HEADER_FIELD_REPLY_AS_UINT32:
+ if (fields[FIELD_REPLY_SERIAL].offset >= 0)
+ {
+ _dbus_verbose ("%s field provided twice\n",
+ DBUS_HEADER_FIELD_REPLY);
+ return FALSE;
+ }
+
+ if (type != DBUS_TYPE_UINT32)
+ {
+ _dbus_verbose ("%s field has wrong type\n", DBUS_HEADER_FIELD_REPLY);
+ return FALSE;
+ }
+
+ fields[FIELD_REPLY_SERIAL].offset = _DBUS_ALIGN_VALUE (pos, 4);
+
+ _dbus_verbose ("Found reply serial at offset %d\n",
+ fields[FIELD_REPLY_SERIAL].offset);
break;
+
default:
- _dbus_verbose ("Ignoring an unknown header field: %c%c%c%c\n",
- field[0], field[1], field[2], field[3]);
+ _dbus_verbose ("Ignoring an unknown header field: %c%c%c%c at offset %d\n",
+ field[0], field[1], field[2], field[3], pos);
+ }
+
+ pos = new_pos;
+ }
+
+ if (pos < header_len)
+ {
+ /* Alignment padding, verify that it's nul */
+ _dbus_assert ((header_len - pos) < 8);
+
+ if (!_dbus_string_validate_nul (data,
+ pos, (header_len - pos)))
+ {
+ _dbus_verbose ("header alignment padding is not nul\n");
+ return FALSE;
+ }
+ }
+
+ /* Name field is mandatory */
+ if (fields[FIELD_NAME].offset < 0)
+ {
+ _dbus_verbose ("No %s field provided\n",
+ DBUS_HEADER_FIELD_NAME);
+ return FALSE;
+ }
+
+ if (message_padding)
+ *message_padding = header_len - pos;
+
+ return TRUE;
+}
+
+/**
+ * Returns a buffer obtained from _dbus_message_loader_get_buffer(),
+ * indicating to the loader how many bytes of the buffer were filled
+ * in. This function must always be called, even if no bytes were
+ * successfully read.
+ *
+ * @param loader the loader.
+ * @param buffer the buffer.
+ * @param bytes_read number of bytes that were read into the buffer.
+ */
+void
+_dbus_message_loader_return_buffer (DBusMessageLoader *loader,
+ DBusString *buffer,
+ int bytes_read)
+{
+ _dbus_assert (loader->buffer_outstanding);
+ _dbus_assert (buffer == &loader->data);
+
+ loader->buffer_outstanding = FALSE;
+}
+
+/**
+ * Converts buffered data into messages.
+ *
+ * @param loader the loader.
+ * @returns #TRUE if we had enough memory to finish.
+ */
+dbus_bool_t
+_dbus_message_loader_queue_messages (DBusMessageLoader *loader)
+{
+ if (loader->corrupted)
+ return TRUE;
+
+ while (_dbus_string_get_length (&loader->data) >= 16)
+ {
+ DBusMessage *message;
+ const char *header_data;
+ int byte_order, header_len, body_len, header_padding;
+ dbus_uint32_t header_len_unsigned, body_len_unsigned;
+
+ header_data = _dbus_string_get_const_data_len (&loader->data, 0, 16);
+
+ _dbus_assert (_DBUS_ALIGN_ADDRESS (header_data, 4) == header_data);
+
+ if (header_data[2] != DBUS_MAJOR_PROTOCOL_VERSION)
+ {
+ _dbus_verbose ("Message has protocol version %d ours is %d\n",
+ (int) header_data[2], DBUS_MAJOR_PROTOCOL_VERSION);
+ loader->corrupted = TRUE;
+ return TRUE;
+ }
+
+ byte_order = header_data[0];
+
+ if (byte_order != DBUS_LITTLE_ENDIAN &&
+ byte_order != DBUS_BIG_ENDIAN)
+ {
+ _dbus_verbose ("Message with bad byte order '%c' received\n",
+ byte_order);
+ loader->corrupted = TRUE;
+ return TRUE;
+ }
+
+ header_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 4);
+ body_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 8);
+
+ if (header_len_unsigned < 16)
+ {
+ _dbus_verbose ("Message had broken too-small header length %u\n",
+ header_len_unsigned);
+ loader->corrupted = TRUE;
+ return TRUE;
+ }
+
+ if (header_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE ||
+ body_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE)
+ {
+ _dbus_verbose ("Header or body length too large (%u %u)\n",
+ header_len_unsigned,
+ body_len_unsigned);
+ loader->corrupted = TRUE;
+ return TRUE;
+ }
+
+ /* Now that we know the values are in signed range, get
+ * rid of stupid unsigned, just causes bugs
+ */
+ header_len = header_len_unsigned;
+ body_len = body_len_unsigned;
+
+ if (_DBUS_ALIGN_VALUE (header_len, 8) != header_len_unsigned)
+ {
+
+ _dbus_verbose ("header length %d is not aligned to 8 bytes\n",
+ header_len);
+ loader->corrupted = TRUE;
+ return TRUE;
+ }
+
+ if (header_len + body_len > loader->max_message_size)
+ {
+ _dbus_verbose ("Message claimed length header = %d body = %d exceeds max message length %ld\n",
+ header_len, body_len, loader->max_message_size);
+ loader->corrupted = TRUE;
+ return TRUE;
+ }
+
+ if (_dbus_string_get_length (&loader->data) >= (header_len + body_len))
+ {
+ HeaderField fields[FIELD_LAST];
+ int i;
+ int next_arg;
+
+#if 0
+ _dbus_verbose_bytes_of_string (&loader->data, 0, header_len + body_len);
+#endif
+ if (!decode_header_data (&loader->data, header_len, byte_order,
+ fields, &header_padding))
+ {
+ _dbus_verbose ("Header was invalid\n");
+ loader->corrupted = TRUE;
+ return TRUE;
+ }
+
+ next_arg = header_len;
+ while (next_arg < (header_len + body_len))
+ {
+ int type;
+ int prev = next_arg;
+
+ if (!_dbus_marshal_validate_type (&loader->data, next_arg,
+ &type, &next_arg))
+ {
+ _dbus_verbose ("invalid typecode at offset %d\n", prev);
+ loader->corrupted = TRUE;
+ return TRUE;
+ }
+
+ if (!_dbus_marshal_validate_arg (&loader->data,
+ byte_order,
+ 0,
+ type, -1,
+ next_arg,
+ &next_arg))
+ {
+ _dbus_verbose ("invalid type data at %d, next_arg\n", next_arg);
+ loader->corrupted = TRUE;
+ return TRUE;
+ }
+
+ _dbus_assert (next_arg > prev);
+ }
+
+ if (next_arg > (header_len + body_len))
+ {
+ _dbus_verbose ("end of last arg at %d but message has len %d+%d=%d\n",
+ next_arg, header_len, body_len,
+ header_len + body_len);
+ loader->corrupted = TRUE;
+ return TRUE;
+ }
+
+ message = dbus_message_new_empty_header ();
+ if (message == NULL)
+ {
+ _dbus_verbose ("Failed to allocate empty message\n");
+ return FALSE;
+ }
+
+ message->byte_order = byte_order;
+ message->header_padding = header_padding;
- if (!_dbus_marshal_get_field_end_pos (data, byte_order, pos, &new_pos))
- goto failed;
+ /* Copy in the offsets we found */
+ i = 0;
+ while (i < FIELD_LAST)
+ {
+ message->header_fields[i] = fields[i];
+ ++i;
+ }
+
+ if (!_dbus_list_append (&loader->messages, message))
+ {
+ _dbus_verbose ("Failed to append new message to loader queue\n");
+ dbus_message_unref (message);
+ return FALSE;
+ }
+
+ _dbus_assert (_dbus_string_get_length (&message->header) == 0);
+ _dbus_assert (_dbus_string_get_length (&message->body) == 0);
+
+ _dbus_assert (_dbus_string_get_length (&loader->data) >=
+ (header_len + body_len));
+
+ if (!_dbus_string_move_len (&loader->data, 0, header_len, &message->header, 0))
+ {
+ _dbus_verbose ("Failed to move header into new message\n");
+ _dbus_list_remove_last (&loader->messages, message);
+ dbus_message_unref (message);
+ return FALSE;
+ }
+
+ if (!_dbus_string_move_len (&loader->data, 0, body_len, &message->body, 0))
+ {
+ dbus_bool_t result;
+
+ _dbus_verbose ("Failed to move body into new message\n");
+
+ /* put the header back, we'll try again later */
+ result = _dbus_string_copy_len (&message->header, 0, header_len,
+ &loader->data, 0);
+ _dbus_assert (result); /* because DBusString never reallocs smaller */
+
+ _dbus_list_remove_last (&loader->messages, message);
+ dbus_message_unref (message);
+ return FALSE;
+ }
+
+ _dbus_assert (_dbus_string_get_length (&message->header) == header_len);
+ _dbus_assert (_dbus_string_get_length (&message->body) == body_len);
+
+ /* Fill in caches */
+ /* FIXME there's no type check if the field has the wrong type */
+ message->reply_serial = get_uint_field (message,
+ FIELD_REPLY_SERIAL);
+ message->client_serial = get_uint_field (message,
+ FIELD_CLIENT_SERIAL);
+
+ _dbus_verbose ("Loaded message %p\n", message);
}
+ else
+ return TRUE;
+ }
+
+ return TRUE;
+}
+
+/**
+ * Peeks at first loaded message, returns #NULL if no messages have
+ * been queued.
+ *
+ * @param loader the loader.
+ * @returns the next message, or #NULL if none.
+ */
+DBusMessage*
+_dbus_message_loader_peek_message (DBusMessageLoader *loader)
+{
+ if (loader->messages)
+ return loader->messages->data;
+ else
+ return NULL;
+}
+
+/**
+ * Pops a loaded message (passing ownership of the message
+ * to the caller). Returns #NULL if no messages have been
+ * queued.
+ *
+ * @param loader the loader.
+ * @returns the next message, or #NULL if none.
+ */
+DBusMessage*
+_dbus_message_loader_pop_message (DBusMessageLoader *loader)
+{
+ return _dbus_list_pop_first (&loader->messages);
+}
+
+/**
+ * Pops a loaded message inside a list link (passing ownership of the
+ * message and link to the caller). Returns #NULL if no messages have
+ * been loaded.
+ *
+ * @param loader the loader.
+ * @returns the next message link, or #NULL if none.
+ */
+DBusList*
+_dbus_message_loader_pop_message_link (DBusMessageLoader *loader)
+{
+ return _dbus_list_pop_first_link (&loader->messages);
+}
+
+/**
+ * Returns a popped message link, used to undo a pop.
+ *
+ * @param loader the loader
+ * @param link the link with a message in it
+ */
+void
+_dbus_message_loader_putback_message_link (DBusMessageLoader *loader,
+ DBusList *link)
+{
+ _dbus_list_prepend_link (&loader->messages, link);
+}
+
+/**
+ * Checks whether the loader is confused due to bad data.
+ * If messages are received that are invalid, the
+ * loader gets confused and gives up permanently.
+ * This state is called "corrupted."
+ *
+ * @param loader the loader
+ * @returns #TRUE if the loader is hosed.
+ */
+dbus_bool_t
+_dbus_message_loader_get_is_corrupted (DBusMessageLoader *loader)
+{
+ return loader->corrupted;
+}
+
+/**
+ * Sets the maximum size message we allow.
+ *
+ * @param loader the loader
+ * @param size the max message size in bytes
+ */
+void
+_dbus_message_loader_set_max_message_size (DBusMessageLoader *loader,
+ long size)
+{
+ if (size > MAX_SANE_MESSAGE_SIZE)
+ {
+ _dbus_verbose ("clamping requested max message size %ld to %d\n",
+ size, MAX_SANE_MESSAGE_SIZE);
+ size = MAX_SANE_MESSAGE_SIZE;
+ }
+ loader->max_message_size = size;
+}
+
+/**
+ * Gets the maximum allowed message size in bytes.
+ *
+ * @param loader the loader
+ * @returns max size in bytes
+ */
+long
+_dbus_message_loader_get_max_message_size (DBusMessageLoader *loader)
+{
+ return loader->max_message_size;
+}
+
+/** @} */
+#ifdef DBUS_BUILD_TESTS
+#include "dbus-test.h"
+#include <stdio.h>
+
+static void
+message_iter_test (DBusMessage *message)
+{
+ DBusMessageIter iter, dict, array, array2;
+ char *str;
+ unsigned char *data;
+ dbus_int32_t *our_int_array;
+ int len;
+
+ dbus_message_iter_init (message, &iter);
+
+ /* String tests */
+ if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_STRING)
+ _dbus_assert_not_reached ("Argument type isn't string");
+
+ str = dbus_message_iter_get_string (&iter);
+ if (strcmp (str, "Test string") != 0)
+ _dbus_assert_not_reached ("Strings differ");
+ dbus_free (str);
+
+ if (!dbus_message_iter_next (&iter))
+ _dbus_assert_not_reached ("Reached end of arguments");
+
+ /* Signed integer tests */
+ if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_INT32)
+ _dbus_assert_not_reached ("Argument type isn't int32");
+
+ if (dbus_message_iter_get_int32 (&iter) != -0x12345678)
+ _dbus_assert_not_reached ("Signed integers differ");
+
+ if (!dbus_message_iter_next (&iter))
+ _dbus_assert_not_reached ("Reached end of fields");
+
+ /* Unsigned integer tests */
+ if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
+ _dbus_assert_not_reached ("Argument type isn't int32");
+
+ if (dbus_message_iter_get_uint32 (&iter) != 0xedd1e)
+ _dbus_assert_not_reached ("Unsigned integers differ");
+
+ if (!dbus_message_iter_next (&iter))
+ _dbus_assert_not_reached ("Reached end of arguments");
+
+ /* Double tests */
+ if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DOUBLE)
+ _dbus_assert_not_reached ("Argument type isn't double");
+
+ if (dbus_message_iter_get_double (&iter) != 3.14159)
+ _dbus_assert_not_reached ("Doubles differ");
+
+ if (!dbus_message_iter_next (&iter))
+ _dbus_assert_not_reached ("Reached end of arguments");
+
+ if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_ARRAY)
+ _dbus_assert_not_reached ("Argument type not an array");
+
+ if (dbus_message_iter_get_array_type (&iter) != DBUS_TYPE_DOUBLE)
+ _dbus_assert_not_reached ("Array type not double");
+
+
+ if (!dbus_message_iter_init_array_iterator (&iter, &array, NULL))
+ _dbus_assert_not_reached ("Array init failed");
+
+ if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
+ _dbus_assert_not_reached ("Argument type isn't double");
+
+ if (dbus_message_iter_get_double (&array) != 1.5)
+ _dbus_assert_not_reached ("Unsigned integers differ");
+
+ if (!dbus_message_iter_next (&array))
+ _dbus_assert_not_reached ("Reached end of arguments");
+
+ if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
+ _dbus_assert_not_reached ("Argument type isn't double");
+
+ if (dbus_message_iter_get_double (&array) != 2.5)
+ _dbus_assert_not_reached ("Unsigned integers differ");
+
+ if (dbus_message_iter_next (&array))
+ _dbus_assert_not_reached ("Didn't reach end of arguments");
+
+ if (!dbus_message_iter_next (&iter))
+ _dbus_assert_not_reached ("Reached end of arguments");
+
+
+ /* dict */
+
+ if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
+ _dbus_assert_not_reached ("not dict type");
+
+ if (!dbus_message_iter_init_dict_iterator (&iter, &dict))
+ _dbus_assert_not_reached ("dict iter failed");
+
+ str = dbus_message_iter_get_dict_key (&dict);
+ if (str == NULL || strcmp (str, "test") != 0)
+ _dbus_assert_not_reached ("wrong dict key");
+ dbus_free (str);
+
+ if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
+ _dbus_assert_not_reached ("wrong dict entry type");
+
+ if (dbus_message_iter_get_uint32 (&dict) != 0xDEADBEEF)
+ _dbus_assert_not_reached ("wrong dict entry value");
+
+ if (!dbus_message_iter_next (&dict))
+ _dbus_assert_not_reached ("reached end of dict");
+
+ /* array of array of int32 (in dict) */
+
+ str = dbus_message_iter_get_dict_key (&dict);
+ if (str == NULL || strcmp (str, "array") != 0)
+ _dbus_assert_not_reached ("wrong dict key");
+ dbus_free (str);
+
+ if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_ARRAY)
+ _dbus_assert_not_reached ("Argument type not an array");
+
+ if (dbus_message_iter_get_array_type (&dict) != DBUS_TYPE_ARRAY)
+ _dbus_assert_not_reached ("Array type not array");
+
+ if (!dbus_message_iter_init_array_iterator (&dict, &array, NULL))
+ _dbus_assert_not_reached ("Array init failed");
+
+ if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_ARRAY)
+ _dbus_assert_not_reached ("Argument type isn't array");
+
+ if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
+ _dbus_assert_not_reached ("Array type not int32");
+
+ if (!dbus_message_iter_init_array_iterator (&array, &array2, NULL))
+ _dbus_assert_not_reached ("Array init failed");
+
+ if (dbus_message_iter_get_arg_type (&array2) != DBUS_TYPE_INT32)
+ _dbus_assert_not_reached ("Argument type isn't int32");
+
+ if (dbus_message_iter_get_int32 (&array2) != 0x12345678)
+ _dbus_assert_not_reached ("Signed integers differ");
+
+ if (!dbus_message_iter_next (&array2))
+ _dbus_assert_not_reached ("Reached end of arguments");
+
+ if (dbus_message_iter_get_int32 (&array2) != 0x23456781)
+ _dbus_assert_not_reached ("Signed integers differ");
+
+ if (dbus_message_iter_next (&array2))
+ _dbus_assert_not_reached ("Didn't reached end of arguments");
+
+ if (!dbus_message_iter_next (&array))
+ _dbus_assert_not_reached ("Reached end of arguments");
+
+ if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
+ _dbus_assert_not_reached ("Array type not int32");
+
+ if (!dbus_message_iter_get_int32_array (&array,
+ &our_int_array,
+ &len))
+ _dbus_assert_not_reached ("couldn't get int32 array");
+
+ _dbus_assert (len == 3);
+ _dbus_assert (our_int_array[0] == 0x34567812 &&
+ our_int_array[1] == 0x45678123 &&
+ our_int_array[2] == 0x56781234);
+ dbus_free (our_int_array);
+
+ if (dbus_message_iter_next (&array))
+ _dbus_assert_not_reached ("Didn't reach end of array");
+
+ if (dbus_message_iter_next (&dict))
+ _dbus_assert_not_reached ("Didn't reach end of dict");
+
+ if (!dbus_message_iter_next (&iter))
+ _dbus_assert_not_reached ("Reached end of arguments");
+
+ if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_BYTE)
+ {
+ _dbus_warn ("type was: %d\n", dbus_message_iter_get_arg_type (&iter));
+ _dbus_assert_not_reached ("wrong type after dict (should be byte)");
+ }
+
+ if (dbus_message_iter_get_byte (&iter) != 0xF0)
+ _dbus_assert_not_reached ("wrong value after dict");
+
+
+ if (!dbus_message_iter_next (&iter))
+ _dbus_assert_not_reached ("Reached end of arguments");
+
+ if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NIL)
+ _dbus_assert_not_reached ("not a nil type");
+
+ if (!dbus_message_iter_next (&iter))
+ _dbus_assert_not_reached ("Reached end of arguments");
+
+ if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NAMED)
+ _dbus_assert_not_reached ("wrong type after dict");
+
+ if (!dbus_message_iter_get_named (&iter, &str, &data, &len))
+ _dbus_assert_not_reached ("failed to get named");
+
+ _dbus_assert (strcmp (str, "named")==0);
+ _dbus_assert (len == 5);
+ _dbus_assert (strcmp (data, "data")==0);
+ dbus_free (str);
+ dbus_free (data);
+
+ if (dbus_message_iter_next (&iter))
+ _dbus_assert_not_reached ("Didn't reach end of arguments");
+}
+
+
+static dbus_bool_t
+check_message_handling_type (DBusMessageIter *iter,
+ int type)
+{
+ DBusMessageIter child_iter;
+
+ switch (type)
+ {
+ case DBUS_TYPE_NIL:
+ break;
+ case DBUS_TYPE_BYTE:
+ dbus_message_iter_get_byte (iter);
+ break;
+ case DBUS_TYPE_BOOLEAN:
+ dbus_message_iter_get_boolean (iter);
+ break;
+ case DBUS_TYPE_INT32:
+ dbus_message_iter_get_int32 (iter);
+ break;
+ case DBUS_TYPE_UINT32:
+ dbus_message_iter_get_uint32 (iter);
+ break;
+ case DBUS_TYPE_INT64:
+#ifdef DBUS_HAVE_INT64
+ dbus_message_iter_get_int64 (iter);
+#endif
+ break;
+ case DBUS_TYPE_UINT64:
+#ifdef DBUS_HAVE_INT64
+ dbus_message_iter_get_uint64 (iter);
+#endif
+ break;
+ case DBUS_TYPE_DOUBLE:
+ dbus_message_iter_get_double (iter);
+ break;
+ case DBUS_TYPE_STRING:
+ {
+ char *str;
+ str = dbus_message_iter_get_string (iter);
+ if (str == NULL)
+ {
+ _dbus_warn ("NULL string in message\n");
+ return FALSE;
+ }
+ dbus_free (str);
+ }
+ break;
+ case DBUS_TYPE_NAMED:
+ {
+ char *name;
+ unsigned char *data;
+ int len;
+
+ if (!dbus_message_iter_get_named (iter, &name, &data, &len))
+ {
+ _dbus_warn ("error reading name from named type\n");
+ return FALSE;
+ }
+ dbus_free (data);
+ dbus_free (name);
+ }
+ break;
+ case DBUS_TYPE_ARRAY:
+ {
+ int array_type;
+
+ if (!dbus_message_iter_init_array_iterator (iter, &child_iter, &array_type))
+ {
+ _dbus_warn ("Failed to init array iterator\n");
+ return FALSE;
+ }
+
+ while (dbus_message_iter_has_next (&child_iter))
+ {
+ if (!check_message_handling_type (&child_iter, array_type))
+ {
+ _dbus_warn ("error in array element\n");
+ return FALSE;
+ }
+
+ if (!dbus_message_iter_next (&child_iter))
+ break;
+ }
+ }
+ break;
+ case DBUS_TYPE_DICT:
+ {
+ int entry_type;
+ char *key;
+
+ if (!dbus_message_iter_init_dict_iterator (iter, &child_iter))
+ {
+ _dbus_warn ("Failed to init dict iterator\n");
+ return FALSE;
+ }
+
+ while ((entry_type = dbus_message_iter_get_arg_type (&child_iter)) != DBUS_TYPE_INVALID)
+ {
+ key = dbus_message_iter_get_dict_key (&child_iter);
+ if (key == NULL)
+ {
+ _dbus_warn ("error reading dict key\n");
+ return FALSE;
+ }
+ dbus_free (key);
+
+ if (!check_message_handling_type (&child_iter, entry_type))
+ {
+ _dbus_warn ("error in dict value\n");
+ return FALSE;
+ }
+
+ if (!dbus_message_iter_next (&child_iter))
+ break;
+ }
+ }
+ break;
+
+ default:
+ _dbus_warn ("unknown type %d\n", type);
+ return FALSE;
+ break;
+ }
+ return TRUE;
+}
+
+
+static dbus_bool_t
+check_message_handling (DBusMessage *message)
+{
+ DBusMessageIter iter;
+ int type;
+ dbus_bool_t retval;
+ dbus_uint32_t client_serial;
+
+ retval = FALSE;
+
+ client_serial = dbus_message_get_serial (message);
+
+ /* can't use set_serial due to the assertions at the start of it */
+ set_uint_field (message, FIELD_CLIENT_SERIAL,
+ client_serial);
+
+ if (client_serial != dbus_message_get_serial (message))
+ {
+ _dbus_warn ("get/set cycle for client_serial did not succeed\n");
+ goto failed;
+ }
+
+ /* If we implement message_set_arg (message, n, value)
+ * then we would want to test it here
+ */
+
+ dbus_message_iter_init (message, &iter);
+ while ((type = dbus_message_iter_get_arg_type (&iter)) != DBUS_TYPE_INVALID)
+ {
+ if (!check_message_handling_type (&iter, type))
+ goto failed;
+
+ if (!dbus_message_iter_next (&iter))
+ break;
+ }
+
+ retval = TRUE;
+
+ failed:
+ return retval;
+}
+
+static dbus_bool_t
+check_have_valid_message (DBusMessageLoader *loader)
+{
+ DBusMessage *message;
+ dbus_bool_t retval;
+
+ message = NULL;
+ retval = FALSE;
+
+ if (!_dbus_message_loader_queue_messages (loader))
+ _dbus_assert_not_reached ("no memory to queue messages");
+
+ if (_dbus_message_loader_get_is_corrupted (loader))
+ {
+ _dbus_warn ("loader corrupted on message that was expected to be valid\n");
+ goto failed;
+ }
+
+ message = _dbus_message_loader_pop_message (loader);
+ if (message == NULL)
+ {
+ _dbus_warn ("didn't load message that was expected to be valid (message not popped)\n");
+ goto failed;
+ }
+
+ if (_dbus_string_get_length (&loader->data) > 0)
+ {
+ _dbus_warn ("had leftover bytes from expected-to-be-valid single message\n");
+ goto failed;
+ }
+
+ /* Verify that we're able to properly deal with the message.
+ * For example, this would detect improper handling of messages
+ * in nonstandard byte order.
+ */
+ if (!check_message_handling (message))
+ goto failed;
+
+ retval = TRUE;
+
+ failed:
+ if (message)
+ dbus_message_unref (message);
+
+ return retval;
+}
+
+static dbus_bool_t
+check_invalid_message (DBusMessageLoader *loader)
+{
+ dbus_bool_t retval;
+
+ retval = FALSE;
+
+ if (!_dbus_message_loader_queue_messages (loader))
+ _dbus_assert_not_reached ("no memory to queue messages");
+
+ if (!_dbus_message_loader_get_is_corrupted (loader))
+ {
+ _dbus_warn ("loader not corrupted on message that was expected to be invalid\n");
+ goto failed;
+ }
+
+ retval = TRUE;
+
+ failed:
+ return retval;
+}
+
+static dbus_bool_t
+check_incomplete_message (DBusMessageLoader *loader)
+{
+ DBusMessage *message;
+ dbus_bool_t retval;
+
+ message = NULL;
+ retval = FALSE;
+
+ if (!_dbus_message_loader_queue_messages (loader))
+ _dbus_assert_not_reached ("no memory to queue messages");
+
+ if (_dbus_message_loader_get_is_corrupted (loader))
+ {
+ _dbus_warn ("loader corrupted on message that was expected to be valid (but incomplete)\n");
+ goto failed;
+ }
+
+ message = _dbus_message_loader_pop_message (loader);
+ if (message != NULL)
+ {
+ _dbus_warn ("loaded message that was expected to be incomplete\n");
+ goto failed;
+ }
+
+ retval = TRUE;
+
+ failed:
+ if (message)
+ dbus_message_unref (message);
+ return retval;
+}
+
+static dbus_bool_t
+check_loader_results (DBusMessageLoader *loader,
+ DBusMessageValidity validity)
+{
+ if (!_dbus_message_loader_queue_messages (loader))
+ _dbus_assert_not_reached ("no memory to queue messages");
+
+ switch (validity)
+ {
+ case _DBUS_MESSAGE_VALID:
+ return check_have_valid_message (loader);
+ case _DBUS_MESSAGE_INVALID:
+ return check_invalid_message (loader);
+ case _DBUS_MESSAGE_INCOMPLETE:
+ return check_incomplete_message (loader);
+ case _DBUS_MESSAGE_UNKNOWN:
+ return TRUE;
+ }
+
+ _dbus_assert_not_reached ("bad DBusMessageValidity");
+ return FALSE;
+}
+
+
+/**
+ * Loads the message in the given message file.
+ *
+ * @param filename filename to load
+ * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
+ * @param data string to load message into
+ * @returns #TRUE if the message was loaded
+ */
+dbus_bool_t
+dbus_internal_do_not_use_load_message_file (const DBusString *filename,
+ dbus_bool_t is_raw,
+ DBusString *data)
+{
+ dbus_bool_t retval;
+
+ retval = FALSE;
+
+ if (is_raw)
+ {
+ DBusError error;
+
+ _dbus_verbose ("Loading raw %s\n", _dbus_string_get_const_data (filename));
+ dbus_error_init (&error);
+ if (!_dbus_file_get_contents (data, filename, &error))
+ {
+ _dbus_warn ("Could not load message file %s: %s\n",
+ _dbus_string_get_const_data (filename),
+ error.message);
+ dbus_error_free (&error);
+ goto failed;
+ }
+ }
+ else
+ {
+ if (!_dbus_message_data_load (data, filename))
+ {
+ _dbus_warn ("Could not load message file %s\n",
+ _dbus_string_get_const_data (filename));
+ goto failed;
+ }
+ }
+
+ retval = TRUE;
+
+ failed:
+
+ return retval;
+}
+
+/**
+ * Tries loading the message in the given message file
+ * and verifies that DBusMessageLoader can handle it.
+ *
+ * @param filename filename to load
+ * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
+ * @param expected_validity what the message has to be like to return #TRUE
+ * @returns #TRUE if the message has the expected validity
+ */
+dbus_bool_t
+dbus_internal_do_not_use_try_message_file (const DBusString *filename,
+ dbus_bool_t is_raw,
+ DBusMessageValidity expected_validity)
+{
+ DBusString data;
+ dbus_bool_t retval;
+
+ retval = FALSE;
+
+ if (!_dbus_string_init (&data))
+ _dbus_assert_not_reached ("could not allocate string\n");
+
+ if (!dbus_internal_do_not_use_load_message_file (filename, is_raw,
+ &data))
+ goto failed;
+
+ retval = dbus_internal_do_not_use_try_message_data (&data, expected_validity);
- if (new_pos > header_len)
- return FALSE;
+ failed:
+
+ if (!retval)
+ {
+ if (_dbus_string_get_length (&data) > 0)
+ _dbus_verbose_bytes_of_string (&data, 0,
+ _dbus_string_get_length (&data));
- pos = new_pos;
+ _dbus_warn ("Failed message loader test on %s\n",
+ _dbus_string_get_const_data (filename));
}
- return TRUE;
+ _dbus_string_free (&data);
- failed:
- dbus_free (*service);
- dbus_free (*name);
- return FALSE;
+ return retval;
}
/**
- * Returns a buffer obtained from _dbus_message_loader_get_buffer(),
- * indicating to the loader how many bytes of the buffer were filled
- * in. This function must always be called, even if no bytes were
- * successfully read.
+ * Tries loading the given message data.
*
- * @param loader the loader.
- * @param buffer the buffer.
- * @param bytes_read number of bytes that were read into the buffer.
+ *
+ * @param data the message data
+ * @param expected_validity what the message has to be like to return #TRUE
+ * @returns #TRUE if the message has the expected validity
*/
-void
-_dbus_message_loader_return_buffer (DBusMessageLoader *loader,
- DBusString *buffer,
- int bytes_read)
+dbus_bool_t
+dbus_internal_do_not_use_try_message_data (const DBusString *data,
+ DBusMessageValidity expected_validity)
{
- _dbus_assert (loader->buffer_outstanding);
- _dbus_assert (buffer == &loader->data);
+ DBusMessageLoader *loader;
+ dbus_bool_t retval;
+ int len;
+ int i;
- loader->buffer_outstanding = FALSE;
+ loader = NULL;
+ retval = FALSE;
- if (loader->corrupted)
- return;
+ /* Write the data one byte at a time */
+
+ loader = _dbus_message_loader_new ();
- while (_dbus_string_get_length (&loader->data) >= 16)
+ len = _dbus_string_get_length (data);
+ for (i = 0; i < len; i++)
{
- DBusMessage *message;
- const char *header_data;
- int byte_order, header_len, body_len;
-
- _dbus_string_get_const_data_len (&loader->data, &header_data, 0, 16);
+ DBusString *buffer;
- _dbus_assert (_DBUS_ALIGN_ADDRESS (header_data, 4) == header_data);
-
- byte_order = header_data[0];
+ _dbus_message_loader_get_buffer (loader, &buffer);
+ _dbus_string_append_byte (buffer,
+ _dbus_string_get_byte (data, i));
+ _dbus_message_loader_return_buffer (loader, buffer, 1);
+ }
+
+ if (!check_loader_results (loader, expected_validity))
+ goto failed;
- if (byte_order != DBUS_LITTLE_ENDIAN &&
- byte_order != DBUS_BIG_ENDIAN)
- {
- _dbus_verbose ("Message with bad byte order '%c' received\n",
- byte_order);
- loader->corrupted = TRUE;
- return;
- }
+ _dbus_message_loader_unref (loader);
+ loader = NULL;
- header_len = _dbus_unpack_int32 (byte_order, header_data + 4);
- body_len = _dbus_unpack_int32 (byte_order, header_data + 8);
+ /* Write the data all at once */
+
+ loader = _dbus_message_loader_new ();
- if (header_len + body_len > loader->max_message_size)
- {
- _dbus_verbose ("Message claimed length header = %d body = %d exceeds max message length %d\n",
- header_len, body_len, loader->max_message_size);
- loader->corrupted = TRUE;
- return;
- }
+ {
+ DBusString *buffer;
+
+ _dbus_message_loader_get_buffer (loader, &buffer);
+ _dbus_string_copy (data, 0, buffer,
+ _dbus_string_get_length (buffer));
+ _dbus_message_loader_return_buffer (loader, buffer, 1);
+ }
+
+ if (!check_loader_results (loader, expected_validity))
+ goto failed;
- if (_dbus_string_get_length (&loader->data) >= header_len + body_len)
- {
- dbus_int32_t client_serial, reply_serial;
- char *service, *name, *sender;
+ _dbus_message_loader_unref (loader);
+ loader = NULL;
- /* FIXME right now if this doesn't have enough memory, the
- * loader becomes corrupted. Instead we should just not
- * parse this message for now.
- */
- if (!decode_header_data (&loader->data, header_len, byte_order,
- &client_serial, &reply_serial, &service, &name, &sender))
- {
- loader->corrupted = TRUE;
- return;
- }
+ /* Write the data 2 bytes at a time */
+
+ loader = _dbus_message_loader_new ();
- message = dbus_message_new (service, name);
- message->reply_serial = reply_serial;
- message->client_serial = client_serial;
- dbus_message_set_sender (message, sender);
-
- dbus_free (service);
- dbus_free (name);
- dbus_free (sender);
-
- if (message == NULL)
- break; /* ugh, postpone this I guess. */
-
- if (!_dbus_list_append (&loader->messages, message))
- {
- dbus_message_unref (message);
- break;
- }
+ len = _dbus_string_get_length (data);
+ for (i = 0; i < len; i += 2)
+ {
+ DBusString *buffer;
- _dbus_assert (_dbus_string_get_length (&message->header) == 0);
- _dbus_assert (_dbus_string_get_length (&message->body) == 0);
+ _dbus_message_loader_get_buffer (loader, &buffer);
+ _dbus_string_append_byte (buffer,
+ _dbus_string_get_byte (data, i));
+ if ((i+1) < len)
+ _dbus_string_append_byte (buffer,
+ _dbus_string_get_byte (data, i+1));
+ _dbus_message_loader_return_buffer (loader, buffer, 1);
+ }
+
+ if (!check_loader_results (loader, expected_validity))
+ goto failed;
- /* Delete header part */
- _dbus_string_delete (&loader->data, 0, header_len);
+ _dbus_message_loader_unref (loader);
+ loader = NULL;
+
+ retval = TRUE;
+
+ failed:
+
+ if (loader)
+ _dbus_message_loader_unref (loader);
+
+ return retval;
+}
- if (!_dbus_string_move_len (&loader->data, 0, body_len, &message->body, 0))
- {
- dbus_bool_t result;
+static dbus_bool_t
+process_test_subdir (const DBusString *test_base_dir,
+ const char *subdir,
+ DBusMessageValidity validity,
+ DBusForeachMessageFileFunc function,
+ void *user_data)
+{
+ DBusString test_directory;
+ DBusString filename;
+ DBusDirIter *dir;
+ dbus_bool_t retval;
+ DBusError error;
- /* put the header back, we'll try again later */
- result = _dbus_string_copy_len (&message->header, 0, header_len,
- &loader->data, 0);
- _dbus_assert (result); /* because DBusString never reallocs smaller */
+ retval = FALSE;
+ dir = NULL;
+
+ if (!_dbus_string_init (&test_directory))
+ _dbus_assert_not_reached ("didn't allocate test_directory\n");
- _dbus_list_remove_last (&loader->messages, message);
- dbus_message_unref (message);
- break;
- }
+ _dbus_string_init_const (&filename, subdir);
+
+ if (!_dbus_string_copy (test_base_dir, 0,
+ &test_directory, 0))
+ _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
+
+ if (!_dbus_concat_dir_and_file (&test_directory, &filename))
+ _dbus_assert_not_reached ("couldn't allocate full path");
- _dbus_assert (_dbus_string_get_length (&message->body) == body_len);
+ _dbus_string_free (&filename);
+ if (!_dbus_string_init (&filename))
+ _dbus_assert_not_reached ("didn't allocate filename string\n");
- _dbus_verbose ("Loaded message %p\n", message);
- }
+ dbus_error_init (&error);
+ dir = _dbus_directory_open (&test_directory, &error);
+ if (dir == NULL)
+ {
+ _dbus_warn ("Could not open %s: %s\n",
+ _dbus_string_get_const_data (&test_directory),
+ error.message);
+ dbus_error_free (&error);
+ goto failed;
+ }
+
+ printf ("Testing:\n");
+
+ next:
+ while (_dbus_directory_get_next_file (dir, &filename, &error))
+ {
+ DBusString full_path;
+ dbus_bool_t is_raw;
+
+ if (!_dbus_string_init (&full_path))
+ _dbus_assert_not_reached ("couldn't init string");
+
+ if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
+ _dbus_assert_not_reached ("couldn't copy dir to full_path");
+
+ if (!_dbus_concat_dir_and_file (&full_path, &filename))
+ _dbus_assert_not_reached ("couldn't concat file to dir");
+
+ if (_dbus_string_ends_with_c_str (&filename, ".message"))
+ is_raw = FALSE;
+ else if (_dbus_string_ends_with_c_str (&filename, ".message-raw"))
+ is_raw = TRUE;
+ else
+ {
+ _dbus_verbose ("Skipping non-.message file %s\n",
+ _dbus_string_get_const_data (&filename));
+ _dbus_string_free (&full_path);
+ goto next;
+ }
+
+ printf (" %s\n",
+ _dbus_string_get_const_data (&filename));
+
+ _dbus_verbose (" expecting %s\n",
+ validity == _DBUS_MESSAGE_VALID ? "valid" :
+ (validity == _DBUS_MESSAGE_INVALID ? "invalid" :
+ (validity == _DBUS_MESSAGE_INCOMPLETE ? "incomplete" : "unknown")));
+
+ if (! (*function) (&full_path, is_raw, validity, user_data))
+ {
+ _dbus_string_free (&full_path);
+ goto failed;
+ }
else
- break;
+ _dbus_string_free (&full_path);
}
-}
-/**
- * Pops a loaded message (passing ownership of the message
- * to the caller). Returns #NULL if no messages have been
- * loaded.
- *
- * @param loader the loader.
- * @returns the next message, or #NULL if none.
- */
-DBusMessage*
-_dbus_message_loader_pop_message (DBusMessageLoader *loader)
-{
- return _dbus_list_pop_first (&loader->messages);
-}
+ if (dbus_error_is_set (&error))
+ {
+ _dbus_warn ("Could not get next file in %s: %s\n",
+ _dbus_string_get_const_data (&test_directory),
+ error.message);
+ dbus_error_free (&error);
+ goto failed;
+ }
+
+ retval = TRUE;
+
+ failed:
+ if (dir)
+ _dbus_directory_close (dir);
+ _dbus_string_free (&test_directory);
+ _dbus_string_free (&filename);
-/**
- * Checks whether the loader is confused due to bad data.
- * If messages are received that are invalid, the
- * loader gets confused and gives up permanently.
- * This state is called "corrupted."
- *
- * @param loader the loader
- * @returns #TRUE if the loader is hosed.
- */
-dbus_bool_t
-_dbus_message_loader_get_is_corrupted (DBusMessageLoader *loader)
-{
- return loader->corrupted;
+ return retval;
}
-
+
/**
- * Sets the maximum size message we allow.
+ * Runs the given function on every message file in the test suite.
+ * The function should return #FALSE on test failure or fatal error.
*
- * @param loader the loader
- * @param size the max message size in bytes
+ * @param test_data_dir root dir of the test suite data files (top_srcdir/test/data)
+ * @param func the function to run
+ * @param user_data data for function
+ * @returns #FALSE if there's a failure
*/
-void
-_dbus_message_loader_set_max_message_size (DBusMessageLoader *loader,
- long size)
+dbus_bool_t
+dbus_internal_do_not_use_foreach_message_file (const char *test_data_dir,
+ DBusForeachMessageFileFunc func,
+ void *user_data)
{
- loader->max_message_size = size;
-}
+ DBusString test_directory;
+ dbus_bool_t retval;
-/**
- * Gets the maximum allowed message size in bytes.
- *
- * @param loader the loader
- * @returns max size in bytes
- */
-long
-_dbus_message_loader_get_max_message_size (DBusMessageLoader *loader)
-{
- return loader->max_message_size;
-}
+ retval = FALSE;
+
+ _dbus_string_init_const (&test_directory, test_data_dir);
-/** @} */
-#ifdef DBUS_BUILD_TESTS
-#include "dbus-test.h"
-#include <stdio.h>
+ if (!process_test_subdir (&test_directory, "valid-messages",
+ _DBUS_MESSAGE_VALID, func, user_data))
+ goto failed;
-static void
-message_iter_test (DBusMessage *message)
-{
- DBusMessageIter *iter;
- char *str;
+ if (!process_test_subdir (&test_directory, "invalid-messages",
+ _DBUS_MESSAGE_INVALID, func, user_data))
+ goto failed;
- iter = dbus_message_get_fields_iter (message);
-
- /* String tests */
- if (dbus_message_iter_get_field_type (iter) != DBUS_TYPE_STRING)
- _dbus_assert_not_reached ("Field type isn't string");
+ if (!process_test_subdir (&test_directory, "incomplete-messages",
+ _DBUS_MESSAGE_INCOMPLETE, func, user_data))
+ goto failed;
- str = dbus_message_iter_get_string (iter);
- if (strcmp (str, "Test string") != 0)
- _dbus_assert_not_reached ("Strings differ");
- dbus_free (str);
+ retval = TRUE;
+
+ failed:
- if (!dbus_message_iter_next (iter))
- _dbus_assert_not_reached ("Reached end of fields");
+ _dbus_string_free (&test_directory);
+
+ return retval;
+}
- /* Signed integer tests */
- if (dbus_message_iter_get_field_type (iter) != DBUS_TYPE_INT32)
- _dbus_assert_not_reached ("Field type isn't int32");
+static void
+verify_test_message (DBusMessage *message)
+{
+ dbus_int32_t our_int;
+ char *our_str;
+ double our_double;
+ dbus_bool_t our_bool;
+ dbus_int32_t *our_int_array;
+ dbus_uint32_t our_uint32;
+ int our_int_array_len;
+ DBusMessageIter iter, dict;
+ DBusError error;
+#ifdef DBUS_HAVE_INT64
+ dbus_int64_t our_int64;
+#endif
+
+ dbus_message_iter_init (message, &iter);
+
+ dbus_error_init (&error);
+ if (!dbus_message_iter_get_args (&iter, &error,
+ DBUS_TYPE_INT32, &our_int,
+#ifdef DBUS_HAVE_INT64
+ DBUS_TYPE_INT64, &our_int64,
+#endif
+ DBUS_TYPE_STRING, &our_str,
+ DBUS_TYPE_DOUBLE, &our_double,
+ DBUS_TYPE_BOOLEAN, &our_bool,
+ DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32, &our_int_array, &our_int_array_len,
+ 0))
+ {
+ _dbus_verbose ("error: %s - %s\n", error.name, (error.message != NULL)?error.message: "no message");
+ _dbus_assert_not_reached ("Could not get arguments");
+ }
- if (dbus_message_iter_get_int32 (iter) != -0x12345678)
- _dbus_assert_not_reached ("Signed integers differ");
+ if (our_int != -0x12345678)
+ _dbus_assert_not_reached ("integers differ!");
- if (!dbus_message_iter_next (iter))
- _dbus_assert_not_reached ("Reached end of fields");
+#ifdef DBUS_HAVE_INT64
+ if (our_int64 != -0x123456789abcd)
+ _dbus_assert_not_reached ("64-bit integers differ!");
+#endif
- /* Unsigned integer tests */
- if (dbus_message_iter_get_field_type (iter) != DBUS_TYPE_UINT32)
- _dbus_assert_not_reached ("Field type isn't int32");
+ if (our_double != 3.14159)
+ _dbus_assert_not_reached ("doubles differ!");
- if (dbus_message_iter_get_int32 (iter) != 0xedd1e)
- _dbus_assert_not_reached ("Unsigned integers differ");
+ if (strcmp (our_str, "Test string") != 0)
+ _dbus_assert_not_reached ("strings differ!");
+ dbus_free (our_str);
- if (!dbus_message_iter_next (iter))
- _dbus_assert_not_reached ("Reached end of fields");
+ if (!our_bool)
+ _dbus_assert_not_reached ("booleans differ");
+
+ if (our_int_array_len != 4 ||
+ our_int_array[0] != 0x12345678 ||
+ our_int_array[1] != 0x23456781 ||
+ our_int_array[2] != 0x34567812 ||
+ our_int_array[3] != 0x45678123)
+ _dbus_assert_not_reached ("array differ");
+ dbus_free (our_int_array);
+
+ if (!dbus_message_iter_next (&iter))
+ _dbus_assert_not_reached ("Reached end of arguments");
+
+ if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
+ _dbus_assert_not_reached ("not dict type");
+
+ if (!dbus_message_iter_init_dict_iterator (&iter, &dict))
+ _dbus_assert_not_reached ("dict iter failed");
+
+ our_str = dbus_message_iter_get_dict_key (&dict);
+ if (our_str == NULL || strcmp (our_str, "test") != 0)
+ _dbus_assert_not_reached ("wrong dict key");
+ dbus_free (our_str);
- /* Double tests */
- if (dbus_message_iter_get_field_type (iter) != DBUS_TYPE_DOUBLE)
- _dbus_assert_not_reached ("Field type isn't double");
+ if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
+ {
+ _dbus_verbose ("dict entry type: %d\n", dbus_message_iter_get_arg_type (&dict));
+ _dbus_assert_not_reached ("wrong dict entry type");
+ }
- if (dbus_message_iter_get_double (iter) != 3.14159)
- _dbus_assert_not_reached ("Doubles differ");
+ if ((our_uint32 = dbus_message_iter_get_uint32 (&dict)) != 0xDEADBEEF)
+ {
+ _dbus_verbose ("dict entry val: %x\n", our_uint32);
+ _dbus_assert_not_reached ("wrong dict entry value");
+ }
- if (dbus_message_iter_next (iter))
- _dbus_assert_not_reached ("Didn't reach end of fields");
+ if (dbus_message_iter_next (&dict))
+ _dbus_assert_not_reached ("Didn't reach end of dict");
- dbus_message_iter_unref (iter);
+ if (!dbus_message_iter_next (&iter))
+ _dbus_assert_not_reached ("Reached end of arguments");
+
+ if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
+ _dbus_assert_not_reached ("wrong type after dict");
+
+ if (dbus_message_iter_get_uint32 (&iter) != 0xCAFEBABE)
+ _dbus_assert_not_reached ("wrong value after dict");
+
+ if (dbus_message_iter_next (&iter))
+ _dbus_assert_not_reached ("Didn't reach end of arguments");
}
/**
* @returns #TRUE on success.
*/
dbus_bool_t
-_dbus_message_test (void)
+_dbus_message_test (const char *test_data_dir)
{
DBusMessage *message;
DBusMessageLoader *loader;
+ DBusMessageIter iter, child_iter, child_iter2, child_iter3;
int i;
const char *data;
- dbus_int32_t our_int;
- char *our_str;
- double our_double;
-
+ DBusMessage *copy;
+ const char *name1;
+ const char *name2;
+ const dbus_uint32_t our_int32_array[] = { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
+
+ _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
+
/* Test the vararg functions */
- message = dbus_message_new ("org.freedesktop.DBus.Test", "testMessage");
- message->client_serial = 1;
- dbus_message_append_fields (message,
- DBUS_TYPE_INT32, -0x12345678,
- DBUS_TYPE_STRING, "Test string",
- DBUS_TYPE_DOUBLE, 3.14159,
- 0);
-
- if (dbus_message_get_fields (message,
- DBUS_TYPE_INT32, &our_int,
- DBUS_TYPE_STRING, &our_str,
- DBUS_TYPE_DOUBLE, &our_double,
- 0) != DBUS_RESULT_SUCCESS)
- _dbus_assert_not_reached ("Could not get fields");
+ message = dbus_message_new ("test.Message", "org.freedesktop.DBus.Test");
+ _dbus_message_set_serial (message, 1);
+ dbus_message_append_args (message,
+ DBUS_TYPE_INT32, -0x12345678,
+#ifdef DBUS_HAVE_INT64
+ DBUS_TYPE_INT64, -0x123456789abcd,
+#endif
+ DBUS_TYPE_STRING, "Test string",
+ DBUS_TYPE_DOUBLE, 3.14159,
+ DBUS_TYPE_BOOLEAN, TRUE,
+ DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32, our_int32_array, 4,
+ 0);
+
+ dbus_message_append_iter_init (message, &iter);
+ dbus_message_iter_append_dict (&iter, &child_iter);
+ dbus_message_iter_append_dict_key (&child_iter, "test");
+ dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
+ dbus_message_iter_append_uint32 (&iter, 0xCAFEBABE);
+
+ _dbus_verbose_bytes_of_string (&message->header, 0,
+ _dbus_string_get_length (&message->header));
+ _dbus_verbose_bytes_of_string (&message->body, 0,
+ _dbus_string_get_length (&message->body));
- if (our_int != -0x12345678)
- _dbus_assert_not_reached ("integers differ!");
+ verify_test_message (message);
- if (our_double != 3.14159)
- _dbus_assert_not_reached ("doubles differ!");
+ copy = dbus_message_copy (message);
+
+ _dbus_assert (message->client_serial == copy->client_serial);
+ _dbus_assert (message->reply_serial == copy->reply_serial);
+ _dbus_assert (message->header_padding == copy->header_padding);
+
+ _dbus_assert (_dbus_string_get_length (&message->header) ==
+ _dbus_string_get_length (©->header));
- if (strcmp (our_str, "Test string") != 0)
- _dbus_assert_not_reached ("strings differ!");
+ _dbus_assert (_dbus_string_get_length (&message->body) ==
+ _dbus_string_get_length (©->body));
- dbus_free (our_str);
+ verify_test_message (copy);
+
+ name1 = dbus_message_get_name (message);
+ name2 = dbus_message_get_name (copy);
+
+ _dbus_assert (strcmp (name1, name2) == 0);
+
dbus_message_unref (message);
+ dbus_message_unref (copy);
+
+ message = dbus_message_new ("test.Message", "org.freedesktop.DBus.Test");
+ _dbus_message_set_serial (message, 1);
+ dbus_message_set_reply_serial (message, 0x12345678);
+
+ dbus_message_append_iter_init (message, &iter);
+ dbus_message_iter_append_string (&iter, "Test string");
+ dbus_message_iter_append_int32 (&iter, -0x12345678);
+ dbus_message_iter_append_uint32 (&iter, 0xedd1e);
+ dbus_message_iter_append_double (&iter, 3.14159);
+
+ dbus_message_iter_append_array (&iter, &child_iter, DBUS_TYPE_DOUBLE);
+ dbus_message_iter_append_double (&child_iter, 1.5);
+ dbus_message_iter_append_double (&child_iter, 2.5);
+
+ /* dict */
+ dbus_message_iter_append_dict (&iter, &child_iter);
+ dbus_message_iter_append_dict_key (&child_iter, "test");
+ dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
+
+ /* array of array of int32 (in dict) */
+ dbus_message_iter_append_dict_key (&child_iter, "array");
+ dbus_message_iter_append_array (&child_iter, &child_iter2, DBUS_TYPE_ARRAY);
+ dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
+ dbus_message_iter_append_int32 (&child_iter3, 0x12345678);
+ dbus_message_iter_append_int32 (&child_iter3, 0x23456781);
+ _dbus_warn ("next call expected to fail with wrong array type\n");
+ _dbus_assert (!dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_UINT32));
+ dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
+ dbus_message_iter_append_int32 (&child_iter3, 0x34567812);
+ dbus_message_iter_append_int32 (&child_iter3, 0x45678123);
+ dbus_message_iter_append_int32 (&child_iter3, 0x56781234);
- message = dbus_message_new ("org.freedesktop.DBus.Test", "testMessage");
- message->client_serial = 1;
- message->reply_serial = 0x12345678;
+ dbus_message_iter_append_byte (&iter, 0xF0);
- dbus_message_append_string (message, "Test string");
- dbus_message_append_int32 (message, -0x12345678);
- dbus_message_append_uint32 (message, 0xedd1e);
- dbus_message_append_double (message, 3.14159);
+ dbus_message_iter_append_nil (&iter);
+ dbus_message_iter_append_named (&iter, "named",
+ "data", 5);
+
message_iter_test (message);
/* Message loader test */
loader = _dbus_message_loader_new ();
/* Write the header data one byte at a time */
- _dbus_string_get_const_data (&message->header, &data);
+ data = _dbus_string_get_const_data (&message->header);
for (i = 0; i < _dbus_string_get_length (&message->header); i++)
{
DBusString *buffer;
}
/* Write the body data one byte at a time */
- _dbus_string_get_const_data (&message->body, &data);
+ data = _dbus_string_get_const_data (&message->body);
for (i = 0; i < _dbus_string_get_length (&message->body); i++)
{
DBusString *buffer;
dbus_message_unref (message);
/* Now pop back the message */
+ if (!_dbus_message_loader_queue_messages (loader))
+ _dbus_assert_not_reached ("no memory to queue messages");
+
if (_dbus_message_loader_get_is_corrupted (loader))
_dbus_assert_not_reached ("message loader corrupted");
if (!message)
_dbus_assert_not_reached ("received a NULL message");
- if (message->reply_serial != 0x12345678)
+ if (dbus_message_get_reply_serial (message) != 0x12345678)
_dbus_assert_not_reached ("reply serial fields differ");
message_iter_test (message);
dbus_message_unref (message);
_dbus_message_loader_unref (loader);
- return TRUE;
+ /* Now load every message in test_data_dir if we have one */
+ if (test_data_dir == NULL)
+ return TRUE;
+
+ return dbus_internal_do_not_use_foreach_message_file (test_data_dir,
+ (DBusForeachMessageFileFunc)
+ dbus_internal_do_not_use_try_message_file,
+ NULL);
}
#endif /* DBUS_BUILD_TESTS */
projects / platform / upstream / dbus.git / blobdiff