gio/gdbusmessage.c

   1 /* GDBus - GLib D-Bus Library
   2  *
   3  * Copyright (C) 2008-2010 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: David Zeuthen <davidz@redhat.com>
  21  */
  22
  23 /* Uncomment to debug serializer code */
  24 /* #define DEBUG_SERIALIZER */
  25
  26 #include "config.h"
  27
  28 #include <string.h>
  29 #include <errno.h>
  30 #include <sys/types.h>
  31 #include <sys/stat.h>
  32 #ifdef HAVE_SYS_MKDEV_H
  33 #include <sys/mkdev.h>
  34 #endif
  35 #ifdef HAVE_UNISTD_H
  36 #include <unistd.h>
  37 #endif
  38
  39 #include "gdbusutils.h"
  40 #include "gdbusmessage.h"
  41 #include "gdbuserror.h"
  42 #include "gioenumtypes.h"
  43 #include "ginputstream.h"
  44 #include "gdatainputstream.h"
  45 #include "gmemoryinputstream.h"
  46 #include "goutputstream.h"
  47 #include "gdataoutputstream.h"
  48 #include "gmemoryoutputstream.h"
  49 #include "gseekable.h"
  50 #include "gioerror.h"
  51 #include "gdbusprivate.h"
  52
  53 #ifdef G_OS_UNIX
  54 #include "gunixfdlist.h"
  55 #endif
  56
  57 #include "glibintl.h"
  58
  59 /**
  60  * SECTION:gdbusmessage
  61  * @short_description: D-Bus Message
  62  * @include: gio/gio.h
  63  *
  64  * A type for representing D-Bus messages that can be sent or received
  65  * on a #GDBusConnection.
  66  */
  67
  68 typedef struct _GDBusMessageClass GDBusMessageClass;
  69
  70 /**
  71  * GDBusMessageClass:
  72  *
  73  * Class structure for #GDBusMessage.
  74  *
  75  * Since: 2.26
  76  */
  77 struct _GDBusMessageClass
  78 {
  79   /*< private >*/
  80   GObjectClass parent_class;
  81 };
  82
  83 /**
  84  * GDBusMessage:
  85  *
  86  * The #GDBusMessage structure contains only private data and should
  87  * only be accessed using the provided API.
  88  *
  89  * Since: 2.26
  90  */
  91 struct _GDBusMessage
  92 {
  93   /*< private >*/
  94   GObject parent_instance;
  95
  96   GDBusMessageType type;
  97   GDBusMessageFlags flags;
  98   gboolean locked;
  99   GDBusMessageByteOrder byte_order;
 100   guchar major_protocol_version;
 101   guint32 serial;
 102   GHashTable *headers;
 103   GVariant *body;
 104 #ifdef G_OS_UNIX
 105   GUnixFDList *fd_list;
 106 #endif
 107 };
 108
 109 enum
 110 {
 111   PROP_0,
 112   PROP_LOCKED
 113 };
 114
 115 G_DEFINE_TYPE (GDBusMessage, g_dbus_message, G_TYPE_OBJECT);
 116
 117 static void
 118 g_dbus_message_finalize (GObject *object)
 119 {
 120   GDBusMessage *message = G_DBUS_MESSAGE (object);
 121
 122   if (message->headers != NULL)
 123     g_hash_table_unref (message->headers);
 124   if (message->body != NULL)
 125     g_variant_unref (message->body);
 126 #ifdef G_OS_UNIX
 127   if (message->fd_list != NULL)
 128     g_object_unref (message->fd_list);
 129 #endif
 130
 131   if (G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize != NULL)
 132     G_OBJECT_CLASS (g_dbus_message_parent_class)->finalize (object);
 133 }
 134
 135 static void
 136 g_dbus_message_get_property (GObject    *object,
 137                              guint       prop_id,
 138                              GValue     *value,
 139                              GParamSpec *pspec)
 140 {
 141   GDBusMessage *message = G_DBUS_MESSAGE (object);
 142
 143   switch (prop_id)
 144     {
 145     case PROP_LOCKED:
 146       g_value_set_boolean (value, g_dbus_message_get_locked (message));
 147       break;
 148
 149     default:
 150       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 151       break;
 152     }
 153 }
 154
 155 static void
 156 g_dbus_message_class_init (GDBusMessageClass *klass)
 157 {
 158   GObjectClass *gobject_class;
 159
 160   gobject_class = G_OBJECT_CLASS (klass);
 161   gobject_class->finalize     = g_dbus_message_finalize;
 162   gobject_class->get_property = g_dbus_message_get_property;
 163
 164   /**
 165    * GDBusConnection:locked:
 166    *
 167    * A boolean specifying whether the message is locked.
 168    *
 169    * Since: 2.26
 170    */
 171   g_object_class_install_property (gobject_class,
 172                                    PROP_LOCKED,
 173                                    g_param_spec_boolean ("locked",
 174                                                          P_("Locked"),
 175                                                          P_("Whether the message is locked"),
 176                                                          FALSE,
 177                                                          G_PARAM_READABLE |
 178                                                          G_PARAM_STATIC_NAME |
 179                                                          G_PARAM_STATIC_BLURB |
 180                                                          G_PARAM_STATIC_NICK));
 181 }
 182
 183 static void
 184 g_dbus_message_init (GDBusMessage *message)
 185 {
 186   /* Any D-Bus implementation is supposed to handle both Big and
 187    * Little Endian encodings and the Endianness is part of the D-Bus
 188    * message - we prefer to use Big Endian (since it's Network Byte
 189    * Order and just easier to read for humans) but if the machine is
 190    * Little Endian we use that for performance reasons.
 191    */
 192 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
 193   message->byte_order = G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN;
 194 #else
 195   /* this could also be G_PDP_ENDIAN */
 196   message->byte_order = G_DBUS_MESSAGE_BYTE_ORDER_BIG_ENDIAN;
 197 #endif
 198   message->headers = g_hash_table_new_full (g_direct_hash,
 199                                             g_direct_equal,
 200                                             NULL,
 201                                             (GDestroyNotify) g_variant_unref);
 202 }
 203
 204 /**
 205  * g_dbus_message_new:
 206  *
 207  * Creates a new empty #GDBusMessage.
 208  *
 209  * Returns: A #GDBusMessage. Free with g_object_unref().
 210  *
 211  * Since: 2.26
 212  */
 213 GDBusMessage *
 214 g_dbus_message_new (void)
 215 {
 216   return g_object_new (G_TYPE_DBUS_MESSAGE, NULL);
 217 }
 218
 219 /**
 220  * g_dbus_message_new_method_call:
 221  * @name: A valid D-Bus name or %NULL.
 222  * @path: A valid object path.
 223  * @interface_: A valid D-Bus interface name or %NULL.
 224  * @method: A valid method name.
 225  *
 226  * Creates a new #GDBusMessage for a method call.
 227  *
 228  * Returns: A #GDBusMessage. Free with g_object_unref().
 229  *
 230  * Since: 2.26
 231  */
 232 GDBusMessage *
 233 g_dbus_message_new_method_call (const gchar *name,
 234                                 const gchar *path,
 235                                 const gchar *interface_,
 236                                 const gchar *method)
 237 {
 238   GDBusMessage *message;
 239
 240   g_return_val_if_fail (name == NULL || g_dbus_is_name (name), NULL);
 241   g_return_val_if_fail (g_variant_is_object_path (path), NULL);
 242   g_return_val_if_fail (g_dbus_is_member_name (method), NULL);
 243   g_return_val_if_fail (interface_ == NULL || g_dbus_is_interface_name (interface_), NULL);
 244
 245   message = g_dbus_message_new ();
 246   message->type = G_DBUS_MESSAGE_TYPE_METHOD_CALL;
 247
 248   if (name != NULL)
 249     g_dbus_message_set_destination (message, name);
 250   g_dbus_message_set_path (message, path);
 251   g_dbus_message_set_member (message, method);
 252   if (interface_ != NULL)
 253     g_dbus_message_set_interface (message, interface_);
 254
 255   return message;
 256 }
 257
 258 /**
 259  * g_dbus_message_new_signal:
 260  * @path: A valid object path.
 261  * @interface_: A valid D-Bus interface name.
 262  * @signal: A valid signal name.
 263  *
 264  * Creates a new #GDBusMessage for a signal emission.
 265  *
 266  * Returns: A #GDBusMessage. Free with g_object_unref().
 267  *
 268  * Since: 2.26
 269  */
 270 GDBusMessage *
 271 g_dbus_message_new_signal (const gchar  *path,
 272                            const gchar  *interface_,
 273                            const gchar  *signal)
 274 {
 275   GDBusMessage *message;
 276
 277   g_return_val_if_fail (g_variant_is_object_path (path), NULL);
 278   g_return_val_if_fail (g_dbus_is_member_name (signal), NULL);
 279   g_return_val_if_fail (g_dbus_is_interface_name (interface_), NULL);
 280
 281   message = g_dbus_message_new ();
 282   message->type = G_DBUS_MESSAGE_TYPE_SIGNAL;
 283   message->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
 284
 285   g_dbus_message_set_path (message, path);
 286   g_dbus_message_set_member (message, signal);
 287   g_dbus_message_set_interface (message, interface_);
 288
 289   return message;
 290 }
 291
 292
 293 /**
 294  * g_dbus_message_new_method_reply:
 295  * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
 296  * create a reply message to.
 297  *
 298  * Creates a new #GDBusMessage that is a reply to @method_call_message.
 299  *
 300  * Returns: (transfer full):  #GDBusMessage. Free with g_object_unref().
 301  *
 302  * Since: 2.26
 303  */
 304 GDBusMessage *
 305 g_dbus_message_new_method_reply (GDBusMessage *method_call_message)
 306 {
 307   GDBusMessage *message;
 308   const gchar *sender;
 309
 310   g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
 311   g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
 312   g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
 313
 314   message = g_dbus_message_new ();
 315   message->type = G_DBUS_MESSAGE_TYPE_METHOD_RETURN;
 316   message->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
 317   /* reply with same endianness */
 318   message->byte_order = method_call_message->byte_order;
 319
 320   g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
 321   sender = g_dbus_message_get_sender (method_call_message);
 322   if (sender != NULL)
 323     g_dbus_message_set_destination (message, sender);
 324
 325   return message;
 326 }
 327
 328 /**
 329  * g_dbus_message_new_method_error:
 330  * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
 331  * create a reply message to.
 332  * @error_name: A valid D-Bus error name.
 333  * @error_message_format: The D-Bus error message in a printf() format.
 334  * @...: Arguments for @error_message_format.
 335  *
 336  * Creates a new #GDBusMessage that is an error reply to @method_call_message.
 337  *
 338  * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref().
 339  *
 340  * Since: 2.26
 341  */
 342 GDBusMessage *
 343 g_dbus_message_new_method_error (GDBusMessage             *method_call_message,
 344                                  const gchar              *error_name,
 345                                  const gchar              *error_message_format,
 346                                  ...)
 347 {
 348   GDBusMessage *ret;
 349   va_list var_args;
 350
 351   va_start (var_args, error_message_format);
 352   ret = g_dbus_message_new_method_error_valist (method_call_message,
 353                                                 error_name,
 354                                                 error_message_format,
 355                                                 var_args);
 356   va_end (var_args);
 357
 358   return ret;
 359 }
 360
 361 /**
 362  * g_dbus_message_new_method_error_literal:
 363  * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
 364  * create a reply message to.
 365  * @error_name: A valid D-Bus error name.
 366  * @error_message: The D-Bus error message.
 367  *
 368  * Creates a new #GDBusMessage that is an error reply to @method_call_message.
 369  *
 370  * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref().
 371  *
 372  * Since: 2.26
 373  */
 374 GDBusMessage *
 375 g_dbus_message_new_method_error_literal (GDBusMessage  *method_call_message,
 376                                          const gchar   *error_name,
 377                                          const gchar   *error_message)
 378 {
 379   GDBusMessage *message;
 380   const gchar *sender;
 381
 382   g_return_val_if_fail (G_IS_DBUS_MESSAGE (method_call_message), NULL);
 383   g_return_val_if_fail (g_dbus_message_get_message_type (method_call_message) == G_DBUS_MESSAGE_TYPE_METHOD_CALL, NULL);
 384   g_return_val_if_fail (g_dbus_message_get_serial (method_call_message) != 0, NULL);
 385   g_return_val_if_fail (g_dbus_is_name (error_name), NULL);
 386   g_return_val_if_fail (error_message != NULL, NULL);
 387
 388   message = g_dbus_message_new ();
 389   message->type = G_DBUS_MESSAGE_TYPE_ERROR;
 390   message->flags = G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED;
 391   /* reply with same endianness */
 392   message->byte_order = method_call_message->byte_order;
 393
 394   g_dbus_message_set_reply_serial (message, g_dbus_message_get_serial (method_call_message));
 395   g_dbus_message_set_error_name (message, error_name);
 396   g_dbus_message_set_body (message, g_variant_new ("(s)", error_message));
 397
 398   sender = g_dbus_message_get_sender (method_call_message);
 399   if (sender != NULL)
 400     g_dbus_message_set_destination (message, sender);
 401
 402   return message;
 403 }
 404
 405 /**
 406  * g_dbus_message_new_method_error_valist:
 407  * @method_call_message: A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to
 408  * create a reply message to.
 409  * @error_name: A valid D-Bus error name.
 410  * @error_message_format: The D-Bus error message in a printf() format.
 411  * @var_args: Arguments for @error_message_format.
 412  *
 413  * Like g_dbus_message_new_method_error() but intended for language bindings.
 414  *
 415  * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref().
 416  *
 417  * Since: 2.26
 418  */
 419 GDBusMessage *
 420 g_dbus_message_new_method_error_valist (GDBusMessage             *method_call_message,
 421                                         const gchar              *error_name,
 422                                         const gchar              *error_message_format,
 423                                         va_list                   var_args)
 424 {
 425   GDBusMessage *ret;
 426   gchar *error_message;
 427   error_message = g_strdup_vprintf (error_message_format, var_args);
 428   ret = g_dbus_message_new_method_error_literal (method_call_message,
 429                                                  error_name,
 430                                                  error_message);
 431   g_free (error_message);
 432   return ret;
 433 }
 434
 435 /* ---------------------------------------------------------------------------------------------------- */
 436
 437 /**
 438  * g_dbus_message_get_byte_order:
 439  * @message: A #GDBusMessage.
 440  *
 441  * Gets the byte order of @message.
 442  *
 443  * Returns: The byte order.
 444  */
 445 GDBusMessageByteOrder
 446 g_dbus_message_get_byte_order (GDBusMessage *message)
 447 {
 448   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), (GDBusMessageByteOrder) 0);
 449   return message->byte_order;
 450 }
 451
 452 /**
 453  * g_dbus_message_set_byte_order:
 454  * @message: A #GDBusMessage.
 455  * @byte_order: The byte order.
 456  *
 457  * Sets the byte order of @message.
 458  */
 459 void
 460 g_dbus_message_set_byte_order (GDBusMessage          *message,
 461                                GDBusMessageByteOrder  byte_order)
 462 {
 463   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
 464
 465   if (message->locked)
 466     {
 467       g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
 468       return;
 469     }
 470
 471   message->byte_order = byte_order;
 472 }
 473
 474 /* ---------------------------------------------------------------------------------------------------- */
 475
 476 /* TODO: need GI annotations to specify that any guchar value goes for the type */
 477
 478 /**
 479  * g_dbus_message_get_message_type:
 480  * @message: A #GDBusMessage.
 481  *
 482  * Gets the type of @message.
 483  *
 484  * Returns: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
 485  *
 486  * Since: 2.26
 487  */
 488 GDBusMessageType
 489 g_dbus_message_get_message_type (GDBusMessage  *message)
 490 {
 491   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_TYPE_INVALID);
 492   return message->type;
 493 }
 494
 495 /**
 496  * g_dbus_message_set_message_type:
 497  * @message: A #GDBusMessage.
 498  * @type: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
 499  *
 500  * Sets @message to be of @type.
 501  *
 502  * Since: 2.26
 503  */
 504 void
 505 g_dbus_message_set_message_type (GDBusMessage      *message,
 506                                  GDBusMessageType   type)
 507 {
 508   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
 509   g_return_if_fail (type >=0 && type < 256);
 510
 511   if (message->locked)
 512     {
 513       g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
 514       return;
 515     }
 516
 517   message->type = type;
 518 }
 519
 520 /* ---------------------------------------------------------------------------------------------------- */
 521
 522 /* TODO: need GI annotations to specify that any guchar value goes for flags */
 523
 524 /**
 525  * g_dbus_message_get_flags:
 526  * @message: A #GDBusMessage.
 527  *
 528  * Gets the flags for @message.
 529  *
 530  * Returns: Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).
 531  *
 532  * Since: 2.26
 533  */
 534 GDBusMessageFlags
 535 g_dbus_message_get_flags (GDBusMessage  *message)
 536 {
 537   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), G_DBUS_MESSAGE_FLAGS_NONE);
 538   return message->flags;
 539 }
 540
 541 /**
 542  * g_dbus_message_set_flags:
 543  * @message: A #GDBusMessage.
 544  * @flags: Flags for @message that are set (typically values from the #GDBusMessageFlags
 545  * enumeration bitwise ORed together).
 546  *
 547  * Sets the flags to set on @message.
 548  *
 549  * Since: 2.26
 550  */
 551 void
 552 g_dbus_message_set_flags (GDBusMessage       *message,
 553                           GDBusMessageFlags   flags)
 554 {
 555   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
 556   g_return_if_fail (flags >=0 && flags < 256);
 557
 558   if (message->locked)
 559     {
 560       g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
 561       return;
 562     }
 563
 564   message->flags = flags;
 565 }
 566
 567 /* ---------------------------------------------------------------------------------------------------- */
 568
 569 /**
 570  * g_dbus_message_get_serial:
 571  * @message: A #GDBusMessage.
 572  *
 573  * Gets the serial for @message.
 574  *
 575  * Returns: A #guint32.
 576  *
 577  * Since: 2.26
 578  */
 579 guint32
 580 g_dbus_message_get_serial (GDBusMessage *message)
 581 {
 582   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
 583   return message->serial;
 584 }
 585
 586 /**
 587  * g_dbus_message_set_serial:
 588  * @message: A #GDBusMessage.
 589  * @serial: A #guint32.
 590  *
 591  * Sets the serial for @message.
 592  *
 593  * Since: 2.26
 594  */
 595 void
 596 g_dbus_message_set_serial (GDBusMessage  *message,
 597                            guint32        serial)
 598 {
 599   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
 600
 601   if (message->locked)
 602     {
 603       g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
 604       return;
 605     }
 606
 607   message->serial = serial;
 608 }
 609
 610 /* ---------------------------------------------------------------------------------------------------- */
 611
 612 /* TODO: need GI annotations to specify that any guchar value goes for header_field */
 613
 614 /**
 615  * g_dbus_message_get_header:
 616  * @message: A #GDBusMessage.
 617  * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
 618  *
 619  * Gets a header field on @message.
 620  *
 621  * Returns: A #GVariant with the value if the header was found, %NULL
 622  * otherwise. Do not free, it is owned by @message.
 623  *
 624  * Since: 2.26
 625  */
 626 GVariant *
 627 g_dbus_message_get_header (GDBusMessage             *message,
 628                            GDBusMessageHeaderField   header_field)
 629 {
 630   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
 631   g_return_val_if_fail (header_field >=0 && header_field < 256, NULL);
 632   return g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
 633 }
 634
 635 /**
 636  * g_dbus_message_set_header:
 637  * @message: A #GDBusMessage.
 638  * @header_field: A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
 639  * @value: A #GVariant to set the header field or %NULL to clear the header field.
 640  *
 641  * Sets a header field on @message.
 642  *
 643  * If @value is floating, @message assumes ownership of @value.
 644  *
 645  * Since: 2.26
 646  */
 647 void
 648 g_dbus_message_set_header (GDBusMessage             *message,
 649                            GDBusMessageHeaderField   header_field,
 650                            GVariant                 *value)
 651 {
 652   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
 653   g_return_if_fail (header_field >=0 && header_field < 256);
 654
 655   if (message->locked)
 656     {
 657       g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
 658       return;
 659     }
 660
 661   if (value == NULL)
 662     {
 663       g_hash_table_remove (message->headers, GUINT_TO_POINTER (header_field));
 664     }
 665   else
 666     {
 667       g_hash_table_insert (message->headers, GUINT_TO_POINTER (header_field), g_variant_ref_sink (value));
 668     }
 669 }
 670
 671 /**
 672  * g_dbus_message_get_header_fields:
 673  * @message: A #GDBusMessage.
 674  *
 675  * Gets an array of all header fields on @message that are set.
 676  *
 677  * Returns: An array of header fields terminated by
 678  * %G_DBUS_MESSAGE_HEADER_FIELD_INVALID.  Each element is a
 679  * #guchar. Free with g_free().
 680  *
 681  * Since: 2.26
 682  */
 683 guchar *
 684 g_dbus_message_get_header_fields (GDBusMessage  *message)
 685 {
 686   GList *keys;
 687   guchar *ret;
 688   guint num_keys;
 689   GList *l;
 690   guint n;
 691
 692   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
 693
 694   keys = g_hash_table_get_keys (message->headers);
 695   num_keys = g_list_length (keys);
 696   ret = g_new (guchar, num_keys + 1);
 697   for (l = keys, n = 0; l != NULL; l = l->next, n++)
 698     ret[n] = GPOINTER_TO_UINT (l->data);
 699   g_assert (n == num_keys);
 700   ret[n] = G_DBUS_MESSAGE_HEADER_FIELD_INVALID;
 701   g_list_free (keys);
 702
 703   return ret;
 704 }
 705
 706 /* ---------------------------------------------------------------------------------------------------- */
 707
 708 /**
 709  * g_dbus_message_get_body:
 710  * @message: A #GDBusMessage.
 711  *
 712  * Gets the body of a message.
 713  *
 714  * Returns: A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message.
 715  *
 716  * Since: 2.26
 717  */
 718 GVariant *
 719 g_dbus_message_get_body (GDBusMessage  *message)
 720 {
 721   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
 722   return message->body;
 723 }
 724
 725 /**
 726  * g_dbus_message_set_body:
 727  * @message: A #GDBusMessage.
 728  * @body: Either %NULL or a #GVariant that is a tuple.
 729  *
 730  * Sets the body @message. As a side-effect the
 731  * %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the
 732  * type string of @body (or cleared if @body is %NULL).
 733  *
 734  * If @body is floating, @message assumes ownership of @body.
 735  *
 736  * Since: 2.26
 737  */
 738 void
 739 g_dbus_message_set_body (GDBusMessage  *message,
 740                          GVariant      *body)
 741 {
 742   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
 743   g_return_if_fail ((body == NULL) || g_variant_is_of_type (body, G_VARIANT_TYPE_TUPLE));
 744
 745   if (message->locked)
 746     {
 747       g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
 748       return;
 749     }
 750
 751   if (message->body != NULL)
 752     g_variant_unref (message->body);
 753   if (body == NULL)
 754     {
 755       message->body = NULL;
 756       g_dbus_message_set_signature (message, NULL);
 757     }
 758   else
 759     {
 760       const gchar *type_string;
 761       gsize type_string_len;
 762       gchar *signature;
 763
 764       message->body = g_variant_ref_sink (body);
 765
 766       type_string = g_variant_get_type_string (body);
 767       type_string_len = strlen (type_string);
 768       g_assert (type_string_len >= 2);
 769       signature = g_strndup (type_string + 1, type_string_len - 2);
 770       g_dbus_message_set_signature (message, signature);
 771       g_free (signature);
 772     }
 773 }
 774
 775 /* ---------------------------------------------------------------------------------------------------- */
 776
 777 #ifdef G_OS_UNIX
 778 /**
 779  * g_dbus_message_get_unix_fd_list:
 780  * @message: A #GDBusMessage.
 781  *
 782  * Gets the UNIX file descriptors associated with @message, if any.
 783  *
 784  * This method is only available on UNIX.
 785  *
 786  * Returns: (transfer none):A #GUnixFDList or %NULL if no file descriptors are
 787  * associated. Do not free, this object is owned by @message.
 788  *
 789  * Since: 2.26
 790  */
 791 GUnixFDList *
 792 g_dbus_message_get_unix_fd_list (GDBusMessage  *message)
 793 {
 794   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
 795   return message->fd_list;
 796 }
 797
 798 /**
 799  * g_dbus_message_set_unix_fd_list:
 800  * @message: A #GDBusMessage.
 801  * @fd_list: (allow-none): A #GUnixFDList or %NULL.
 802  *
 803  * Sets the UNIX file descriptors associated with @message. As a
 804  * side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header
 805  * field is set to the number of fds in @fd_list (or cleared if
 806  * @fd_list is %NULL).
 807  *
 808  * This method is only available on UNIX.
 809  *
 810  * Since: 2.26
 811  */
 812 void
 813 g_dbus_message_set_unix_fd_list (GDBusMessage  *message,
 814                                  GUnixFDList   *fd_list)
 815 {
 816   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
 817   g_return_if_fail (fd_list == NULL || G_IS_UNIX_FD_LIST (fd_list));
 818
 819   if (message->locked)
 820     {
 821       g_warning ("%s: Attempted to modify a locked message", G_STRFUNC);
 822       return;
 823     }
 824
 825   if (message->fd_list != NULL)
 826     g_object_unref (message->fd_list);
 827   if (fd_list != NULL)
 828     {
 829       message->fd_list = g_object_ref (fd_list);
 830       g_dbus_message_set_num_unix_fds (message, g_unix_fd_list_get_length (fd_list));
 831     }
 832   else
 833     {
 834       message->fd_list = NULL;
 835       g_dbus_message_set_num_unix_fds (message, 0);
 836     }
 837 }
 838 #endif
 839
 840 /* ---------------------------------------------------------------------------------------------------- */
 841
 842 static gboolean
 843 validate_headers (GDBusMessage  *message,
 844                   GError       **error)
 845 {
 846   gboolean ret;
 847
 848   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
 849   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
 850
 851   ret = FALSE;
 852
 853   switch (message->type)
 854     {
 855     case G_DBUS_MESSAGE_TYPE_INVALID:
 856       g_set_error_literal (error,
 857                            G_IO_ERROR,
 858                            G_IO_ERROR_INVALID_ARGUMENT,
 859                            _("type is INVALID"));
 860       goto out;
 861       break;
 862
 863     case G_DBUS_MESSAGE_TYPE_METHOD_CALL:
 864       if (g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH) == NULL ||
 865           g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER) == NULL)
 866         {
 867           g_set_error_literal (error,
 868                                G_IO_ERROR,
 869                                G_IO_ERROR_INVALID_ARGUMENT,
 870                                _("METHOD_CALL message: PATH or MEMBER header field is missing"));
 871           goto out;
 872         }
 873       break;
 874
 875     case G_DBUS_MESSAGE_TYPE_METHOD_RETURN:
 876       if (g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL) == NULL)
 877         {
 878           g_set_error_literal (error,
 879                                G_IO_ERROR,
 880                                G_IO_ERROR_INVALID_ARGUMENT,
 881                                _("METHOD_RETURN message: REPLY_SERIAL header field is missing"));
 882           goto out;
 883         }
 884       break;
 885
 886     case G_DBUS_MESSAGE_TYPE_ERROR:
 887       if (g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME) == NULL ||
 888           g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL) == NULL)
 889         {
 890           g_set_error_literal (error,
 891                                G_IO_ERROR,
 892                                G_IO_ERROR_INVALID_ARGUMENT,
 893                                _("ERROR message: REPLY_SERIAL or ERROR_NAME header field is missing"));
 894           goto out;
 895         }
 896       break;
 897
 898     case G_DBUS_MESSAGE_TYPE_SIGNAL:
 899       if (g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH) == NULL ||
 900           g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE) == NULL ||
 901           g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER) == NULL)
 902         {
 903           g_set_error_literal (error,
 904                                G_IO_ERROR,
 905                                G_IO_ERROR_INVALID_ARGUMENT,
 906                                _("SIGNAL message: PATH, INTERFACE or MEMBER header field is missing"));
 907           goto out;
 908         }
 909       if (g_strcmp0 (g_dbus_message_get_path (message), "/org/freedesktop/DBus/Local") == 0)
 910         {
 911           g_set_error_literal (error,
 912                                G_IO_ERROR,
 913                                G_IO_ERROR_INVALID_ARGUMENT,
 914                                _("SIGNAL message: The PATH header field is using the reserved value /org/freedesktop/DBus/Local"));
 915           goto out;
 916         }
 917       if (g_strcmp0 (g_dbus_message_get_interface (message), "org.freedesktop.DBus.Local") == 0)
 918         {
 919           g_set_error_literal (error,
 920                                G_IO_ERROR,
 921                                G_IO_ERROR_INVALID_ARGUMENT,
 922                                _("SIGNAL message: The INTERFACE header field is using the reserved value org.freedesktop.DBus.Local"));
 923           goto out;
 924         }
 925       break;
 926
 927     default:
 928       /* hitherto unknown type - nothing to check */
 929       break;
 930     }
 931
 932   ret = TRUE;
 933
 934  out:
 935   g_assert (ret || (error == NULL || *error != NULL));
 936   return ret;
 937 }
 938
 939 /* ---------------------------------------------------------------------------------------------------- */
 940
 941 static gboolean
 942 ensure_input_padding (GMemoryInputStream   *mis,
 943                       gsize                 padding_size,
 944                       GError              **error)
 945 {
 946   gsize offset;
 947   gsize wanted_offset;
 948
 949   offset = g_seekable_tell (G_SEEKABLE (mis));
 950   wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
 951
 952   if (offset != wanted_offset)
 953     {
 954       return g_seekable_seek (G_SEEKABLE (mis), wanted_offset, G_SEEK_SET, NULL, error);
 955     }
 956   else
 957     {
 958       return TRUE;
 959     }
 960 }
 961
 962 static gchar *
 963 read_string (GMemoryInputStream    *mis,
 964              GDataInputStream      *dis,
 965              gsize                  len,
 966              GError               **error)
 967 {
 968   GString *s;
 969   gchar buf[256];
 970   gsize remaining;
 971   guchar nul;
 972   GError *local_error;
 973   const gchar *end_valid;
 974
 975   s = g_string_new (NULL);
 976
 977   remaining = len;
 978   while (remaining > 0)
 979     {
 980       gsize to_read;
 981       gssize num_read;
 982
 983       to_read = MIN (remaining, sizeof (buf));
 984       num_read = g_input_stream_read (G_INPUT_STREAM (mis),
 985                                       buf,
 986                                       to_read,
 987                                       NULL,
 988                                       error);
 989       if (num_read < 0)
 990         goto fail;
 991       if (num_read == 0)
 992         {
 993           /* G_GSIZE_FORMAT doesn't work with gettext, so we use %lu */
 994           g_set_error (error,
 995                        G_IO_ERROR,
 996                        G_IO_ERROR_INVALID_ARGUMENT,
 997                        _("Wanted to read %lu bytes but got EOF"),
 998                        (gulong)to_read);
 999           goto fail;
1000         }
1001
1002       remaining -= num_read;
1003       g_string_append_len (s, buf, num_read);
1004     }
1005
1006   local_error = NULL;
1007   nul = g_data_input_stream_read_byte (dis, NULL, &local_error);
1008   if (local_error != NULL)
1009     {
1010       g_propagate_error (error, local_error);
1011       goto fail;
1012     }
1013   if (!g_utf8_validate (s->str, -1, &end_valid))
1014     {
1015       gint offset;
1016       gchar *valid_str;
1017       offset = (gint) (end_valid - s->str);
1018       valid_str = g_strndup (s->str, offset);
1019       g_set_error (error,
1020                    G_IO_ERROR,
1021                    G_IO_ERROR_INVALID_ARGUMENT,
1022                    _("Expected valid UTF-8 string but found invalid bytes at byte offset %d (length of string is %d). "
1023                      "The valid UTF-8 string up until that point was `%s'"),
1024                    offset,
1025                    (gint) s->len,
1026                    valid_str);
1027       g_free (valid_str);
1028       goto fail;
1029     }
1030   if (nul != '\0')
1031     {
1032       g_set_error (error,
1033                    G_IO_ERROR,
1034                    G_IO_ERROR_INVALID_ARGUMENT,
1035                    _("Expected NUL byte after the string `%s' but found byte %d"),
1036                    s->str, nul);
1037       goto fail;
1038     }
1039
1040   return g_string_free (s, FALSE);
1041
1042  fail:
1043   g_string_free (s, TRUE);
1044   return NULL;
1045 }
1046
1047 /* if just_align==TRUE, don't read a value, just align the input stream wrt padding */
1048
1049 /* returns a non-floating GVariant! */
1050 static GVariant *
1051 parse_value_from_blob (GMemoryInputStream    *mis,
1052                        GDataInputStream      *dis,
1053                        const GVariantType    *type,
1054                        gboolean               just_align,
1055                        guint                  indent,
1056                        GError               **error)
1057 {
1058   GVariant *ret;
1059   GError *local_error;
1060   gboolean is_leaf;
1061   const gchar *type_string;
1062
1063   type_string = g_variant_type_peek_string (type);
1064
1065 #ifdef DEBUG_SERIALIZER
1066   if (!just_align)
1067     {
1068       gchar *s;
1069       s = g_variant_type_dup_string (type);
1070       g_print ("%*sReading type %s from offset 0x%04x",
1071                indent, "",
1072                s,
1073                (gint) g_seekable_tell (G_SEEKABLE (mis)));
1074       g_free (s);
1075     }
1076 #endif /* DEBUG_SERIALIZER */
1077
1078   ret = NULL;
1079
1080   is_leaf = TRUE;
1081   local_error = NULL;
1082   switch (type_string[0])
1083     {
1084     case 'b': /* G_VARIANT_TYPE_BOOLEAN */
1085       if (!ensure_input_padding (mis, 4, &local_error))
1086         goto fail;
1087       if (!just_align)
1088         {
1089           gboolean v;
1090           v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1091           if (local_error != NULL)
1092             goto fail;
1093           ret = g_variant_new_boolean (v);
1094         }
1095       break;
1096
1097     case 'y': /* G_VARIANT_TYPE_BYTE */
1098       if (!just_align)
1099         {
1100           guchar v;
1101           v = g_data_input_stream_read_byte (dis, NULL, &local_error);
1102           if (local_error != NULL)
1103             goto fail;
1104           ret = g_variant_new_byte (v);
1105         }
1106       break;
1107
1108     case 'n': /* G_VARIANT_TYPE_INT16 */
1109       if (!ensure_input_padding (mis, 2, &local_error))
1110         goto fail;
1111       if (!just_align)
1112         {
1113           gint16 v;
1114           v = g_data_input_stream_read_int16 (dis, NULL, &local_error);
1115           if (local_error != NULL)
1116             goto fail;
1117           ret = g_variant_new_int16 (v);
1118         }
1119       break;
1120
1121     case 'q': /* G_VARIANT_TYPE_UINT16 */
1122       if (!ensure_input_padding (mis, 2, &local_error))
1123         goto fail;
1124       if (!just_align)
1125         {
1126           guint16 v;
1127           v = g_data_input_stream_read_uint16 (dis, NULL, &local_error);
1128           if (local_error != NULL)
1129             goto fail;
1130           ret = g_variant_new_uint16 (v);
1131         }
1132       break;
1133
1134     case 'i': /* G_VARIANT_TYPE_INT32 */
1135       if (!ensure_input_padding (mis, 4, &local_error))
1136         goto fail;
1137       if (!just_align)
1138         {
1139           gint32 v;
1140           v = g_data_input_stream_read_int32 (dis, NULL, &local_error);
1141           if (local_error != NULL)
1142             goto fail;
1143           ret = g_variant_new_int32 (v);
1144         }
1145       break;
1146
1147     case 'u': /* G_VARIANT_TYPE_UINT32 */
1148       if (!ensure_input_padding (mis, 4, &local_error))
1149         goto fail;
1150       if (!just_align)
1151         {
1152           guint32 v;
1153           v = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1154           if (local_error != NULL)
1155             goto fail;
1156           ret = g_variant_new_uint32 (v);
1157         }
1158       break;
1159
1160     case 'x': /* G_VARIANT_TYPE_INT64 */
1161       if (!ensure_input_padding (mis, 8, &local_error))
1162         goto fail;
1163       if (!just_align)
1164         {
1165           gint64 v;
1166           v = g_data_input_stream_read_int64 (dis, NULL, &local_error);
1167           if (local_error != NULL)
1168             goto fail;
1169           ret = g_variant_new_int64 (v);
1170         }
1171       break;
1172
1173     case 't': /* G_VARIANT_TYPE_UINT64 */
1174       if (!ensure_input_padding (mis, 8, &local_error))
1175         goto fail;
1176       if (!just_align)
1177         {
1178           guint64 v;
1179           v = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
1180           if (local_error != NULL)
1181             goto fail;
1182           ret = g_variant_new_uint64 (v);
1183         }
1184       break;
1185
1186     case 'd': /* G_VARIANT_TYPE_DOUBLE */
1187       if (!ensure_input_padding (mis, 8, &local_error))
1188         goto fail;
1189       if (!just_align)
1190         {
1191           union {
1192             guint64 v_uint64;
1193             gdouble v_double;
1194           } u;
1195           G_STATIC_ASSERT (sizeof (gdouble) == sizeof (guint64));
1196           u.v_uint64 = g_data_input_stream_read_uint64 (dis, NULL, &local_error);
1197           if (local_error != NULL)
1198             goto fail;
1199           ret = g_variant_new_double (u.v_double);
1200         }
1201       break;
1202
1203     case 's': /* G_VARIANT_TYPE_STRING */
1204       if (!ensure_input_padding (mis, 4, &local_error))
1205         goto fail;
1206       if (!just_align)
1207         {
1208           guint32 len;
1209           gchar *v;
1210           len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1211           if (local_error != NULL)
1212             goto fail;
1213           v = read_string (mis, dis, (gsize) len, &local_error);
1214           if (v == NULL)
1215             goto fail;
1216           ret = g_variant_new_string (v);
1217           g_free (v);
1218         }
1219       break;
1220
1221     case 'o': /* G_VARIANT_TYPE_OBJECT_PATH */
1222       if (!ensure_input_padding (mis, 4, &local_error))
1223         goto fail;
1224       if (!just_align)
1225         {
1226           guint32 len;
1227           gchar *v;
1228           len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1229           if (local_error != NULL)
1230             goto fail;
1231           v = read_string (mis, dis, (gsize) len, &local_error);
1232           if (v == NULL)
1233             goto fail;
1234           if (!g_variant_is_object_path (v))
1235             {
1236               g_set_error (&local_error,
1237                            G_IO_ERROR,
1238                            G_IO_ERROR_INVALID_ARGUMENT,
1239                            _("Parsed value `%s' is not a valid D-Bus object path"),
1240                            v);
1241               g_free (v);
1242               goto fail;
1243             }
1244           ret = g_variant_new_object_path (v);
1245           g_free (v);
1246         }
1247       break;
1248
1249     case 'g': /* G_VARIANT_TYPE_SIGNATURE */
1250       if (!just_align)
1251         {
1252           guchar len;
1253           gchar *v;
1254           len = g_data_input_stream_read_byte (dis, NULL, &local_error);
1255           if (local_error != NULL)
1256             goto fail;
1257           v = read_string (mis, dis, (gsize) len, &local_error);
1258           if (v == NULL)
1259             goto fail;
1260           if (!g_variant_is_signature (v))
1261             {
1262               g_set_error (&local_error,
1263                            G_IO_ERROR,
1264                            G_IO_ERROR_INVALID_ARGUMENT,
1265                            _("Parsed value `%s' is not a valid D-Bus signature"),
1266                        v);
1267               g_free (v);
1268               goto fail;
1269             }
1270           ret = g_variant_new_signature (v);
1271           g_free (v);
1272         }
1273       break;
1274
1275     case 'h': /* G_VARIANT_TYPE_HANDLE */
1276       if (!ensure_input_padding (mis, 4, &local_error))
1277         goto fail;
1278       if (!just_align)
1279         {
1280           gint32 v;
1281           v = g_data_input_stream_read_int32 (dis, NULL, &local_error);
1282           if (local_error != NULL)
1283             goto fail;
1284           ret = g_variant_new_handle (v);
1285         }
1286       break;
1287
1288     case 'a': /* G_VARIANT_TYPE_ARRAY */
1289       {
1290         guint32 array_len;
1291         goffset offset;
1292         goffset target;
1293         const GVariantType *element_type;
1294         GVariantBuilder builder;
1295
1296         if (!ensure_input_padding (mis, 4, &local_error))
1297           goto fail;
1298
1299         if (just_align)
1300           {
1301             array_len = 0;
1302           }
1303         else
1304           {
1305             array_len = g_data_input_stream_read_uint32 (dis, NULL, &local_error);
1306             if (local_error != NULL)
1307               goto fail;
1308
1309             is_leaf = FALSE;
1310 #ifdef DEBUG_SERIALIZER
1311             g_print (": array spans 0x%04x bytes\n", array_len);
1312 #endif /* DEBUG_SERIALIZER */
1313
1314             if (array_len > (2<<26))
1315               {
1316                 /* G_GUINT32_FORMAT doesn't work with gettext, so use u */
1317                 g_set_error (&local_error,
1318                              G_IO_ERROR,
1319                              G_IO_ERROR_INVALID_ARGUMENT,
1320                              _("Encountered array of length %u bytes. Maximum length is 2<<26 bytes (64 MiB)."),
1321                              array_len);
1322                 goto fail;
1323               }
1324           }
1325
1326         g_variant_builder_init (&builder, type);
1327         element_type = g_variant_type_element (type);
1328
1329         if (array_len == 0)
1330           {
1331             GVariant *item;
1332             item = parse_value_from_blob (mis,
1333                                           dis,
1334                                           element_type,
1335                                           TRUE,
1336                                           indent + 2,
1337                                           &local_error);
1338             g_assert (item == NULL);
1339           }
1340         else
1341           {
1342             /* TODO: optimize array of primitive types */
1343             offset = g_seekable_tell (G_SEEKABLE (mis));
1344             target = offset + array_len;
1345             while (offset < target)
1346               {
1347                 GVariant *item;
1348                 item = parse_value_from_blob (mis,
1349                                               dis,
1350                                               element_type,
1351                                               FALSE,
1352                                               indent + 2,
1353                                               &local_error);
1354                 if (item == NULL)
1355                   {
1356                     g_variant_builder_clear (&builder);
1357                     goto fail;
1358                   }
1359                 g_variant_builder_add_value (&builder, item);
1360                 g_variant_unref (item);
1361                 offset = g_seekable_tell (G_SEEKABLE (mis));
1362               }
1363           }
1364
1365         if (!just_align)
1366           {
1367             ret = g_variant_builder_end (&builder);
1368           }
1369         else
1370           {
1371             g_variant_builder_clear (&builder);
1372           }
1373       }
1374       break;
1375
1376     default:
1377       if (g_variant_type_is_dict_entry (type))
1378         {
1379           const GVariantType *key_type;
1380           const GVariantType *value_type;
1381           GVariant *key;
1382           GVariant *value;
1383
1384           if (!ensure_input_padding (mis, 8, &local_error))
1385             goto fail;
1386
1387           is_leaf = FALSE;
1388 #ifdef DEBUG_SERIALIZER
1389           g_print ("\n");
1390 #endif /* DEBUG_SERIALIZER */
1391
1392           if (!just_align)
1393             {
1394               key_type = g_variant_type_key (type);
1395               key = parse_value_from_blob (mis,
1396                                            dis,
1397                                            key_type,
1398                                            FALSE,
1399                                            indent + 2,
1400                                            &local_error);
1401               if (key == NULL)
1402                 goto fail;
1403               value_type = g_variant_type_value (type);
1404               value = parse_value_from_blob (mis,
1405                                              dis,
1406                                              value_type,
1407                                              FALSE,
1408                                              indent + 2,
1409                                              &local_error);
1410               if (value == NULL)
1411                 {
1412                   g_variant_unref (key);
1413                   goto fail;
1414                 }
1415               ret = g_variant_new_dict_entry (key, value);
1416               g_variant_unref (key);
1417               g_variant_unref (value);
1418             }
1419         }
1420       else if (g_variant_type_is_tuple (type))
1421         {
1422           if (!ensure_input_padding (mis, 8, &local_error))
1423             goto fail;
1424
1425           is_leaf = FALSE;
1426 #ifdef DEBUG_SERIALIZER
1427           g_print ("\n");
1428 #endif /* DEBUG_SERIALIZER */
1429
1430           if (!just_align)
1431             {
1432               const GVariantType *element_type;
1433               GVariantBuilder builder;
1434
1435               g_variant_builder_init (&builder, type);
1436               element_type = g_variant_type_first (type);
1437               while (element_type != NULL)
1438                 {
1439                   GVariant *item;
1440                   item = parse_value_from_blob (mis,
1441                                                 dis,
1442                                                 element_type,
1443                                                 FALSE,
1444                                                 indent + 2,
1445                                                 &local_error);
1446                   if (item == NULL)
1447                     {
1448                       g_variant_builder_clear (&builder);
1449                       goto fail;
1450                     }
1451                   g_variant_builder_add_value (&builder, item);
1452                   g_variant_unref (item);
1453
1454                   element_type = g_variant_type_next (element_type);
1455                 }
1456               ret = g_variant_builder_end (&builder);
1457             }
1458         }
1459       else if (g_variant_type_is_variant (type))
1460         {
1461           is_leaf = FALSE;
1462 #ifdef DEBUG_SERIALIZER
1463           g_print ("\n");
1464 #endif /* DEBUG_SERIALIZER */
1465
1466           if (!just_align)
1467             {
1468               guchar siglen;
1469               gchar *sig;
1470               GVariantType *variant_type;
1471               GVariant *value;
1472
1473               siglen = g_data_input_stream_read_byte (dis, NULL, &local_error);
1474               if (local_error != NULL)
1475                 goto fail;
1476               sig = read_string (mis, dis, (gsize) siglen, &local_error);
1477               if (sig == NULL)
1478                 goto fail;
1479               if (!g_variant_is_signature (sig))
1480                 {
1481                   g_set_error (&local_error,
1482                                G_IO_ERROR,
1483                                G_IO_ERROR_INVALID_ARGUMENT,
1484                                _("Parsed value `%s' for variant is not a valid D-Bus signature"),
1485                                sig);
1486                   g_free (sig);
1487                   goto fail;
1488                 }
1489               variant_type = g_variant_type_new (sig);
1490               g_free (sig);
1491               value = parse_value_from_blob (mis,
1492                                              dis,
1493                                              variant_type,
1494                                              FALSE,
1495                                              indent + 2,
1496                                              &local_error);
1497               g_variant_type_free (variant_type);
1498               if (value == NULL)
1499                 goto fail;
1500               ret = g_variant_new_variant (value);
1501               g_variant_unref (value);
1502             }
1503         }
1504       else
1505         {
1506           gchar *s;
1507           s = g_variant_type_dup_string (type);
1508           g_set_error (&local_error,
1509                        G_IO_ERROR,
1510                        G_IO_ERROR_INVALID_ARGUMENT,
1511                        _("Error deserializing GVariant with type string `%s' from the D-Bus wire format"),
1512                        s);
1513           g_free (s);
1514           goto fail;
1515         }
1516       break;
1517     }
1518
1519   g_assert ((just_align && ret == NULL) || (!just_align && ret != NULL));
1520
1521 #ifdef DEBUG_SERIALIZER
1522   if (ret != NULL)
1523     {
1524       if (is_leaf)
1525         {
1526           gchar *s;
1527           if (g_variant_type_equal (type, G_VARIANT_TYPE_BYTE))
1528             {
1529               s = g_strdup_printf ("0x%02x '%c'", g_variant_get_byte (ret), g_variant_get_byte (ret));
1530             }
1531           else
1532             {
1533               s = g_variant_print (ret, FALSE);
1534             }
1535           g_print (": %s\n", s);
1536           g_free (s);
1537         }
1538     }
1539 #else
1540   is_leaf = is_leaf; /* To avoid -Wunused-but-set-variable */
1541 #endif /* DEBUG_SERIALIZER */
1542
1543   /* sink the reference */
1544   if (ret != NULL)
1545     {
1546       g_assert (g_variant_is_floating (ret));
1547       g_variant_ref_sink (ret);
1548     }
1549   return ret;
1550
1551  fail:
1552 #ifdef DEBUG_SERIALIZER
1553   g_print ("\n"
1554            "%*sFAILURE: %s (%s, %d)\n",
1555            indent, "",
1556            local_error->message,
1557            g_quark_to_string (local_error->domain),
1558            local_error->code);
1559 #endif /* DEBUG_SERIALIZER */
1560   g_propagate_error (error, local_error);
1561   return NULL;
1562 }
1563
1564 /* ---------------------------------------------------------------------------------------------------- */
1565
1566 /* message_header must be at least 16 bytes */
1567
1568 /**
1569  * g_dbus_message_bytes_needed:
1570  * @blob: A blob represent a binary D-Bus message.
1571  * @blob_len: The length of @blob (must be at least 16).
1572  * @error: Return location for error or %NULL.
1573  *
1574  * Utility function to calculate how many bytes are needed to
1575  * completely deserialize the D-Bus message stored at @blob.
1576  *
1577  * Returns: Number of bytes needed or -1 if @error is set (e.g. if
1578  * @blob contains invalid data or not enough data is available to
1579  * determine the size).
1580  *
1581  * Since: 2.26
1582  */
1583 gssize
1584 g_dbus_message_bytes_needed (guchar                *blob,
1585                              gsize                  blob_len,
1586                              GError               **error)
1587 {
1588   gssize ret;
1589
1590   ret = -1;
1591
1592   g_return_val_if_fail (blob != NULL, -1);
1593   g_return_val_if_fail (error == NULL || *error == NULL, -1);
1594   g_return_val_if_fail (blob_len >= 16, -1);
1595
1596   if (blob[0] == 'l')
1597     {
1598       /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1599       ret = 12 + 4 + GUINT32_FROM_LE (((guint32 *) blob)[3]);
1600       /* round up so it's a multiple of 8 */
1601       ret = 8 * ((ret + 7)/8);
1602       /* finally add the body size */
1603       ret += GUINT32_FROM_LE (((guint32 *) blob)[1]);
1604     }
1605   else if (blob[0] == 'B')
1606     {
1607       /* core header (12 bytes) + ARRAY of STRUCT of (BYTE,VARIANT) */
1608       ret = 12 + 4 + GUINT32_FROM_BE (((guint32 *) blob)[3]);
1609       /* round up so it's a multiple of 8 */
1610       ret = 8 * ((ret + 7)/8);
1611       /* finally add the body size */
1612       ret += GUINT32_FROM_BE (((guint32 *) blob)[1]);
1613     }
1614   else
1615     {
1616       g_set_error (error,
1617                    G_IO_ERROR,
1618                    G_IO_ERROR_INVALID_ARGUMENT,
1619                    "Unable to determine message blob length - given blob is malformed");
1620     }
1621
1622   if (ret > (2<<27))
1623     {
1624       g_set_error (error,
1625                    G_IO_ERROR,
1626                    G_IO_ERROR_INVALID_ARGUMENT,
1627                    "Blob indicates that message exceeds maximum message length (128MiB)");
1628       ret = -1;
1629     }
1630
1631   return ret;
1632 }
1633
1634 /* ---------------------------------------------------------------------------------------------------- */
1635
1636 /**
1637  * g_dbus_message_new_from_blob:
1638  * @blob: A blob represent a binary D-Bus message.
1639  * @blob_len: The length of @blob.
1640  * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
1641  * @error: Return location for error or %NULL.
1642  *
1643  * Creates a new #GDBusMessage from the data stored at @blob. The byte
1644  * order that the message was in can be retrieved using
1645  * g_dbus_message_get_byte_order().
1646  *
1647  * Returns: A new #GDBusMessage or %NULL if @error is set. Free with
1648  * g_object_unref().
1649  *
1650  * Since: 2.26
1651  */
1652 GDBusMessage *
1653 g_dbus_message_new_from_blob (guchar                *blob,
1654                               gsize                  blob_len,
1655                               GDBusCapabilityFlags   capabilities,
1656                               GError               **error)
1657 {
1658   gboolean ret;
1659   GMemoryInputStream *mis;
1660   GDataInputStream *dis;
1661   GDBusMessage *message;
1662   guchar endianness;
1663   guchar major_protocol_version;
1664   GDataStreamByteOrder byte_order;
1665   guint32 message_body_len;
1666   GVariant *headers;
1667   GVariant *item;
1668   GVariantIter iter;
1669   GVariant *signature;
1670
1671   /* TODO: check against @capabilities */
1672
1673   ret = FALSE;
1674
1675   g_return_val_if_fail (blob != NULL, NULL);
1676   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1677   g_return_val_if_fail (blob_len >= 12, NULL);
1678
1679   message = g_dbus_message_new ();
1680
1681   mis = G_MEMORY_INPUT_STREAM (g_memory_input_stream_new_from_data (blob, blob_len, NULL));
1682   dis = g_data_input_stream_new (G_INPUT_STREAM (mis));
1683
1684   endianness = g_data_input_stream_read_byte (dis, NULL, NULL);
1685   switch (endianness)
1686     {
1687     case 'l':
1688       byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
1689       message->byte_order = G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN;
1690       break;
1691     case 'B':
1692       byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
1693       message->byte_order = G_DBUS_MESSAGE_BYTE_ORDER_BIG_ENDIAN;
1694       break;
1695     default:
1696       g_set_error (error,
1697                    G_IO_ERROR,
1698                    G_IO_ERROR_INVALID_ARGUMENT,
1699                    _("Invalid endianness value. Expected 0x6c ('l') or 0x42 ('B') but found value 0x%02x"),
1700                    endianness);
1701       goto out;
1702     }
1703   g_data_input_stream_set_byte_order (dis, byte_order);
1704
1705   message->type = g_data_input_stream_read_byte (dis, NULL, NULL);
1706   message->flags = g_data_input_stream_read_byte (dis, NULL, NULL);
1707   major_protocol_version = g_data_input_stream_read_byte (dis, NULL, NULL);
1708   if (major_protocol_version != 1)
1709     {
1710       g_set_error (error,
1711                    G_IO_ERROR,
1712                    G_IO_ERROR_INVALID_ARGUMENT,
1713                    _("Invalid major protocol version. Expected 1 but found %d"),
1714                    major_protocol_version);
1715       goto out;
1716     }
1717   message_body_len = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1718   message->serial = g_data_input_stream_read_uint32 (dis, NULL, NULL);
1719
1720 #ifdef DEBUG_SERIALIZER
1721   g_print ("Parsing blob (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1722   {
1723     gchar *s;
1724     s = _g_dbus_hexdump ((const gchar *) blob, blob_len, 2);
1725     g_print ("%s\n", s);
1726     g_free (s);
1727   }
1728 #endif /* DEBUG_SERIALIZER */
1729
1730 #ifdef DEBUG_SERIALIZER
1731   g_print ("Parsing headers (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1732 #endif /* DEBUG_SERIALIZER */
1733   headers = parse_value_from_blob (mis,
1734                                    dis,
1735                                    G_VARIANT_TYPE ("a{yv}"),
1736                                    FALSE,
1737                                    2,
1738                                    error);
1739   if (headers == NULL)
1740     goto out;
1741   g_variant_iter_init (&iter, headers);
1742   while ((item = g_variant_iter_next_value (&iter)) != NULL)
1743     {
1744       guchar header_field;
1745       GVariant *value;
1746       g_variant_get (item,
1747                      "{yv}",
1748                      &header_field,
1749                      &value);
1750       g_dbus_message_set_header (message, header_field, value);
1751       g_variant_unref (value);
1752       g_variant_unref (item);
1753     }
1754   g_variant_unref (headers);
1755
1756   signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
1757   if (signature != NULL)
1758     {
1759       const gchar *signature_str;
1760       gsize signature_str_len;
1761
1762       signature_str = g_variant_get_string (signature, &signature_str_len);
1763
1764       /* signature but no body */
1765       if (message_body_len == 0 && signature_str_len > 0)
1766         {
1767           g_set_error (error,
1768                        G_IO_ERROR,
1769                        G_IO_ERROR_INVALID_ARGUMENT,
1770                        _("Signature header with signature `%s' found but message body is empty"),
1771                        signature_str);
1772           goto out;
1773         }
1774       else if (signature_str_len > 0)
1775         {
1776           GVariantType *variant_type;
1777           gchar *tupled_signature_str;
1778
1779           if (!g_variant_is_signature (signature_str))
1780             {
1781               g_set_error (error,
1782                            G_IO_ERROR,
1783                            G_IO_ERROR_INVALID_ARGUMENT,
1784                            _("Parsed value `%s' is not a valid D-Bus signature (for body)"),
1785                            signature_str);
1786               goto out;
1787             }
1788           tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
1789           variant_type = g_variant_type_new (tupled_signature_str);
1790           g_free (tupled_signature_str);
1791 #ifdef DEBUG_SERIALIZER
1792           g_print ("Parsing body (blob_len = 0x%04x bytes)\n", (gint) blob_len);
1793 #endif /* DEBUG_SERIALIZER */
1794           message->body = parse_value_from_blob (mis,
1795                                                  dis,
1796                                                  variant_type,
1797                                                  FALSE,
1798                                                  2,
1799                                                  error);
1800           g_variant_type_free (variant_type);
1801           if (message->body == NULL)
1802             goto out;
1803         }
1804     }
1805   else
1806     {
1807       /* no signature, this is only OK if the body is empty */
1808       if (message_body_len != 0)
1809         {
1810           /* G_GUINT32_FORMAT doesn't work with gettext, just use %u */
1811           g_set_error (error,
1812                        G_IO_ERROR,
1813                        G_IO_ERROR_INVALID_ARGUMENT,
1814                        _("No signature header in message but the message body is %u bytes"),
1815                        message_body_len);
1816           goto out;
1817         }
1818     }
1819
1820   if (!validate_headers (message, error))
1821     {
1822       g_prefix_error (error, _("Cannot deserialize message: "));
1823       goto out;
1824     }
1825
1826   ret = TRUE;
1827
1828  out:
1829   g_object_unref (dis);
1830   g_object_unref (mis);
1831
1832   if (ret)
1833     {
1834       return message;
1835     }
1836   else
1837     {
1838       if (message != NULL)
1839         g_object_unref (message);
1840       return NULL;
1841     }
1842 }
1843
1844 /* ---------------------------------------------------------------------------------------------------- */
1845
1846 static gsize
1847 ensure_output_padding (GMemoryOutputStream  *mos,
1848                        GDataOutputStream    *dos,
1849                        gsize                 padding_size)
1850 {
1851   gsize offset;
1852   gsize wanted_offset;
1853   gsize padding_needed;
1854   guint n;
1855
1856   offset = g_memory_output_stream_get_data_size (mos);
1857   wanted_offset = ((offset + padding_size - 1) / padding_size) * padding_size;
1858   padding_needed = wanted_offset - offset;
1859
1860   for (n = 0; n < padding_needed; n++)
1861     g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1862
1863   return padding_needed;
1864 }
1865
1866 /* note that value can be NULL for e.g. empty arrays - type is never NULL */
1867 static gboolean
1868 append_value_to_blob (GVariant             *value,
1869                       const GVariantType   *type,
1870                       GMemoryOutputStream  *mos,
1871                       GDataOutputStream    *dos,
1872                       gsize                *out_padding_added,
1873                       GError              **error)
1874 {
1875   gsize padding_added;
1876   const gchar *type_string;
1877
1878   type_string = g_variant_type_peek_string (type);
1879
1880   padding_added = 0;
1881
1882   switch (type_string[0])
1883     {
1884     case 'b': /* G_VARIANT_TYPE_BOOLEAN */
1885       padding_added = ensure_output_padding (mos, dos, 4);
1886       if (value != NULL)
1887         {
1888           gboolean v = g_variant_get_boolean (value);
1889           g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1890         }
1891       break;
1892
1893     case 'y': /* G_VARIANT_TYPE_BYTE */
1894       if (value != NULL)
1895         {
1896           guint8 v = g_variant_get_byte (value);
1897           g_data_output_stream_put_byte (dos, v, NULL, NULL);
1898         }
1899       break;
1900
1901     case 'n': /* G_VARIANT_TYPE_INT16 */
1902       padding_added = ensure_output_padding (mos, dos, 2);
1903       if (value != NULL)
1904         {
1905           gint16 v = g_variant_get_int16 (value);
1906           g_data_output_stream_put_int16 (dos, v, NULL, NULL);
1907         }
1908       break;
1909
1910     case 'q': /* G_VARIANT_TYPE_UINT16 */
1911       padding_added = ensure_output_padding (mos, dos, 2);
1912       if (value != NULL)
1913         {
1914           guint16 v = g_variant_get_uint16 (value);
1915           g_data_output_stream_put_uint16 (dos, v, NULL, NULL);
1916         }
1917       break;
1918
1919     case 'i': /* G_VARIANT_TYPE_INT32 */
1920       padding_added = ensure_output_padding (mos, dos, 4);
1921       if (value != NULL)
1922         {
1923           gint32 v = g_variant_get_int32 (value);
1924           g_data_output_stream_put_int32 (dos, v, NULL, NULL);
1925         }
1926       break;
1927
1928     case 'u': /* G_VARIANT_TYPE_UINT32 */
1929       padding_added = ensure_output_padding (mos, dos, 4);
1930       if (value != NULL)
1931         {
1932           guint32 v = g_variant_get_uint32 (value);
1933           g_data_output_stream_put_uint32 (dos, v, NULL, NULL);
1934         }
1935       break;
1936
1937     case 'x': /* G_VARIANT_TYPE_INT64 */
1938       padding_added = ensure_output_padding (mos, dos, 8);
1939       if (value != NULL)
1940         {
1941           gint64 v = g_variant_get_int64 (value);
1942           g_data_output_stream_put_int64 (dos, v, NULL, NULL);
1943         }
1944       break;
1945
1946     case 't': /* G_VARIANT_TYPE_UINT64 */
1947       padding_added = ensure_output_padding (mos, dos, 8);
1948       if (value != NULL)
1949         {
1950           guint64 v = g_variant_get_uint64 (value);
1951           g_data_output_stream_put_uint64 (dos, v, NULL, NULL);
1952         }
1953       break;
1954
1955     case 'd': /* G_VARIANT_TYPE_DOUBLE */
1956       padding_added = ensure_output_padding (mos, dos, 8);
1957       if (value != NULL)
1958         {
1959           union {
1960             guint64 v_uint64;
1961             gdouble v_double;
1962           } u;
1963           G_STATIC_ASSERT (sizeof (gdouble) == sizeof (guint64));
1964           u.v_double = g_variant_get_double (value);
1965           g_data_output_stream_put_uint64 (dos, u.v_uint64, NULL, NULL);
1966         }
1967       break;
1968
1969     case 's': /* G_VARIANT_TYPE_STRING */
1970       padding_added = ensure_output_padding (mos, dos, 4);
1971       if (value != NULL)
1972         {
1973           gsize len;
1974           const gchar *v;
1975           const gchar *end;
1976           v = g_variant_get_string (value, &len);
1977           g_assert (g_utf8_validate (v, -1, &end) && (end == v + len));
1978           g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1979           g_data_output_stream_put_string (dos, v, NULL, NULL);
1980           g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1981         }
1982       break;
1983
1984     case 'o': /* G_VARIANT_TYPE_OBJECT_PATH */
1985       padding_added = ensure_output_padding (mos, dos, 4);
1986       if (value != NULL)
1987         {
1988           gsize len;
1989           const gchar *v = g_variant_get_string (value, &len);
1990           g_assert (g_variant_is_object_path (v));
1991           g_data_output_stream_put_uint32 (dos, len, NULL, NULL);
1992           g_data_output_stream_put_string (dos, v, NULL, NULL);
1993           g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
1994         }
1995       break;
1996
1997     case 'g': /* G_VARIANT_TYPE_SIGNATURE */
1998       if (value != NULL)
1999         {
2000           gsize len;
2001           const gchar *v = g_variant_get_string (value, &len);
2002           g_assert (g_variant_is_signature (v));
2003           g_data_output_stream_put_byte (dos, len, NULL, NULL);
2004           g_data_output_stream_put_string (dos, v, NULL, NULL);
2005           g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
2006         }
2007       break;
2008
2009     case 'h': /* G_VARIANT_TYPE_HANDLE */
2010       padding_added = ensure_output_padding (mos, dos, 4);
2011       if (value != NULL)
2012         {
2013           gint32 v = g_variant_get_handle (value);
2014           g_data_output_stream_put_int32 (dos, v, NULL, NULL);
2015         }
2016       break;
2017
2018     case 'a': /* G_VARIANT_TYPE_ARRAY */
2019       {
2020         GVariant *item;
2021         GVariantIter iter;
2022         goffset array_len_offset;
2023         goffset array_payload_begin_offset;
2024         goffset cur_offset;
2025         gsize array_len;
2026
2027         padding_added = ensure_output_padding (mos, dos, 4);
2028         if (value != NULL)
2029           {
2030             /* array length - will be filled in later */
2031             array_len_offset = g_memory_output_stream_get_data_size (mos);
2032             g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
2033
2034             /* From the D-Bus spec:
2035              *
2036              *   "A UINT32 giving the length of the array data in bytes,
2037              *    followed by alignment padding to the alignment boundary of
2038              *    the array element type, followed by each array element. The
2039              *    array length is from the end of the alignment padding to
2040              *    the end of the last element, i.e. it does not include the
2041              *    padding after the length, or any padding after the last
2042              *    element."
2043              *
2044              * Thus, we need to count how much padding the first element
2045              * contributes and subtract that from the array length.
2046              */
2047             array_payload_begin_offset = g_memory_output_stream_get_data_size (mos);
2048
2049             if (g_variant_n_children (value) == 0)
2050               {
2051                 gsize padding_added_for_item;
2052                 if (!append_value_to_blob (NULL,
2053                                            g_variant_type_element (type),
2054                                            mos,
2055                                            dos,
2056                                            &padding_added_for_item,
2057                                            error))
2058                   goto fail;
2059                 array_payload_begin_offset += padding_added_for_item;
2060               }
2061             else
2062               {
2063                 guint n;
2064                 n = 0;
2065                 g_variant_iter_init (&iter, value);
2066                 while ((item = g_variant_iter_next_value (&iter)) != NULL)
2067                   {
2068                     gsize padding_added_for_item;
2069                     if (!append_value_to_blob (item,
2070                                                g_variant_get_type (item),
2071                                                mos,
2072                                                dos,
2073                                                &padding_added_for_item,
2074                                                error))
2075                       {
2076                         g_variant_unref (item);
2077                         goto fail;
2078                       }
2079                     g_variant_unref (item);
2080                     if (n == 0)
2081                       {
2082                         array_payload_begin_offset += padding_added_for_item;
2083                       }
2084                     n++;
2085                   }
2086               }
2087
2088             cur_offset = g_memory_output_stream_get_data_size (mos);
2089             array_len = cur_offset - array_payload_begin_offset;
2090             if (!g_seekable_seek (G_SEEKABLE (mos), array_len_offset, G_SEEK_SET, NULL, error))
2091               goto fail;
2092
2093             g_data_output_stream_put_uint32 (dos, array_len, NULL, NULL);
2094             if (!g_seekable_seek (G_SEEKABLE (mos), cur_offset, G_SEEK_SET, NULL, error))
2095               goto fail;
2096           }
2097       }
2098       break;
2099
2100     default:
2101       if (g_variant_type_is_dict_entry (type) || g_variant_type_is_tuple (type))
2102         {
2103           padding_added = ensure_output_padding (mos, dos, 8);
2104           if (value != NULL)
2105             {
2106               GVariant *item;
2107               GVariantIter iter;
2108               g_variant_iter_init (&iter, value);
2109               while ((item = g_variant_iter_next_value (&iter)) != NULL)
2110                 {
2111                   if (!append_value_to_blob (item,
2112                                              g_variant_get_type (item),
2113                                              mos,
2114                                              dos,
2115                                              NULL,
2116                                              error))
2117                     {
2118                       g_variant_unref (item);
2119                       goto fail;
2120                     }
2121                   g_variant_unref (item);
2122                 }
2123             }
2124         }
2125       else if (g_variant_type_is_variant (type))
2126         {
2127           if (value != NULL)
2128             {
2129               GVariant *child;
2130               const gchar *signature;
2131               child = g_variant_get_child_value (value, 0);
2132               signature = g_variant_get_type_string (child);
2133               g_data_output_stream_put_byte (dos, strlen (signature), NULL, NULL);
2134               g_data_output_stream_put_string (dos, signature, NULL, NULL);
2135               g_data_output_stream_put_byte (dos, '\0', NULL, NULL);
2136               if (!append_value_to_blob (child,
2137                                          g_variant_get_type (child),
2138                                          mos,
2139                                          dos,
2140                                          NULL,
2141                                          error))
2142                 {
2143                   g_variant_unref (child);
2144                   goto fail;
2145                 }
2146               g_variant_unref (child);
2147             }
2148         }
2149       else
2150         {
2151           g_set_error (error,
2152                        G_IO_ERROR,
2153                        G_IO_ERROR_INVALID_ARGUMENT,
2154                        _("Error serializing GVariant with type string `%s' to the D-Bus wire format"),
2155                        g_variant_get_type_string (value));
2156           goto fail;
2157         }
2158       break;
2159     }
2160
2161   if (out_padding_added != NULL)
2162     *out_padding_added = padding_added;
2163
2164   return TRUE;
2165
2166  fail:
2167   return FALSE;
2168 }
2169
2170 static gboolean
2171 append_body_to_blob (GVariant             *value,
2172                      GMemoryOutputStream  *mos,
2173                      GDataOutputStream    *dos,
2174                      GError              **error)
2175 {
2176   GVariant *item;
2177   GVariantIter iter;
2178
2179   if (!g_variant_is_of_type (value, G_VARIANT_TYPE_TUPLE))
2180     {
2181       g_set_error (error,
2182                    G_IO_ERROR,
2183                    G_IO_ERROR_INVALID_ARGUMENT,
2184                    "Expected a tuple for the body of the GDBusMessage.");
2185       goto fail;
2186     }
2187
2188   g_variant_iter_init (&iter, value);
2189   while ((item = g_variant_iter_next_value (&iter)) != NULL)
2190     {
2191       if (!append_value_to_blob (item,
2192                                  g_variant_get_type (item),
2193                                  mos,
2194                                  dos,
2195                                  NULL,
2196                                  error))
2197         {
2198           g_variant_unref (item);
2199           goto fail;
2200         }
2201       g_variant_unref (item);
2202     }
2203   return TRUE;
2204
2205  fail:
2206   return FALSE;
2207 }
2208
2209 /* ---------------------------------------------------------------------------------------------------- */
2210
2211 /**
2212  * g_dbus_message_to_blob:
2213  * @message: A #GDBusMessage.
2214  * @out_size: Return location for size of generated blob.
2215  * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
2216  * @error: Return location for error.
2217  *
2218  * Serializes @message to a blob. The byte order returned by
2219  * g_dbus_message_get_byte_order() will be used.
2220  *
2221  * Returns: A pointer to a valid binary D-Bus message of @out_size bytes
2222  * generated by @message or %NULL if @error is set. Free with g_free().
2223  *
2224  * Since: 2.26
2225  */
2226 guchar *
2227 g_dbus_message_to_blob (GDBusMessage          *message,
2228                         gsize                 *out_size,
2229                         GDBusCapabilityFlags   capabilities,
2230                         GError               **error)
2231 {
2232   GMemoryOutputStream *mos;
2233   GDataOutputStream *dos;
2234   guchar *ret;
2235   gsize size;
2236   GDataStreamByteOrder byte_order;
2237   goffset body_len_offset;
2238   goffset body_start_offset;
2239   gsize body_size;
2240   GVariant *header_fields;
2241   GVariantBuilder builder;
2242   GHashTableIter hash_iter;
2243   gpointer key;
2244   GVariant *header_value;
2245   GVariant *signature;
2246   const gchar *signature_str;
2247   gint num_fds_in_message;
2248   gint num_fds_according_to_header;
2249
2250   /* TODO: check against @capabilities */
2251
2252   ret = NULL;
2253
2254   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2255   g_return_val_if_fail (out_size != NULL, NULL);
2256   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2257
2258   mos = G_MEMORY_OUTPUT_STREAM (g_memory_output_stream_new (NULL, 0, g_realloc, g_free));
2259   dos = g_data_output_stream_new (G_OUTPUT_STREAM (mos));
2260
2261   byte_order = G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN;
2262   switch (message->byte_order)
2263     {
2264     case G_DBUS_MESSAGE_BYTE_ORDER_BIG_ENDIAN:
2265       byte_order = G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN;
2266       break;
2267     case G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN:
2268       byte_order = G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN;
2269       break;
2270     }
2271   g_data_output_stream_set_byte_order (dos, byte_order);
2272
2273   /* Core header */
2274   g_data_output_stream_put_byte (dos, (guchar) message->byte_order, NULL, NULL);
2275   g_data_output_stream_put_byte (dos, message->type, NULL, NULL);
2276   g_data_output_stream_put_byte (dos, message->flags, NULL, NULL);
2277   g_data_output_stream_put_byte (dos, 1, NULL, NULL); /* major protocol version */
2278   body_len_offset = g_memory_output_stream_get_data_size (mos);
2279   /* body length - will be filled in later */
2280   g_data_output_stream_put_uint32 (dos, 0xF00DFACE, NULL, NULL);
2281   g_data_output_stream_put_uint32 (dos, message->serial, NULL, NULL);
2282
2283   num_fds_in_message = 0;
2284 #ifdef G_OS_UNIX
2285   if (message->fd_list != NULL)
2286     num_fds_in_message = g_unix_fd_list_get_length (message->fd_list);
2287 #endif
2288   num_fds_according_to_header = g_dbus_message_get_num_unix_fds (message);
2289   if (num_fds_in_message != num_fds_according_to_header)
2290     {
2291       g_set_error (error,
2292                    G_IO_ERROR,
2293                    G_IO_ERROR_INVALID_ARGUMENT,
2294                    _("Message has %d fds but the header field indicates %d fds"),
2295                    num_fds_in_message,
2296                    num_fds_according_to_header);
2297       goto out;
2298     }
2299
2300   if (!validate_headers (message, error))
2301     {
2302       g_prefix_error (error, _("Cannot serialize message: "));
2303       goto out;
2304     }
2305
2306   g_variant_builder_init (&builder, G_VARIANT_TYPE ("a{yv}"));
2307   g_hash_table_iter_init (&hash_iter, message->headers);
2308   while (g_hash_table_iter_next (&hash_iter, &key, (gpointer) &header_value))
2309     {
2310       g_variant_builder_add (&builder,
2311                              "{yv}",
2312                              (guchar) GPOINTER_TO_UINT (key),
2313                              header_value);
2314     }
2315   header_fields = g_variant_builder_end (&builder);
2316
2317   if (!append_value_to_blob (header_fields,
2318                              g_variant_get_type (header_fields),
2319                              mos, dos,
2320                              NULL,
2321                              error))
2322     {
2323       g_variant_unref (header_fields);
2324       goto out;
2325     }
2326   g_variant_unref (header_fields);
2327
2328   /* header size must be a multiple of 8 */
2329   ensure_output_padding (mos, dos, 8);
2330
2331   body_start_offset = g_memory_output_stream_get_data_size (mos);
2332
2333   signature = g_dbus_message_get_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2334   signature_str = NULL;
2335   if (signature != NULL)
2336       signature_str = g_variant_get_string (signature, NULL);
2337   if (message->body != NULL)
2338     {
2339       gchar *tupled_signature_str;
2340       tupled_signature_str = g_strdup_printf ("(%s)", signature_str);
2341       if (signature == NULL)
2342         {
2343           g_set_error (error,
2344                        G_IO_ERROR,
2345                        G_IO_ERROR_INVALID_ARGUMENT,
2346                        _("Message body has signature `%s' but there is no signature header"),
2347                        signature_str);
2348           g_free (tupled_signature_str);
2349           goto out;
2350         }
2351       else if (g_strcmp0 (tupled_signature_str, g_variant_get_type_string (message->body)) != 0)
2352         {
2353           g_set_error (error,
2354                        G_IO_ERROR,
2355                        G_IO_ERROR_INVALID_ARGUMENT,
2356                        _("Message body has type signature `%s' but signature in the header field is `%s'"),
2357                        tupled_signature_str, g_variant_get_type_string (message->body));
2358           g_free (tupled_signature_str);
2359           goto out;
2360         }
2361       g_free (tupled_signature_str);
2362       if (!append_body_to_blob (message->body, mos, dos, error))
2363         goto out;
2364     }
2365   else
2366     {
2367       if (signature != NULL && strlen (signature_str) > 0)
2368         {
2369           g_set_error (error,
2370                        G_IO_ERROR,
2371                        G_IO_ERROR_INVALID_ARGUMENT,
2372                        _("Message body is empty but signature in the header field is `(%s)'"),
2373                        signature_str);
2374           goto out;
2375         }
2376     }
2377
2378   /* OK, we're done writing the message - set the body length */
2379   size = g_memory_output_stream_get_data_size (mos);
2380   body_size = size - body_start_offset;
2381
2382   if (!g_seekable_seek (G_SEEKABLE (mos), body_len_offset, G_SEEK_SET, NULL, error))
2383     goto out;
2384
2385   g_data_output_stream_put_uint32 (dos, body_size, NULL, NULL);
2386
2387   if (!g_output_stream_close (G_OUTPUT_STREAM (dos), NULL, error))
2388     goto out;
2389
2390   *out_size = size;
2391   ret = g_memory_output_stream_steal_data (mos);
2392
2393  out:
2394   g_object_unref (dos);
2395   g_object_unref (mos);
2396
2397   return ret;
2398 }
2399
2400 /* ---------------------------------------------------------------------------------------------------- */
2401
2402 static guint32
2403 get_uint32_header (GDBusMessage            *message,
2404                    GDBusMessageHeaderField  header_field)
2405 {
2406   GVariant *value;
2407   guint32 ret;
2408
2409   ret = 0;
2410   value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2411   if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_UINT32))
2412     ret = g_variant_get_uint32 (value);
2413
2414   return ret;
2415 }
2416
2417 static const gchar *
2418 get_string_header (GDBusMessage            *message,
2419                    GDBusMessageHeaderField  header_field)
2420 {
2421   GVariant *value;
2422   const gchar *ret;
2423
2424   ret = NULL;
2425   value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2426   if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
2427     ret = g_variant_get_string (value, NULL);
2428
2429   return ret;
2430 }
2431
2432 static const gchar *
2433 get_object_path_header (GDBusMessage            *message,
2434                         GDBusMessageHeaderField  header_field)
2435 {
2436   GVariant *value;
2437   const gchar *ret;
2438
2439   ret = NULL;
2440   value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2441   if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_OBJECT_PATH))
2442     ret = g_variant_get_string (value, NULL);
2443
2444   return ret;
2445 }
2446
2447 static const gchar *
2448 get_signature_header (GDBusMessage            *message,
2449                       GDBusMessageHeaderField  header_field)
2450 {
2451   GVariant *value;
2452   const gchar *ret;
2453
2454   ret = NULL;
2455   value = g_hash_table_lookup (message->headers, GUINT_TO_POINTER (header_field));
2456   if (value != NULL && g_variant_is_of_type (value, G_VARIANT_TYPE_SIGNATURE))
2457     ret = g_variant_get_string (value, NULL);
2458
2459   return ret;
2460 }
2461
2462 /* ---------------------------------------------------------------------------------------------------- */
2463
2464 static void
2465 set_uint32_header (GDBusMessage             *message,
2466                    GDBusMessageHeaderField   header_field,
2467                    guint32                   value)
2468 {
2469   g_dbus_message_set_header (message,
2470                              header_field,
2471                              g_variant_new_uint32 (value));
2472 }
2473
2474 static void
2475 set_string_header (GDBusMessage             *message,
2476                    GDBusMessageHeaderField   header_field,
2477                    const gchar              *value)
2478 {
2479   g_dbus_message_set_header (message,
2480                              header_field,
2481                              value == NULL ? NULL : g_variant_new_string (value));
2482 }
2483
2484 static void
2485 set_object_path_header (GDBusMessage             *message,
2486                         GDBusMessageHeaderField   header_field,
2487                         const gchar              *value)
2488 {
2489   g_dbus_message_set_header (message,
2490                              header_field,
2491                              value == NULL ? NULL : g_variant_new_object_path (value));
2492 }
2493
2494 static void
2495 set_signature_header (GDBusMessage             *message,
2496                       GDBusMessageHeaderField   header_field,
2497                       const gchar              *value)
2498 {
2499   g_dbus_message_set_header (message,
2500                              header_field,
2501                              value == NULL ? NULL : g_variant_new_signature (value));
2502 }
2503
2504 /* ---------------------------------------------------------------------------------------------------- */
2505
2506 /**
2507  * g_dbus_message_get_reply_serial:
2508  * @message: A #GDBusMessage.
2509  *
2510  * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2511  *
2512  * Returns: The value.
2513  *
2514  * Since: 2.26
2515  */
2516 guint32
2517 g_dbus_message_get_reply_serial (GDBusMessage  *message)
2518 {
2519   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2520   return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL);
2521 }
2522
2523 /**
2524  * g_dbus_message_set_reply_serial:
2525  * @message: A #GDBusMessage.
2526  * @value: The value to set.
2527  *
2528  * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
2529  *
2530  * Since: 2.26
2531  */
2532 void
2533 g_dbus_message_set_reply_serial (GDBusMessage  *message,
2534                                  guint32        value)
2535 {
2536   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2537   set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL, value);
2538 }
2539
2540 /* ---------------------------------------------------------------------------------------------------- */
2541
2542 /**
2543  * g_dbus_message_get_interface:
2544  * @message: A #GDBusMessage.
2545  *
2546  * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2547  *
2548  * Returns: The value.
2549  *
2550  * Since: 2.26
2551  */
2552 const gchar *
2553 g_dbus_message_get_interface (GDBusMessage  *message)
2554 {
2555   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2556   return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE);
2557 }
2558
2559 /**
2560  * g_dbus_message_set_interface:
2561  * @message: A #GDBusMessage.
2562  * @value: The value to set.
2563  *
2564  * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
2565  *
2566  * Since: 2.26
2567  */
2568 void
2569 g_dbus_message_set_interface (GDBusMessage  *message,
2570                               const gchar   *value)
2571 {
2572   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2573   g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2574   set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE, value);
2575 }
2576
2577 /* ---------------------------------------------------------------------------------------------------- */
2578
2579 /**
2580  * g_dbus_message_get_member:
2581  * @message: A #GDBusMessage.
2582  *
2583  * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2584  *
2585  * Returns: The value.
2586  *
2587  * Since: 2.26
2588  */
2589 const gchar *
2590 g_dbus_message_get_member (GDBusMessage  *message)
2591 {
2592   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2593   return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER);
2594 }
2595
2596 /**
2597  * g_dbus_message_set_member:
2598  * @message: A #GDBusMessage.
2599  * @value: The value to set.
2600  *
2601  * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
2602  *
2603  * Since: 2.26
2604  */
2605 void
2606 g_dbus_message_set_member (GDBusMessage  *message,
2607                            const gchar   *value)
2608 {
2609   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2610   g_return_if_fail (value == NULL || g_dbus_is_member_name (value));
2611   set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_MEMBER, value);
2612 }
2613
2614 /* ---------------------------------------------------------------------------------------------------- */
2615
2616 /**
2617  * g_dbus_message_get_path:
2618  * @message: A #GDBusMessage.
2619  *
2620  * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2621  *
2622  * Returns: The value.
2623  *
2624  * Since: 2.26
2625  */
2626 const gchar *
2627 g_dbus_message_get_path (GDBusMessage  *message)
2628 {
2629   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2630   return get_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH);
2631 }
2632
2633 /**
2634  * g_dbus_message_set_path:
2635  * @message: A #GDBusMessage.
2636  * @value: The value to set.
2637  *
2638  * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
2639  *
2640  * Since: 2.26
2641  */
2642 void
2643 g_dbus_message_set_path (GDBusMessage  *message,
2644                          const gchar   *value)
2645 {
2646   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2647   g_return_if_fail (value == NULL || g_variant_is_object_path (value));
2648   set_object_path_header (message, G_DBUS_MESSAGE_HEADER_FIELD_PATH, value);
2649 }
2650
2651 /* ---------------------------------------------------------------------------------------------------- */
2652
2653 /**
2654  * g_dbus_message_get_sender:
2655  * @message: A #GDBusMessage.
2656  *
2657  * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2658  *
2659  * Returns: The value.
2660  *
2661  * Since: 2.26
2662  */
2663 const gchar *
2664 g_dbus_message_get_sender (GDBusMessage *message)
2665 {
2666   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2667   return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER);
2668 }
2669
2670 /**
2671  * g_dbus_message_set_sender:
2672  * @message: A #GDBusMessage.
2673  * @value: The value to set.
2674  *
2675  * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
2676  *
2677  * Since: 2.26
2678  */
2679 void
2680 g_dbus_message_set_sender (GDBusMessage  *message,
2681                            const gchar   *value)
2682 {
2683   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2684   g_return_if_fail (value == NULL || g_dbus_is_name (value));
2685   set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SENDER, value);
2686 }
2687
2688 /* ---------------------------------------------------------------------------------------------------- */
2689
2690 /**
2691  * g_dbus_message_get_destination:
2692  * @message: A #GDBusMessage.
2693  *
2694  * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2695  *
2696  * Returns: The value.
2697  *
2698  * Since: 2.26
2699  */
2700 const gchar *
2701 g_dbus_message_get_destination (GDBusMessage  *message)
2702 {
2703   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2704   return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION);
2705 }
2706
2707 /**
2708  * g_dbus_message_set_destination:
2709  * @message: A #GDBusMessage.
2710  * @value: The value to set.
2711  *
2712  * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
2713  *
2714  * Since: 2.26
2715  */
2716 void
2717 g_dbus_message_set_destination (GDBusMessage  *message,
2718                                 const gchar   *value)
2719 {
2720   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2721   g_return_if_fail (value == NULL || g_dbus_is_name (value));
2722   set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION, value);
2723 }
2724
2725 /* ---------------------------------------------------------------------------------------------------- */
2726
2727 /**
2728  * g_dbus_message_get_error_name:
2729  * @message: A #GDBusMessage.
2730  *
2731  * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2732  *
2733  * Returns: The value.
2734  *
2735  * Since: 2.26
2736  */
2737 const gchar *
2738 g_dbus_message_get_error_name (GDBusMessage  *message)
2739 {
2740   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2741   return get_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME);
2742 }
2743
2744 /**
2745  * g_dbus_message_set_error_name:
2746  * @message: A #GDBusMessage.
2747  * @value: The value to set.
2748  *
2749  * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
2750  *
2751  * Since: 2.26
2752  */
2753 void
2754 g_dbus_message_set_error_name (GDBusMessage  *message,
2755                                const gchar   *value)
2756 {
2757   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2758   g_return_if_fail (value == NULL || g_dbus_is_interface_name (value));
2759   set_string_header (message, G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME, value);
2760 }
2761
2762 /* ---------------------------------------------------------------------------------------------------- */
2763
2764 /**
2765  * g_dbus_message_get_signature:
2766  * @message: A #GDBusMessage.
2767  *
2768  * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2769  *
2770  * Returns: The value.
2771  *
2772  * Since: 2.26
2773  */
2774 const gchar *
2775 g_dbus_message_get_signature (GDBusMessage  *message)
2776 {
2777   const gchar *ret;
2778   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2779   ret = get_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE);
2780   if (ret == NULL)
2781     ret = "";
2782   return ret;
2783 }
2784
2785 /**
2786  * g_dbus_message_set_signature:
2787  * @message: A #GDBusMessage.
2788  * @value: The value to set.
2789  *
2790  * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
2791  *
2792  * Since: 2.26
2793  */
2794 void
2795 g_dbus_message_set_signature (GDBusMessage  *message,
2796                               const gchar   *value)
2797 {
2798   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2799   g_return_if_fail (value == NULL || g_variant_is_signature (value));
2800   set_signature_header (message, G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE, value);
2801 }
2802
2803 /* ---------------------------------------------------------------------------------------------------- */
2804
2805 /**
2806  * g_dbus_message_get_arg0:
2807  * @message: A #GDBusMessage.
2808  *
2809  * Convenience to get the first item in the body of @message.
2810  *
2811  * Returns: The string item or %NULL if the first item in the body of
2812  * @message is not a string.
2813  *
2814  * Since: 2.26
2815  */
2816 const gchar *
2817 g_dbus_message_get_arg0 (GDBusMessage  *message)
2818 {
2819   const gchar *ret;
2820
2821   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
2822
2823   ret = NULL;
2824
2825   if (message->body != NULL && g_variant_is_of_type (message->body, G_VARIANT_TYPE_TUPLE))
2826     {
2827       GVariant *item;
2828       item = g_variant_get_child_value (message->body, 0);
2829       if (g_variant_is_of_type (item, G_VARIANT_TYPE_STRING))
2830         ret = g_variant_get_string (item, NULL);
2831       g_variant_unref (item);
2832     }
2833
2834   return ret;
2835 }
2836
2837 /* ---------------------------------------------------------------------------------------------------- */
2838
2839 /**
2840  * g_dbus_message_get_num_unix_fds:
2841  * @message: A #GDBusMessage.
2842  *
2843  * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2844  *
2845  * Returns: The value.
2846  *
2847  * Since: 2.26
2848  */
2849 guint32
2850 g_dbus_message_get_num_unix_fds (GDBusMessage *message)
2851 {
2852   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), 0);
2853   return get_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS);
2854 }
2855
2856 /**
2857  * g_dbus_message_set_num_unix_fds:
2858  * @message: A #GDBusMessage.
2859  * @value: The value to set.
2860  *
2861  * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
2862  *
2863  * Since: 2.26
2864  */
2865 void
2866 g_dbus_message_set_num_unix_fds (GDBusMessage  *message,
2867                                  guint32        value)
2868 {
2869   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
2870   set_uint32_header (message, G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS, value);
2871 }
2872
2873 /* ---------------------------------------------------------------------------------------------------- */
2874
2875 /**
2876  * g_dbus_message_to_gerror:
2877  * @message: A #GDBusMessage.
2878  * @error: The #GError to set.
2879  *
2880  * If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does
2881  * nothing and returns %FALSE.
2882  *
2883  * Otherwise this method encodes the error in @message as a #GError
2884  * using g_dbus_error_set_dbus_error() using the information in the
2885  * %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of @message as
2886  * well as the first string item in @message's body.
2887  *
2888  * Returns: %TRUE if @error was set, %FALSE otherwise.
2889  *
2890  * Since: 2.26
2891  */
2892 gboolean
2893 g_dbus_message_to_gerror (GDBusMessage   *message,
2894                           GError        **error)
2895 {
2896   gboolean ret;
2897   const gchar *error_name;
2898
2899   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
2900
2901   ret = FALSE;
2902   if (message->type != G_DBUS_MESSAGE_TYPE_ERROR)
2903     goto out;
2904
2905   error_name = g_dbus_message_get_error_name (message);
2906   if (error_name != NULL)
2907     {
2908       GVariant *body;
2909
2910       body = g_dbus_message_get_body (message);
2911
2912       if (body != NULL && g_variant_is_of_type (body, G_VARIANT_TYPE ("(s)")))
2913         {
2914           const gchar *error_message;
2915           g_variant_get (body, "(&s)", &error_message);
2916           g_dbus_error_set_dbus_error (error,
2917                                        error_name,
2918                                        error_message,
2919                                        NULL);
2920         }
2921       else
2922         {
2923           /* these two situations are valid, yet pretty rare */
2924           if (body != NULL)
2925             {
2926               g_dbus_error_set_dbus_error (error,
2927                                            error_name,
2928                                            "",
2929                                            _("Error return with body of type `%s'"),
2930                                            g_variant_get_type_string (body));
2931             }
2932           else
2933             {
2934               g_dbus_error_set_dbus_error (error,
2935                                            error_name,
2936                                            "",
2937                                            _("Error return with empty body"));
2938             }
2939         }
2940     }
2941   else
2942     {
2943       /* TOOD: this shouldn't happen - should check this at message serialization
2944        * time and disconnect the peer.
2945        */
2946       g_set_error (error,
2947                    G_IO_ERROR,
2948                    G_IO_ERROR_FAILED,
2949                    "Error return without error-name header!");
2950     }
2951
2952   ret = TRUE;
2953
2954  out:
2955   return ret;
2956 }
2957
2958 /* ---------------------------------------------------------------------------------------------------- */
2959
2960 static gchar *
2961 flags_to_string (GType flags_type, guint value)
2962 {
2963   GString *s;
2964   GFlagsClass *klass;
2965   guint n;
2966
2967   klass = g_type_class_ref (flags_type);
2968   s = g_string_new (NULL);
2969   for (n = 0; n < 32; n++)
2970     {
2971       if ((value & (1<<n)) != 0)
2972         {
2973           GFlagsValue *flags_value;
2974           flags_value = g_flags_get_first_value (klass, (1<<n));
2975           if (s->len > 0)
2976             g_string_append_c (s, ',');
2977           if (flags_value != NULL)
2978             g_string_append (s, flags_value->value_nick);
2979           else
2980             g_string_append_printf (s, "unknown (bit %d)", n);
2981         }
2982     }
2983   if (s->len == 0)
2984     g_string_append (s, "none");
2985   g_type_class_unref (klass);
2986   return g_string_free (s, FALSE);
2987 }
2988
2989 static gint
2990 _sort_keys_func (gconstpointer a,
2991                  gconstpointer b)
2992 {
2993   gint ia;
2994   gint ib;
2995
2996   ia = GPOINTER_TO_INT (a);
2997   ib = GPOINTER_TO_INT (b);
2998
2999   return ia - ib;
3000 }
3001
3002 /**
3003  * g_dbus_message_print:
3004  * @message: A #GDBusMessage.
3005  * @indent: Indentation level.
3006  *
3007  * Produces a human-readable multi-line description of @message.
3008  *
3009  * The contents of the description has no ABI guarantees, the contents
3010  * and formatting is subject to change at any time. Typical output
3011  * looks something like this:
3012  * <programlisting>
3013  * Type:    method-call
3014  * Flags:   none
3015  * Version: 0
3016  * Serial:  4
3017  * Headers:
3018  *   path -> objectpath '/org/gtk/GDBus/TestObject'
3019  *   interface -> 'org.gtk.GDBus.TestInterface'
3020  *   member -> 'GimmeStdout'
3021  *   destination -> ':1.146'
3022  * Body: ()
3023  * UNIX File Descriptors:
3024  *   (none)
3025  * </programlisting>
3026  * or
3027  * <programlisting>
3028  * Type:    method-return
3029  * Flags:   no-reply-expected
3030  * Version: 0
3031  * Serial:  477
3032  * Headers:
3033  *   reply-serial -> uint32 4
3034  *   destination -> ':1.159'
3035  *   sender -> ':1.146'
3036  *   num-unix-fds -> uint32 1
3037  * Body: ()
3038  * UNIX File Descriptors:
3039  *   fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635
3040  * </programlisting>
3041  *
3042  * Returns: A string that should be freed with g_free().
3043  *
3044  * Since: 2.26
3045  */
3046 gchar *
3047 g_dbus_message_print (GDBusMessage *message,
3048                       guint         indent)
3049 {
3050   GString *str;
3051   gchar *s;
3052   GList *keys;
3053   GList *l;
3054
3055   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
3056
3057   str = g_string_new (NULL);
3058
3059   s = _g_dbus_enum_to_string (G_TYPE_DBUS_MESSAGE_TYPE, message->type);
3060   g_string_append_printf (str, "%*sType:    %s\n", indent, "", s);
3061   g_free (s);
3062   s = flags_to_string (G_TYPE_DBUS_MESSAGE_FLAGS, message->flags);
3063   g_string_append_printf (str, "%*sFlags:   %s\n", indent, "", s);
3064   g_free (s);
3065   g_string_append_printf (str, "%*sVersion: %d\n", indent, "", message->major_protocol_version);
3066   g_string_append_printf (str, "%*sSerial:  %d\n", indent, "", message->serial);
3067
3068   g_string_append_printf (str, "%*sHeaders:\n", indent, "");
3069   keys = g_hash_table_get_keys (message->headers);
3070   keys = g_list_sort (keys, _sort_keys_func);
3071   if (keys != NULL)
3072     {
3073       for (l = keys; l != NULL; l = l->next)
3074         {
3075           gint key = GPOINTER_TO_INT (l->data);
3076           GVariant *value;
3077           gchar *value_str;
3078
3079           value = g_hash_table_lookup (message->headers, l->data);
3080           g_assert (value != NULL);
3081
3082           s = _g_dbus_enum_to_string (G_TYPE_DBUS_MESSAGE_HEADER_FIELD, key);
3083           value_str = g_variant_print (value, TRUE);
3084           g_string_append_printf (str, "%*s  %s -> %s\n", indent, "", s, value_str);
3085           g_free (s);
3086           g_free (value_str);
3087         }
3088     }
3089   else
3090     {
3091       g_string_append_printf (str, "%*s  (none)\n", indent, "");
3092     }
3093   g_string_append_printf (str, "%*sBody: ", indent, "");
3094   if (message->body != NULL)
3095     {
3096       g_variant_print_string (message->body,
3097                               str,
3098                               TRUE);
3099     }
3100   else
3101     {
3102       g_string_append (str, "()");
3103     }
3104   g_string_append (str, "\n");
3105 #ifdef G_OS_UNIX
3106   g_string_append_printf (str, "%*sUNIX File Descriptors:\n", indent, "");
3107   if (message->fd_list != NULL)
3108     {
3109       gint num_fds;
3110       const gint *fds;
3111       gint n;
3112
3113       fds = g_unix_fd_list_peek_fds (message->fd_list, &num_fds);
3114       if (num_fds > 0)
3115         {
3116           for (n = 0; n < num_fds; n++)
3117             {
3118               GString *fs;
3119               struct stat statbuf;
3120               fs = g_string_new (NULL);
3121               if (fstat (fds[n], &statbuf) == 0)
3122                 {
3123                   g_string_append_printf (fs, "%s" "dev=%d:%d", fs->len > 0 ? "," : "",
3124                                           major (statbuf.st_dev), minor (statbuf.st_dev));
3125                   g_string_append_printf (fs, "%s" "mode=0%o", fs->len > 0 ? "," : "",
3126                                           statbuf.st_mode);
3127                   g_string_append_printf (fs, "%s" "ino=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3128                                           (guint64) statbuf.st_ino);
3129                   g_string_append_printf (fs, "%s" "uid=%d", fs->len > 0 ? "," : "",
3130                                           statbuf.st_uid);
3131                   g_string_append_printf (fs, "%s" "gid=%d", fs->len > 0 ? "," : "",
3132                                           statbuf.st_gid);
3133                   g_string_append_printf (fs, "%s" "rdev=%d:%d", fs->len > 0 ? "," : "",
3134                                           major (statbuf.st_rdev), minor (statbuf.st_rdev));
3135                   g_string_append_printf (fs, "%s" "size=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3136                                           (guint64) statbuf.st_size);
3137                   g_string_append_printf (fs, "%s" "atime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3138                                           (guint64) statbuf.st_atime);
3139                   g_string_append_printf (fs, "%s" "mtime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3140                                           (guint64) statbuf.st_mtime);
3141                   g_string_append_printf (fs, "%s" "ctime=%" G_GUINT64_FORMAT, fs->len > 0 ? "," : "",
3142                                           (guint64) statbuf.st_ctime);
3143                 }
3144               else
3145                 {
3146                   g_string_append_printf (fs, "(fstat failed: %s)", strerror (errno));
3147                 }
3148               g_string_append_printf (str, "%*s  fd %d: %s\n", indent, "", fds[n], fs->str);
3149               g_string_free (fs, TRUE);
3150             }
3151         }
3152       else
3153         {
3154           g_string_append_printf (str, "%*s  (empty)\n", indent, "");
3155         }
3156     }
3157   else
3158     {
3159       g_string_append_printf (str, "%*s  (none)\n", indent, "");
3160     }
3161 #endif
3162
3163   return g_string_free (str, FALSE);
3164 }
3165
3166 /**
3167  * g_dbus_message_get_locked:
3168  * @message: A #GDBusMessage.
3169  *
3170  * Checks whether @message is locked. To monitor changes to this
3171  * value, conncet to the #GObject::notify signal to listen for changes
3172  * on the #GDBusMessage:locked property.
3173  *
3174  * Returns: %TRUE if @message is locked, %FALSE otherwise.
3175  *
3176  * Since: 2.26
3177  */
3178 gboolean
3179 g_dbus_message_get_locked (GDBusMessage *message)
3180 {
3181   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), FALSE);
3182   return message->locked;
3183 }
3184
3185 /**
3186  * g_dbus_message_lock:
3187  * @message: A #GDBusMessage.
3188  *
3189  * If @message is locked, does nothing. Otherwise locks the message.
3190  *
3191  * Since: 2.26
3192  */
3193 void
3194 g_dbus_message_lock (GDBusMessage *message)
3195 {
3196   g_return_if_fail (G_IS_DBUS_MESSAGE (message));
3197
3198   if (message->locked)
3199     goto out;
3200
3201   message->locked = TRUE;
3202   g_object_notify (G_OBJECT (message), "locked");
3203
3204  out:
3205   ;
3206 }
3207
3208 /**
3209  * g_dbus_message_copy:
3210  * @message: A #GDBusMessage.
3211  * @error: Return location for error or %NULL.
3212  *
3213  * Copies @message. The copy is a deep copy and the returned
3214  * #GDBusMessage is completely identical except that it is guaranteed
3215  * to not be locked.
3216  *
3217  * This operation can fail if e.g. @message contains file descriptors
3218  * and the per-process or system-wide open files limit is reached.
3219  *
3220  * Returns: (transfer full): A new #GDBusMessage or %NULL if @error is set.
3221  *     Free with g_object_unref().
3222  *
3223  * Since: 2.26
3224  */
3225 GDBusMessage *
3226 g_dbus_message_copy (GDBusMessage  *message,
3227                      GError       **error)
3228 {
3229   GDBusMessage *ret;
3230   GHashTableIter iter;
3231   gpointer header_key;
3232   GVariant *header_value;
3233
3234   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
3235   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
3236
3237   ret = g_dbus_message_new ();
3238   ret->type                   = message->type;
3239   ret->flags                  = message->flags;
3240   ret->byte_order             = message->byte_order;
3241   ret->major_protocol_version = message->major_protocol_version;
3242   ret->serial                 = message->serial;
3243
3244 #ifdef G_OS_UNIX
3245   if (message->fd_list != NULL)
3246     {
3247       gint n;
3248       gint num_fds;
3249       const gint *fds;
3250
3251       ret->fd_list = g_unix_fd_list_new ();
3252       fds = g_unix_fd_list_peek_fds (message->fd_list, &num_fds);
3253       for (n = 0; n < num_fds; n++)
3254         {
3255           if (g_unix_fd_list_append (ret->fd_list,
3256                                      fds[n],
3257                                      error) == -1)
3258             {
3259               g_object_unref (ret);
3260               ret = NULL;
3261               goto out;
3262             }
3263         }
3264     }
3265 #endif
3266
3267   /* see https://bugzilla.gnome.org/show_bug.cgi?id=624546#c8 for why it's fine
3268    * to just ref (as opposed to deep-copying) the GVariant instances
3269    */
3270   ret->body = message->body != NULL ? g_variant_ref (message->body) : NULL;
3271   g_hash_table_iter_init (&iter, message->headers);
3272   while (g_hash_table_iter_next (&iter, &header_key, (gpointer) &header_value))
3273     g_hash_table_insert (ret->headers, header_key, g_variant_ref (header_value));
3274
3275  out:
3276   return ret;
3277 }