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