gio/gdbusmethodinvocation.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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: David Zeuthen <davidz@redhat.com>
  19  */
  20
  21 #include "config.h"
  22
  23 #include <stdlib.h>
  24
  25 #include "gdbusutils.h"
  26 #include "gdbusconnection.h"
  27 #include "gdbusmessage.h"
  28 #include "gdbusmethodinvocation.h"
  29 #include "gdbusintrospection.h"
  30 #include "gdbuserror.h"
  31 #include "gdbusprivate.h"
  32
  33 #ifdef G_OS_UNIX
  34 #include "gunixfdlist.h"
  35 #endif
  36
  37 #include "glibintl.h"
  38
  39 /**
  40  * SECTION:gdbusmethodinvocation
  41  * @short_description: Object for handling remote calls
  42  * @include: gio/gio.h
  43  *
  44  * Instances of the #GDBusMethodInvocation class are used when
  45  * handling D-Bus method calls. It provides a way to asynchronously
  46  * return results and errors.
  47  *
  48  * The normal way to obtain a #GDBusMethodInvocation object is to receive
  49  * it as an argument to the handle_method_call() function in a
  50  * #GDBusInterfaceVTable that was passed to g_dbus_connection_register_object().
  51  */
  52
  53 typedef struct _GDBusMethodInvocationClass GDBusMethodInvocationClass;
  54
  55 /**
  56  * GDBusMethodInvocationClass:
  57  *
  58  * Class structure for #GDBusMethodInvocation.
  59  *
  60  * Since: 2.26
  61  */
  62 struct _GDBusMethodInvocationClass
  63 {
  64   /*< private >*/
  65   GObjectClass parent_class;
  66 };
  67
  68 /**
  69  * GDBusMethodInvocation:
  70  *
  71  * The #GDBusMethodInvocation structure contains only private data and
  72  * should only be accessed using the provided API.
  73  *
  74  * Since: 2.26
  75  */
  76 struct _GDBusMethodInvocation
  77 {
  78   /*< private >*/
  79   GObject parent_instance;
  80
  81   /* construct-only properties */
  82   gchar           *sender;
  83   gchar           *object_path;
  84   gchar           *interface_name;
  85   gchar           *method_name;
  86   GDBusMethodInfo *method_info;
  87   GDBusPropertyInfo *property_info;
  88   GDBusConnection *connection;
  89   GDBusMessage    *message;
  90   GVariant        *parameters;
  91   gpointer         user_data;
  92 };
  93
  94 G_DEFINE_TYPE (GDBusMethodInvocation, g_dbus_method_invocation, G_TYPE_OBJECT);
  95
  96 static void
  97 g_dbus_method_invocation_finalize (GObject *object)
  98 {
  99   GDBusMethodInvocation *invocation = G_DBUS_METHOD_INVOCATION (object);
 100
 101   g_free (invocation->sender);
 102   g_free (invocation->object_path);
 103   g_free (invocation->interface_name);
 104   g_free (invocation->method_name);
 105   if (invocation->method_info)
 106       g_dbus_method_info_unref (invocation->method_info);
 107   g_object_unref (invocation->connection);
 108   g_object_unref (invocation->message);
 109   g_variant_unref (invocation->parameters);
 110
 111   G_OBJECT_CLASS (g_dbus_method_invocation_parent_class)->finalize (object);
 112 }
 113
 114 static void
 115 g_dbus_method_invocation_class_init (GDBusMethodInvocationClass *klass)
 116 {
 117   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 118
 119   gobject_class->finalize = g_dbus_method_invocation_finalize;
 120 }
 121
 122 static void
 123 g_dbus_method_invocation_init (GDBusMethodInvocation *invocation)
 124 {
 125 }
 126
 127 /**
 128  * g_dbus_method_invocation_get_sender:
 129  * @invocation: A #GDBusMethodInvocation.
 130  *
 131  * Gets the bus name that invoked the method.
 132  *
 133  * Returns: A string. Do not free, it is owned by @invocation.
 134  *
 135  * Since: 2.26
 136  */
 137 const gchar *
 138 g_dbus_method_invocation_get_sender (GDBusMethodInvocation *invocation)
 139 {
 140   g_return_val_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation), NULL);
 141   return invocation->sender;
 142 }
 143
 144 /**
 145  * g_dbus_method_invocation_get_object_path:
 146  * @invocation: A #GDBusMethodInvocation.
 147  *
 148  * Gets the object path the method was invoked on.
 149  *
 150  * Returns: A string. Do not free, it is owned by @invocation.
 151  *
 152  * Since: 2.26
 153  */
 154 const gchar *
 155 g_dbus_method_invocation_get_object_path (GDBusMethodInvocation *invocation)
 156 {
 157   g_return_val_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation), NULL);
 158   return invocation->object_path;
 159 }
 160
 161 /**
 162  * g_dbus_method_invocation_get_interface_name:
 163  * @invocation: A #GDBusMethodInvocation.
 164  *
 165  * Gets the name of the D-Bus interface the method was invoked on.
 166  *
 167  * If this method call is a property Get, Set or GetAll call that has
 168  * been redirected to the method call handler then
 169  * "org.freedesktop.DBus.Properties" will be returned.  See
 170  * #GDBusInterfaceVTable for more information.
 171  *
 172  * Returns: A string. Do not free, it is owned by @invocation.
 173  *
 174  * Since: 2.26
 175  */
 176 const gchar *
 177 g_dbus_method_invocation_get_interface_name (GDBusMethodInvocation *invocation)
 178 {
 179   g_return_val_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation), NULL);
 180   return invocation->interface_name;
 181 }
 182
 183 /**
 184  * g_dbus_method_invocation_get_method_info:
 185  * @invocation: A #GDBusMethodInvocation.
 186  *
 187  * Gets information about the method call, if any.
 188  *
 189  * If this method invocation is a property Get, Set or GetAll call that
 190  * has been redirected to the method call handler then %NULL will be
 191  * returned.  See g_dbus_method_invocation_get_property_info() and
 192  * #GDBusInterfaceVTable for more information.
 193  *
 194  * Returns: A #GDBusMethodInfo or %NULL. Do not free, it is owned by @invocation.
 195  *
 196  * Since: 2.26
 197  */
 198 const GDBusMethodInfo *
 199 g_dbus_method_invocation_get_method_info (GDBusMethodInvocation *invocation)
 200 {
 201   g_return_val_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation), NULL);
 202   return invocation->method_info;
 203 }
 204
 205 /**
 206  * g_dbus_method_invocation_get_property_info:
 207  * @invocation: A #GDBusMethodInvocation
 208  *
 209  * Gets information about the property that this method call is for, if
 210  * any.
 211  *
 212  * This will only be set in the case of an invocation in response to a
 213  * property Get or Set call that has been directed to the method call
 214  * handler for an object on account of its property_get() or
 215  * property_set() vtable pointers being unset.
 216  *
 217  * See #GDBusInterfaceVTable for more information.
 218  *
 219  * If the call was GetAll, %NULL will be returned.
 220  *
 221  * Returns: (transfer none): a #GDBusPropertyInfo or %NULL
 222  *
 223  * Since: 2.38
 224  */
 225 const GDBusPropertyInfo *
 226 g_dbus_method_invocation_get_property_info (GDBusMethodInvocation *invocation)
 227 {
 228   g_return_val_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation), NULL);
 229   return invocation->property_info;
 230 }
 231
 232 /**
 233  * g_dbus_method_invocation_get_method_name:
 234  * @invocation: A #GDBusMethodInvocation.
 235  *
 236  * Gets the name of the method that was invoked.
 237  *
 238  * Returns: A string. Do not free, it is owned by @invocation.
 239  *
 240  * Since: 2.26
 241  */
 242 const gchar *
 243 g_dbus_method_invocation_get_method_name (GDBusMethodInvocation *invocation)
 244 {
 245   g_return_val_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation), NULL);
 246   return invocation->method_name;
 247 }
 248
 249 /**
 250  * g_dbus_method_invocation_get_connection:
 251  * @invocation: A #GDBusMethodInvocation.
 252  *
 253  * Gets the #GDBusConnection the method was invoked on.
 254  *
 255  * Returns: (transfer none):A #GDBusConnection. Do not free, it is owned by @invocation.
 256  *
 257  * Since: 2.26
 258  */
 259 GDBusConnection *
 260 g_dbus_method_invocation_get_connection (GDBusMethodInvocation *invocation)
 261 {
 262   g_return_val_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation), NULL);
 263   return invocation->connection;
 264 }
 265
 266 /**
 267  * g_dbus_method_invocation_get_message:
 268  * @invocation: A #GDBusMethodInvocation.
 269  *
 270  * Gets the #GDBusMessage for the method invocation. This is useful if
 271  * you need to use low-level protocol features, such as UNIX file
 272  * descriptor passing, that cannot be properly expressed in the
 273  * #GVariant API.
 274  *
 275  * See <xref linkend="gdbus-server"/> and <xref
 276  * linkend="gdbus-unix-fd-client"/> for an example of how to use this
 277  * low-level API to send and receive UNIX file descriptors.
 278  *
 279  * Returns: (transfer none): #GDBusMessage. Do not free, it is owned by @invocation.
 280  *
 281  * Since: 2.26
 282  */
 283 GDBusMessage *
 284 g_dbus_method_invocation_get_message (GDBusMethodInvocation *invocation)
 285 {
 286   g_return_val_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation), NULL);
 287   return invocation->message;
 288 }
 289
 290 /**
 291  * g_dbus_method_invocation_get_parameters:
 292  * @invocation: A #GDBusMethodInvocation.
 293  *
 294  * Gets the parameters of the method invocation. If there are no input
 295  * parameters then this will return a GVariant with 0 children rather than NULL.
 296  *
 297  * Returns: (transfer none): A #GVariant tuple. Do not unref this because it is owned by @invocation.
 298  *
 299  * Since: 2.26
 300  */
 301 GVariant *
 302 g_dbus_method_invocation_get_parameters (GDBusMethodInvocation *invocation)
 303 {
 304   g_return_val_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation), NULL);
 305   return invocation->parameters;
 306 }
 307
 308 /**
 309  * g_dbus_method_invocation_get_user_data: (skip)
 310  * @invocation: A #GDBusMethodInvocation.
 311  *
 312  * Gets the @user_data #gpointer passed to g_dbus_connection_register_object().
 313  *
 314  * Returns: A #gpointer.
 315  *
 316  * Since: 2.26
 317  */
 318 gpointer
 319 g_dbus_method_invocation_get_user_data (GDBusMethodInvocation *invocation)
 320 {
 321   g_return_val_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation), NULL);
 322   return invocation->user_data;
 323 }
 324
 325 /* < internal >
 326  * _g_dbus_method_invocation_new:
 327  * @sender: (allow-none): The bus name that invoked the method or %NULL if @connection is not a bus connection.
 328  * @object_path: The object path the method was invoked on.
 329  * @interface_name: The name of the D-Bus interface the method was invoked on.
 330  * @method_name: The name of the method that was invoked.
 331  * @method_info: (allow-none): Information about the method call or %NULL.
 332  * @property_info: (allow-none): Information about the property or %NULL.
 333  * @connection: The #GDBusConnection the method was invoked on.
 334  * @message: The D-Bus message as a #GDBusMessage.
 335  * @parameters: The parameters as a #GVariant tuple.
 336  * @user_data: The @user_data #gpointer passed to g_dbus_connection_register_object().
 337  *
 338  * Creates a new #GDBusMethodInvocation object.
 339  *
 340  * Returns: A #GDBusMethodInvocation. Free with g_object_unref().
 341  *
 342  * Since: 2.26
 343  */
 344 GDBusMethodInvocation *
 345 _g_dbus_method_invocation_new (const gchar             *sender,
 346                                const gchar             *object_path,
 347                                const gchar             *interface_name,
 348                                const gchar             *method_name,
 349                                const GDBusMethodInfo   *method_info,
 350                                const GDBusPropertyInfo *property_info,
 351                                GDBusConnection         *connection,
 352                                GDBusMessage            *message,
 353                                GVariant                *parameters,
 354                                gpointer                 user_data)
 355 {
 356   GDBusMethodInvocation *invocation;
 357
 358   g_return_val_if_fail (sender == NULL || g_dbus_is_name (sender), NULL);
 359   g_return_val_if_fail (g_variant_is_object_path (object_path), NULL);
 360   g_return_val_if_fail (interface_name == NULL || g_dbus_is_interface_name (interface_name), NULL);
 361   g_return_val_if_fail (g_dbus_is_member_name (method_name), NULL);
 362   g_return_val_if_fail (G_IS_DBUS_CONNECTION (connection), NULL);
 363   g_return_val_if_fail (G_IS_DBUS_MESSAGE (message), NULL);
 364   g_return_val_if_fail (g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE), NULL);
 365
 366   invocation = G_DBUS_METHOD_INVOCATION (g_object_new (G_TYPE_DBUS_METHOD_INVOCATION, NULL));
 367   invocation->sender = g_strdup (sender);
 368   invocation->object_path = g_strdup (object_path);
 369   invocation->interface_name = g_strdup (interface_name);
 370   invocation->method_name = g_strdup (method_name);
 371   if (method_info)
 372     invocation->method_info = g_dbus_method_info_ref ((GDBusMethodInfo *)method_info);
 373   if (property_info)
 374     invocation->property_info = g_dbus_property_info_ref ((GDBusPropertyInfo *)property_info);
 375   invocation->connection = g_object_ref (connection);
 376   invocation->message = g_object_ref (message);
 377   invocation->parameters = g_variant_ref (parameters);
 378   invocation->user_data = user_data;
 379
 380   return invocation;
 381 }
 382
 383 /* ---------------------------------------------------------------------------------------------------- */
 384
 385 static void
 386 g_dbus_method_invocation_return_value_internal (GDBusMethodInvocation *invocation,
 387                                                 GVariant              *parameters,
 388                                                 GUnixFDList           *fd_list)
 389 {
 390   GDBusMessage *reply;
 391   GError *error;
 392
 393   g_return_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation));
 394   g_return_if_fail ((parameters == NULL) || g_variant_is_of_type (parameters, G_VARIANT_TYPE_TUPLE));
 395
 396   if (parameters == NULL)
 397     parameters = g_variant_new_tuple (NULL, 0);
 398
 399   /* if we have introspection data, check that the signature of @parameters is correct */
 400   if (invocation->method_info != NULL)
 401     {
 402       GVariantType *type;
 403
 404       type = _g_dbus_compute_complete_signature (invocation->method_info->out_args);
 405
 406       if (!g_variant_is_of_type (parameters, type))
 407         {
 408           gchar *type_string = g_variant_type_dup_string (type);
 409
 410           g_warning ("Type of return value is incorrect: expected '%s', got '%s''",
 411                      type_string, g_variant_get_type_string (parameters));
 412           g_variant_type_free (type);
 413           g_free (type_string);
 414           goto out;
 415         }
 416       g_variant_type_free (type);
 417     }
 418
 419   /* property_info is only non-NULL if set that way from
 420    * GDBusConnection, so this must be the case of async property
 421    * handling on either 'Get', 'Set' or 'GetAll'.
 422    */
 423   if (invocation->property_info != NULL)
 424     {
 425       if (g_str_equal (invocation->method_name, "Get"))
 426         {
 427           GVariant *nested;
 428
 429           if (!g_variant_is_of_type (parameters, G_VARIANT_TYPE ("(v)")))
 430             {
 431               g_warning ("Type of return value for property 'Get' call should be '(v)' but got '%s'",
 432                          g_variant_get_type_string (parameters));
 433               goto out;
 434             }
 435
 436           /* Go deeper and make sure that the value inside of the
 437            * variant matches the property type.
 438            */
 439           g_variant_get (parameters, "(v)", &nested);
 440           if (!g_str_equal (g_variant_get_type_string (nested), invocation->property_info->signature))
 441             {
 442               g_warning ("Value returned from property 'Get' call for '%s' should be '%s' but is '%s'",
 443                          invocation->property_info->name, invocation->property_info->signature,
 444                          g_variant_get_type_string (nested));
 445               g_variant_unref (nested);
 446               goto out;
 447             }
 448           g_variant_unref (nested);
 449         }
 450
 451       else if (g_str_equal (invocation->method_name, "GetAll"))
 452         {
 453           if (!g_variant_is_of_type (parameters, G_VARIANT_TYPE ("(a{sv})")))
 454             {
 455               g_warning ("Type of return value for property 'GetAll' call should be '(a{sv})' but got '%s'",
 456                          g_variant_get_type_string (parameters));
 457               goto out;
 458             }
 459
 460           /* Could iterate the list of properties and make sure that all
 461            * of them are actually on the interface and with the correct
 462            * types, but let's not do that for now...
 463            */
 464         }
 465
 466       else if (g_str_equal (invocation->method_name, "Set"))
 467         {
 468           if (!g_variant_is_of_type (parameters, G_VARIANT_TYPE_UNIT))
 469             {
 470               g_warning ("Type of return value for property 'Set' call should be '()' but got '%s'",
 471                          g_variant_get_type_string (parameters));
 472               goto out;
 473             }
 474         }
 475
 476       else
 477         g_assert_not_reached ();
 478     }
 479
 480   if (G_UNLIKELY (_g_dbus_debug_return ()))
 481     {
 482       _g_dbus_debug_print_lock ();
 483       g_print ("========================================================================\n"
 484                "GDBus-debug:Return:\n"
 485                " >>>> METHOD RETURN\n"
 486                "      in response to %s.%s()\n"
 487                "      on object %s\n"
 488                "      to name %s\n"
 489                "      reply-serial %d\n",
 490                invocation->interface_name, invocation->method_name,
 491                invocation->object_path,
 492                invocation->sender,
 493                g_dbus_message_get_serial (invocation->message));
 494       _g_dbus_debug_print_unlock ();
 495     }
 496
 497   reply = g_dbus_message_new_method_reply (invocation->message);
 498   g_dbus_message_set_body (reply, parameters);
 499
 500 #ifdef G_OS_UNIX
 501   if (fd_list != NULL)
 502     g_dbus_message_set_unix_fd_list (reply, fd_list);
 503 #endif
 504
 505   error = NULL;
 506   if (!g_dbus_connection_send_message (g_dbus_method_invocation_get_connection (invocation), reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, &error))
 507     {
 508       g_warning ("Error sending message: %s", error->message);
 509       g_error_free (error);
 510     }
 511   g_object_unref (reply);
 512
 513  out:
 514   g_object_unref (invocation);
 515 }
 516
 517 /**
 518  * g_dbus_method_invocation_return_value:
 519  * @invocation: (transfer full): A #GDBusMethodInvocation.
 520  * @parameters: (allow-none): A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters.
 521  *
 522  * Finishes handling a D-Bus method call by returning @parameters.
 523  * If the @parameters GVariant is floating, it is consumed.
 524  *
 525  * It is an error if @parameters is not of the right format.
 526  *
 527  * This method will free @invocation, you cannot use it afterwards.
 528  *
 529  * Since: 2.26
 530  */
 531 void
 532 g_dbus_method_invocation_return_value (GDBusMethodInvocation *invocation,
 533                                        GVariant              *parameters)
 534 {
 535   g_dbus_method_invocation_return_value_internal (invocation, parameters, NULL);
 536 }
 537
 538 #ifdef G_OS_UNIX
 539 /**
 540  * g_dbus_method_invocation_return_value_with_unix_fd_list:
 541  * @invocation: (transfer full): A #GDBusMethodInvocation.
 542  * @parameters: (allow-none): A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters.
 543  * @fd_list: (allow-none): A #GUnixFDList or %NULL.
 544  *
 545  * Like g_dbus_method_invocation_return_value() but also takes a #GUnixFDList.
 546  *
 547  * This method is only available on UNIX.
 548  *
 549  * This method will free @invocation, you cannot use it afterwards.
 550  *
 551  * Since: 2.30
 552  */
 553 void
 554 g_dbus_method_invocation_return_value_with_unix_fd_list (GDBusMethodInvocation *invocation,
 555                                                          GVariant              *parameters,
 556                                                          GUnixFDList           *fd_list)
 557 {
 558   g_dbus_method_invocation_return_value_internal (invocation, parameters, fd_list);
 559 }
 560 #endif
 561
 562 /* ---------------------------------------------------------------------------------------------------- */
 563
 564 /**
 565  * g_dbus_method_invocation_return_error:
 566  * @invocation: (transfer full): A #GDBusMethodInvocation.
 567  * @domain: A #GQuark for the #GError error domain.
 568  * @code: The error code.
 569  * @format: printf()-style format.
 570  * @...: Parameters for @format.
 571  *
 572  * Finishes handling a D-Bus method call by returning an error.
 573  *
 574  * See g_dbus_error_encode_gerror() for details about what error name
 575  * will be returned on the wire. In a nutshell, if the given error is
 576  * registered using g_dbus_error_register_error() the name given
 577  * during registration is used. Otherwise, a name of the form
 578  * <literal>org.gtk.GDBus.UnmappedGError.Quark...</literal> is
 579  * used. This provides transparent mapping of #GError between
 580  * applications using GDBus.
 581  *
 582  * If you are writing an application intended to be portable,
 583  * always register errors with g_dbus_error_register_error()
 584  * or use g_dbus_method_invocation_return_dbus_error().
 585  *
 586  * This method will free @invocation, you cannot use it afterwards.
 587  *
 588  * Since: 2.26
 589  */
 590 void
 591 g_dbus_method_invocation_return_error (GDBusMethodInvocation *invocation,
 592                                        GQuark                 domain,
 593                                        gint                   code,
 594                                        const gchar           *format,
 595                                        ...)
 596 {
 597   va_list var_args;
 598
 599   g_return_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation));
 600   g_return_if_fail (format != NULL);
 601
 602   va_start (var_args, format);
 603   g_dbus_method_invocation_return_error_valist (invocation,
 604                                                 domain,
 605                                                 code,
 606                                                 format,
 607                                                 var_args);
 608   va_end (var_args);
 609 }
 610
 611 /**
 612  * g_dbus_method_invocation_return_error_valist:
 613  * @invocation: (transfer full): A #GDBusMethodInvocation.
 614  * @domain: A #GQuark for the #GError error domain.
 615  * @code: The error code.
 616  * @format: printf()-style format.
 617  * @var_args: #va_list of parameters for @format.
 618  *
 619  * Like g_dbus_method_invocation_return_error() but intended for
 620  * language bindings.
 621  *
 622  * This method will free @invocation, you cannot use it afterwards.
 623  *
 624  * Since: 2.26
 625  */
 626 void
 627 g_dbus_method_invocation_return_error_valist (GDBusMethodInvocation *invocation,
 628                                               GQuark                 domain,
 629                                               gint                   code,
 630                                               const gchar           *format,
 631                                               va_list                var_args)
 632 {
 633   gchar *literal_message;
 634
 635   g_return_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation));
 636   g_return_if_fail (format != NULL);
 637
 638   literal_message = g_strdup_vprintf (format, var_args);
 639   g_dbus_method_invocation_return_error_literal (invocation,
 640                                                  domain,
 641                                                  code,
 642                                                  literal_message);
 643   g_free (literal_message);
 644 }
 645
 646 /**
 647  * g_dbus_method_invocation_return_error_literal:
 648  * @invocation: (transfer full): A #GDBusMethodInvocation.
 649  * @domain: A #GQuark for the #GError error domain.
 650  * @code: The error code.
 651  * @message: The error message.
 652  *
 653  * Like g_dbus_method_invocation_return_error() but without printf()-style formatting.
 654  *
 655  * This method will free @invocation, you cannot use it afterwards.
 656  *
 657  * Since: 2.26
 658  */
 659 void
 660 g_dbus_method_invocation_return_error_literal (GDBusMethodInvocation *invocation,
 661                                                GQuark                 domain,
 662                                                gint                   code,
 663                                                const gchar           *message)
 664 {
 665   GError *error;
 666
 667   g_return_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation));
 668   g_return_if_fail (message != NULL);
 669
 670   error = g_error_new_literal (domain, code, message);
 671   g_dbus_method_invocation_return_gerror (invocation, error);
 672   g_error_free (error);
 673 }
 674
 675 /**
 676  * g_dbus_method_invocation_return_gerror:
 677  * @invocation: (transfer full): A #GDBusMethodInvocation.
 678  * @error: A #GError.
 679  *
 680  * Like g_dbus_method_invocation_return_error() but takes a #GError
 681  * instead of the error domain, error code and message.
 682  *
 683  * This method will free @invocation, you cannot use it afterwards.
 684  *
 685  * Since: 2.26
 686  */
 687 void
 688 g_dbus_method_invocation_return_gerror (GDBusMethodInvocation *invocation,
 689                                         const GError          *error)
 690 {
 691   gchar *dbus_error_name;
 692
 693   g_return_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation));
 694   g_return_if_fail (error != NULL);
 695
 696   dbus_error_name = g_dbus_error_encode_gerror (error);
 697
 698   g_dbus_method_invocation_return_dbus_error (invocation,
 699                                               dbus_error_name,
 700                                               error->message);
 701   g_free (dbus_error_name);
 702 }
 703
 704 /**
 705  * g_dbus_method_invocation_take_error: (skip)
 706  * @invocation: (transfer full): A #GDBusMethodInvocation.
 707  * @error: (transfer full): A #GError.
 708  *
 709  * Like g_dbus_method_invocation_return_gerror() but takes ownership
 710  * of @error so the caller does not need to free it.
 711  *
 712  * This method will free @invocation, you cannot use it afterwards.
 713  *
 714  * Since: 2.30
 715  */
 716 void
 717 g_dbus_method_invocation_take_error (GDBusMethodInvocation *invocation,
 718                                      GError                *error)
 719 {
 720   g_return_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation));
 721   g_return_if_fail (error != NULL);
 722   g_dbus_method_invocation_return_gerror (invocation, error);
 723   g_error_free (error);
 724 }
 725
 726 /**
 727  * g_dbus_method_invocation_return_dbus_error:
 728  * @invocation: (transfer full): A #GDBusMethodInvocation.
 729  * @error_name: A valid D-Bus error name.
 730  * @error_message: A valid D-Bus error message.
 731  *
 732  * Finishes handling a D-Bus method call by returning an error.
 733  *
 734  * This method will free @invocation, you cannot use it afterwards.
 735  *
 736  * Since: 2.26
 737  */
 738 void
 739 g_dbus_method_invocation_return_dbus_error (GDBusMethodInvocation *invocation,
 740                                             const gchar           *error_name,
 741                                             const gchar           *error_message)
 742 {
 743   GDBusMessage *reply;
 744
 745   g_return_if_fail (G_IS_DBUS_METHOD_INVOCATION (invocation));
 746   g_return_if_fail (error_name != NULL && g_dbus_is_name (error_name));
 747   g_return_if_fail (error_message != NULL);
 748
 749   if (G_UNLIKELY (_g_dbus_debug_return ()))
 750     {
 751       _g_dbus_debug_print_lock ();
 752       g_print ("========================================================================\n"
 753                "GDBus-debug:Return:\n"
 754                " >>>> METHOD ERROR %s\n"
 755                "      message '%s'\n"
 756                "      in response to %s.%s()\n"
 757                "      on object %s\n"
 758                "      to name %s\n"
 759                "      reply-serial %d\n",
 760                error_name,
 761                error_message,
 762                invocation->interface_name, invocation->method_name,
 763                invocation->object_path,
 764                invocation->sender,
 765                g_dbus_message_get_serial (invocation->message));
 766       _g_dbus_debug_print_unlock ();
 767     }
 768
 769   reply = g_dbus_message_new_method_error_literal (invocation->message,
 770                                                    error_name,
 771                                                    error_message);
 772   g_dbus_connection_send_message (g_dbus_method_invocation_get_connection (invocation), reply, G_DBUS_SEND_MESSAGE_FLAGS_NONE, NULL, NULL);
 773   g_object_unref (reply);
 774
 775   g_object_unref (invocation);
 776 }