dbind/dbind.c

   1 /*
   2  * Copyright 2008-2011 Novell, Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #include <stdio.h>
  21 #include <stdarg.h>
  22 #include <sys/time.h>
  23 #include <string.h>
  24 #include <glib.h>
  25
  26 #include "config.h"
  27 #include "dbind/dbind.h"
  28 #include "atspi/atspi-gmain.h"
  29
  30 static int dbind_timeout = -1;
  31
  32 /*
  33  * FIXME: compare types - to ensure they match &
  34  *        do dynamic padding of structures etc.
  35  */
  36
  37 /*---------------------------------------------------------------------------*/
  38
  39 typedef struct _SpiReentrantCallClosure
  40 {
  41   DBusMessage *reply;
  42 } SpiReentrantCallClosure;
  43
  44 static void
  45 set_reply (DBusPendingCall * pending, void *user_data)
  46 {
  47   SpiReentrantCallClosure* closure = (SpiReentrantCallClosure *) user_data;
  48
  49   closure->reply = dbus_pending_call_steal_reply (pending);
  50   dbus_pending_call_unref (pending);
  51 }
  52
  53 static gint
  54 time_elapsed (struct timeval *origin)
  55 {
  56   struct timeval tv;
  57
  58   gettimeofday (&tv, NULL);
  59   return (tv.tv_sec - origin->tv_sec) * 1000 + (tv.tv_usec - origin->tv_usec) / 1000;
  60 }
  61
  62 DBusMessage *
  63 dbind_send_and_allow_reentry (DBusConnection * bus, DBusMessage * message, DBusError *error)
  64 {
  65   DBusPendingCall *pending;
  66   SpiReentrantCallClosure *closure;
  67   const char *unique_name = dbus_bus_get_unique_name (bus);
  68   const char *destination = dbus_message_get_destination (message);
  69   struct timeval tv;
  70   DBusMessage *ret;
  71
  72   if (unique_name && destination &&
  73       strcmp (destination, unique_name) != 0)
  74     return dbus_connection_send_with_reply_and_block (bus, message, dbind_timeout, error);
  75
  76   closure = g_new0 (SpiReentrantCallClosure, 1);
  77   closure->reply = NULL;
  78   atspi_dbus_connection_setup_with_g_main(bus, NULL);
  79   if (!dbus_connection_send_with_reply (bus, message, &pending, dbind_timeout))
  80       return NULL;
  81   if (!pending)
  82     return NULL;
  83   dbus_pending_call_set_notify (pending, set_reply, (void *) closure, g_free);
  84
  85   closure->reply = NULL;
  86   gettimeofday (&tv, NULL);
  87   dbus_pending_call_ref (pending);
  88   while (!closure->reply)
  89     {
  90       if (!dbus_connection_read_write_dispatch (bus, dbind_timeout))
  91         {
  92           dbus_pending_call_unref (pending);
  93           return NULL;
  94         }
  95       if (time_elapsed (&tv) > dbind_timeout)
  96         {
  97           dbus_pending_call_unref (pending);
  98           dbus_set_error_const (error, "org.freedesktop.DBus.Error.NoReply",
  99                                 "timeout from dbind");
 100           return NULL;
 101         }
 102     }
 103
 104   ret = closure->reply;
 105   dbus_pending_call_unref (pending);
 106   return ret;
 107 }
 108
 109 dbus_bool_t
 110 dbind_method_call_reentrant_va (DBusConnection *cnx,
 111                                 const char     *bus_name,
 112                                 const char     *path,
 113                                 const char     *interface,
 114                                 const char     *method,
 115                                 DBusError      *opt_error,
 116                                 const char     *arg_types,
 117                                 va_list         args)
 118 {
 119     dbus_bool_t success = FALSE;
 120     DBusMessage *msg = NULL, *reply = NULL;
 121     DBusMessageIter iter;
 122     DBusError *err, real_err;
 123     const char *p;
 124   va_list args_demarshal;
 125
 126   va_copy (args_demarshal, args);
 127     if (opt_error)
 128         err = opt_error;
 129     else {
 130         dbus_error_init (&real_err);
 131         err = &real_err;
 132     }
 133
 134     msg = dbus_message_new_method_call (bus_name, path, interface, method);
 135     if (!msg)
 136         goto out;
 137
 138     p = arg_types;
 139     dbus_message_iter_init_append (msg, &iter);
 140     dbind_any_marshal_va (&iter, &p, args);
 141
 142     reply = dbind_send_and_allow_reentry (cnx, msg, err);
 143     if (!reply)
 144         goto out;
 145
 146     if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
 147     {
 148       const char *name = dbus_message_get_error_name (reply);
 149       goto out;
 150     }
 151     /* demarshal */
 152     if (p[0] == '=' && p[1] == '>')
 153     {
 154         DBusMessageIter iter;
 155         dbus_message_iter_init (reply, &iter);
 156         if (strcmp (p + 2, dbus_message_get_signature (reply)) != 0)
 157         {
 158             g_warning ("dbind: Call to \"%s\" returned signature %s; expected %s",
 159                        method, dbus_message_get_signature (reply), p + 2);
 160             if (opt_error)
 161                 dbus_set_error (opt_error, DBUS_ERROR_INVALID_ARGS,
 162                                 "Call to \"%s\" returned signature %s; expected %s",
 163                                 method, dbus_message_get_signature (reply),
 164                                 p + 2);
 165             goto out;
 166         }
 167         p = arg_types;
 168         dbind_any_demarshal_va (&iter, &p, args_demarshal);
 169     }
 170
 171     success = TRUE;
 172 out:
 173     if (msg)
 174         dbus_message_unref (msg);
 175
 176     if (reply)
 177         dbus_message_unref (reply);
 178
 179     if (err == &real_err)
 180         dbus_error_free (err);
 181
 182     va_end (args_demarshal);
 183     return success;
 184 }
 185
 186 /**
 187  * dbind_method_call_reentrant:
 188  *
 189  * @cnx:       A D-Bus Connection used to make the method call.
 190  * @bus_name:  The D-Bus bus name of the program where the method call should
 191  *             be made.
 192  * @path:      The D-Bus object path that should handle the method.
 193  * @interface: The D-Bus interface used to scope the method name.
 194  * @method:    Method to be invoked.
 195  * @opt_error: D-Bus error.
 196  * @arg_types: Variable length arguments interleaving D-Bus argument types
 197  *             and pointers to argument data.
 198  *
 199  * Makes a D-Bus method call using the supplied location data, method name and
 200  * argument data.This function is re-entrant. It continuously reads from the D-Bus
 201  * bus and dispatches messages until a reply has been recieved.
 202  **/
 203 dbus_bool_t
 204 dbind_method_call_reentrant (DBusConnection *cnx,
 205                              const char     *bus_name,
 206                              const char     *path,
 207                              const char     *interface,
 208                              const char     *method,
 209                              DBusError      *opt_error,
 210                              const char     *arg_types,
 211                              ...)
 212 {
 213     dbus_bool_t success = FALSE;
 214     va_list args;
 215
 216     va_start (args, arg_types);
 217     success = dbind_method_call_reentrant_va (cnx,
 218                                               bus_name,
 219                                               path,
 220                                               interface,
 221                                               method,
 222                                               opt_error,
 223                                               arg_types,
 224                                               args);
 225     va_end (args);
 226
 227     return success;
 228 }
 229
 230 /*---------------------------------------------------------------------------*/
 231
 232 dbus_bool_t
 233 dbind_emit_signal_va (DBusConnection *cnx,
 234                       const char     *path,
 235                       const char     *interface,
 236                       const char     *signal,
 237                       DBusError      *opt_error,
 238                       const char     *arg_types,
 239                       va_list         args)
 240 {
 241     dbus_bool_t success = FALSE;
 242     DBusMessage *msg = NULL;
 243     DBusMessageIter iter;
 244     DBusError *err, real_err;
 245     const char *p;
 246
 247     if (opt_error)
 248         err = opt_error;
 249     else {
 250         dbus_error_init (&real_err);
 251         err = &real_err;
 252     }
 253
 254     msg = dbus_message_new_signal (path, interface, signal);
 255     if (!msg)
 256         goto out;
 257
 258     p = arg_types;
 259     dbus_message_iter_init_append (msg, &iter);
 260     dbind_any_marshal_va (&iter, &p, args);
 261
 262     if (!dbus_connection_send (cnx, msg, NULL))
 263        goto out;
 264
 265     success = TRUE;
 266 out:
 267
 268     if (msg)
 269         dbus_message_unref (msg);
 270
 271     if (err == &real_err)
 272         dbus_error_free (err);
 273
 274     return success;
 275 }
 276
 277 /**
 278  * dbind_emit_signal:
 279  *
 280  * @cnx:       A D-Bus Connection used to make the method call.
 281  * @path:      The D-Bus object path that this signal is emitted from.
 282  * @interface: The D-Bus interface used to scope the method name.
 283  * @signal:    Name of signal to emit.
 284  * @opt_error: D-Bus error.
 285  * @arg_types: Variable length arguments interleaving D-Bus argument types
 286  *             and pointers to argument data.
 287  *
 288  * Emits a D-Bus signal  using the supplied signal name and argument data.
 289  **/
 290 dbus_bool_t
 291 dbind_emit_signal (DBusConnection *cnx,
 292                    const char     *path,
 293                    const char     *interface,
 294                    const char     *signal,
 295                    DBusError      *opt_error,
 296                    const char     *arg_types,
 297                    ...)
 298 {
 299     dbus_bool_t success = FALSE;
 300     va_list args;
 301
 302     va_start (args, arg_types);
 303     success = dbind_emit_signal_va (cnx, path, interface, signal, opt_error, arg_types, args);
 304     va_end (args);
 305
 306     return success;
 307 }
 308 void
 309 dbind_set_timeout (int timeout)
 310 {
 311   dbind_timeout = timeout;
 312 }
 313
 314
 315 /*END------------------------------------------------------------------------*/