Merge tag 'upstream/2.34.0' into tizen
[platform/upstream/at-spi2-core.git] / atspi / atspi-misc.c
index 193257b..a7efb66 100644 (file)
@@ -7,19 +7,19 @@
  * Copyright 2010, 2011 Novell, Inc.
  *
  * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
+ * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
- * version 2 of the License, or (at your option) any later version.
+ * version 2.1 of the License, or (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * Library General Public License for more details.
+ * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU Library General Public
+ * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
  */
 
 /*
@@ -136,7 +136,7 @@ static void
 cleanup ()
 {
   GHashTable *refs;
-  GList *l;
+  gint i;
 
   refs = live_refs;
   live_refs = NULL;
@@ -154,14 +154,16 @@ cleanup ()
 
   if (!desktop)
     return;
-  for (l = desktop->children; l;)
+
+  /* TODO: Do we need this code, or should we just dispose the desktop? */
+  for (i = desktop->children->len - 1; i >= 0; i--)
   {
-    GList *next = l->next;
-    AtspiAccessible *child = l->data;
-    g_object_run_dispose (G_OBJECT (child->parent.app));
+    AtspiAccessible *child = g_ptr_array_index (desktop->children, i);
+    if (child->parent.app)
+      g_object_run_dispose (G_OBJECT (child->parent.app));
     g_object_run_dispose (G_OBJECT (child));
-    l = next;
   }
+
   g_object_run_dispose (G_OBJECT (desktop->parent.app));
   g_object_unref (desktop);
   desktop = NULL;
@@ -179,6 +181,7 @@ handle_get_bus_address (DBusPendingCall *pending, void *user_data)
   DBusMessage *message;
   const char *address;
   DBusPendingCall *new_pending;
+  dbus_bool_t result;
 
   if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_METHOD_RETURN)
   {
@@ -197,10 +200,12 @@ handle_get_bus_address (DBusPendingCall *pending, void *user_data)
             dbus_connection_unref (app->bus);
           }
         app->bus = bus;
+        atspi_dbus_connection_setup_with_g_main(bus, g_main_context_default());
       }
       else
       {
-        g_warning ("Unable to open bus connection: %s", error.message);
+        if (!strcmp (error.name, DBUS_ERROR_FILE_NOT_FOUND))
+          g_warning ("AT-SPI: Unable to open bus connection: %s", error.message);
         dbus_error_free (&error);
       }
     }
@@ -215,9 +220,9 @@ handle_get_bus_address (DBusPendingCall *pending, void *user_data)
                                           "/org/a11y/atspi/cache",
                                           atspi_interface_cache, "GetItems");
 
-  dbus_connection_send_with_reply (app->bus, message, &new_pending, 2000);
+  result = dbus_connection_send_with_reply (app->bus, message, &new_pending, 2000);
   dbus_message_unref (message);
-  if (!new_pending)
+  if (!result || !new_pending)
     return;
   dbus_pending_call_set_notify (new_pending, handle_get_items, app, NULL);
 }
@@ -229,6 +234,7 @@ get_application (const char *bus_name)
   char *bus_name_dup;
   DBusMessage *message;
   DBusPendingCall *pending = NULL;
+  dbus_bool_t result;
 
   if (!app_hash)
   {
@@ -249,9 +255,9 @@ get_application (const char *bus_name)
   message = dbus_message_new_method_call (bus_name, atspi_path_root,
                                           atspi_interface_application, "GetApplicationBusAddress");
 
-  dbus_connection_send_with_reply (app->bus, message, &pending, 2000);
+  result = dbus_connection_send_with_reply (app->bus, message, &pending, 2000);
   dbus_message_unref (message);
-  if (!pending)
+  if (!result || !pending)
   {
     g_hash_table_remove (app_hash, bus_name_dup);
     return NULL;
@@ -260,7 +266,7 @@ get_application (const char *bus_name)
   return app;
 }
 
-static AtspiAccessible *
+AtspiAccessible *
 ref_accessible (const char *app_name, const char *path)
 {
   AtspiApplication *app;
@@ -277,7 +283,7 @@ ref_accessible (const char *app_name, const char *path)
     {
       app->root = _atspi_accessible_new (app, atspi_path_root);
       app->root->accessible_parent = atspi_get_desktop (0);
-      app->root->accessible_parent->children = g_list_append (app->root->accessible_parent->children, g_object_ref (app->root));
+      g_ptr_array_add (app->root->accessible_parent->children, g_object_ref (app->root));
     }
     return g_object_ref (app->root);
   }
@@ -423,6 +429,8 @@ add_accessible_from_iter (DBusMessageIter *iter)
   AtspiAccessible *accessible;
   const char *name, *description;
   dbus_uint32_t role;
+  gboolean children_cached = FALSE;
+  dbus_int32_t count, index;
 
   dbus_message_iter_recurse (iter, &iter_struct);
 
@@ -441,19 +449,40 @@ add_accessible_from_iter (DBusMessageIter *iter)
     g_object_unref (accessible->accessible_parent);
   accessible->accessible_parent = ref_accessible (app_name, path);
 
-  /* Get children */
-  while (accessible->children)
+  if (dbus_message_iter_get_arg_type (&iter_struct) == 'i')
   {
-    g_object_unref (accessible->children->data);
-    accessible->children = g_list_remove (accessible->children, accessible->children->data);
+    /* Get index in parent */
+    dbus_message_iter_get_basic (&iter_struct, &index);
+    if (index >= 0 && accessible->accessible_parent)
+    {
+      if (index >= accessible->accessible_parent->children->len)
+        g_ptr_array_set_size (accessible->accessible_parent->children, index + 1);
+      g_ptr_array_index (accessible->accessible_parent->children, index) = g_object_ref (accessible);
+    }
+
+    /* get child count */
+    dbus_message_iter_next (&iter_struct);
+    dbus_message_iter_get_basic (&iter_struct, &count);
+    if (count >= 0)
+    {
+      g_ptr_array_set_size (accessible->children, count);
+      children_cached = TRUE;
+    }
   }
-  dbus_message_iter_recurse (&iter_struct, &iter_array);
-  while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
+  else if (dbus_message_iter_get_arg_type (&iter_struct) == 'a')
   {
-    AtspiAccessible *child;
-    get_reference_from_iter (&iter_array, &app_name, &path);
-    child = ref_accessible (app_name, path);
-    accessible->children = g_list_append (accessible->children, child);
+    /* It's the old API with a list of children */
+    /* TODO: Perhaps remove this code eventually */
+    dbus_message_iter_recurse (&iter_struct, &iter_array);
+    while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
+    {
+      AtspiAccessible *child;
+      get_reference_from_iter (&iter_array, &app_name, &path);
+      child = ref_accessible (app_name, path);
+      g_ptr_array_remove (accessible->children, child);
+      g_ptr_array_add (accessible->children, child);
+    }
+    children_cached = TRUE;
   }
 
   /* interfaces */
@@ -486,7 +515,8 @@ add_accessible_from_iter (DBusMessageIter *iter)
   _atspi_accessible_add_cache (accessible, ATSPI_CACHE_NAME | ATSPI_CACHE_ROLE |
                                ATSPI_CACHE_PARENT | ATSPI_CACHE_DESCRIPTION);
   if (!atspi_state_set_contains (accessible->states,
-                                       ATSPI_STATE_MANAGES_DESCENDANTS))
+                                       ATSPI_STATE_MANAGES_DESCENDANTS) &&
+                                       children_cached)
     _atspi_accessible_add_cache (accessible, ATSPI_CACHE_CHILDREN);
 
   /* This is a bit of a hack since the cache holds a ref, so we don't need
@@ -504,9 +534,17 @@ handle_get_items (DBusPendingCall *pending, void *user_data)
   {
     const char *sender = dbus_message_get_sender (reply);
     const char *error = NULL;
-    dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &error,
-                           DBUS_TYPE_INVALID);
-    g_warning ("AT-SPI: Error in GetItems, sender=%s, error=%s", sender, error);
+    const char *error_name = dbus_message_get_error_name (reply);
+    if (!strcmp (error_name, DBUS_ERROR_SERVICE_UNKNOWN)
+     || !strcmp (error_name, DBUS_ERROR_NO_REPLY))
+    {
+    }
+    else
+    {
+      dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &error,
+                             DBUS_TYPE_INVALID);
+      g_warning ("AT-SPI: Error in GetItems, sender=%s, error=%s", sender, error);
+    }
     dbus_message_unref (reply);
     dbus_pending_call_unref (pending);
     return;
@@ -573,13 +611,14 @@ ref_accessible_desktop (AtspiApplication *app)
     get_reference_from_iter (&iter_array, &app_name, &path);
     add_app_to_desktop (desktop, app_name);
   }
-  dbus_message_unref (reply);
 
   /* Record the alternate name as an alias for org.a11y.atspi.Registry */
   bus_name_dup = g_strdup (dbus_message_get_sender (reply));
   if (bus_name_dup)
     g_hash_table_insert (app_hash, bus_name_dup, app);
 
+  dbus_message_unref (reply);
+
   return g_object_ref (desktop);
 }
 
@@ -664,17 +703,19 @@ _atspi_dbus_return_hyperlink_from_iter (DBusMessageIter *iter)
   return ref_hyperlink (app_name, path);
 }
 
-const char *cache_signal_type = "((so)(so)(so)a(so)assusau)";
+const char *cache_signal_type = "((so)(so)(so)iiassusau)";
+const char *old_cache_signal_type = "((so)(so)(so)a(so)assusau)";
 
 static DBusHandlerResult
 handle_add_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
 {
   DBusMessageIter iter;
+  const char *signature = dbus_message_get_signature (message);
 
-  if (strcmp (dbus_message_get_signature (message), cache_signal_type) != 0)
+  if (strcmp (signature, cache_signal_type) != 0 &&
+      strcmp (signature, old_cache_signal_type) != 0)
   {
-    g_warning ("AT-SPI: AddAccessible with unknown signature %s\n",
-               dbus_message_get_signature (message));
+    g_warning ("AT-SPI: AddAccessible with unknown signature %s\n", signature);
     return DBUS_HANDLER_RESULT_HANDLED;
   }
 
@@ -870,7 +911,8 @@ atspi_init (void)
   bus = atspi_get_a11y_bus ();
   if (!bus)
     return 2;
-  dbus_bus_register (bus, NULL);
+  if (!dbus_bus_register (bus, NULL))
+    return 2;
   atspi_dbus_connection_setup_with_g_main(bus, g_main_context_default());
   dbus_connection_add_filter (bus, atspi_dbus_filter, NULL, NULL);
   match = g_strdup_printf ("type='signal',interface='%s',member='AddAccessible'", atspi_interface_cache);
@@ -983,7 +1025,6 @@ static GSList *hung_processes;
 static void
 remove_hung_process (DBusPendingCall *pending, void *data)
 {
-
   hung_processes = g_slist_remove (hung_processes, data);
   g_free (data);
   dbus_pending_call_unref (pending);
@@ -999,6 +1040,7 @@ check_for_hang (DBusMessage *message, DBusError *error, DBusConnection *bus, con
     DBusMessage *message;
     gchar *bus_name_dup;
     DBusPendingCall *pending = NULL;
+    dbus_bool_t result;
     for (l = hung_processes; l; l = l->next)
       if (!strcmp (l->data, bus_name))
         return;
@@ -1007,9 +1049,9 @@ check_for_hang (DBusMessage *message, DBusError *error, DBusConnection *bus, con
                                             "Ping");
     if (!message)
       return;
-    dbus_connection_send_with_reply (bus, message, &pending, -1);
+    result = dbus_connection_send_with_reply (bus, message, &pending, -1);
     dbus_message_unref (message);
-    if (!pending)
+    if (!result || !pending)
       return;
     bus_name_dup = g_strdup (bus_name);
     hung_processes = g_slist_append (hung_processes, bus_name_dup);
@@ -1106,9 +1148,11 @@ _atspi_dbus_call_partial (gpointer obj,
                           const char *type, ...)
 {
   va_list args;
-
+  DBusMessage * result;
   va_start (args, type);
-  return _atspi_dbus_call_partial_va (obj, interface, method, error, type, args);
+  result =  _atspi_dbus_call_partial_va (obj, interface, method, error, type, args);
+  va_end (args);
+  return result;
 }
 
 
@@ -1149,11 +1193,13 @@ out:
   process_deferred_messages ();
   if (dbus_error_is_set (&err))
   {
-    /* TODO: Set gerror */
+    g_set_error_literal(error, ATSPI_ERROR, ATSPI_ERROR_IPC, err.message);
     dbus_error_free (&err);
+    if (reply)
+      dbus_message_unref(reply);
+    return NULL;
   }
-
-  if (reply && dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
+  else if (reply && dbus_message_get_type(reply) == DBUS_MESSAGE_TYPE_ERROR)
   {
     const char *err_str = NULL;
     dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &err_str, DBUS_TYPE_INVALID);
@@ -1162,7 +1208,6 @@ out:
     dbus_message_unref (reply);
     return NULL;
   }
-
   return reply;
 }
 
@@ -1222,7 +1267,7 @@ _atspi_dbus_get_property (gpointer obj, const char *interface, const char *name,
   dbus_message_iter_init (reply, &iter);
   if (dbus_message_iter_get_arg_type (&iter) != 'v')
   {
-    g_warning ("AT-SPI: expected a variant when fetching %s from interface %s; got %s\n", name, interface, dbus_message_get_signature (reply));
+    g_warning ("atspi_dbus_get_property: expected a variant when fetching %s from interface %s; got %s\n", name, interface, dbus_message_get_signature (reply));
     goto done;
   }
   dbus_message_iter_recurse (&iter, &iter_variant);
@@ -1494,7 +1539,7 @@ get_accessibility_bus_address_dbus (void)
 
   if (!reply)
   {
-    g_warning ("Error retrieving accessibility bus address: %s: %s",
+    g_warning ("AT-SPI: Error retrieving accessibility bus address: %s: %s",
                error.name, error.message);
     dbus_error_free (&error);
     goto out;
@@ -1514,7 +1559,7 @@ get_accessibility_bus_address_dbus (void)
     address = g_strdup (tmp_address);
     dbus_message_unref (reply);
   }
-
+  
 out:
   dbus_connection_unref (session_bus);
   return address;
@@ -1541,16 +1586,22 @@ atspi_get_a11y_bus (void)
 {
   DBusError error;
   char *address = NULL;
+  const char *address_env = NULL;
 
   if (a11y_bus && dbus_connection_get_is_connected (a11y_bus))
     return a11y_bus;
 
   if (a11y_dbus_slot == -1)
     if (!dbus_connection_allocate_data_slot (&a11y_dbus_slot))
-      g_warning ("at-spi: Unable to allocate D-Bus slot");
+      g_warning ("AT-SPI: Unable to allocate D-Bus slot");
 
+  address_env = g_getenv ("AT_SPI_BUS_ADDRESS");
+  if (address_env != NULL && *address_env != 0)
+    address = g_strdup (address_env);
 #ifdef HAVE_X11
-  address = get_accessibility_bus_address_x11 ();
+  if (!address && g_getenv ("DISPLAY") != NULL &&
+      g_getenv ("WAYLAND_DISPLAY") == NULL)
+    address = get_accessibility_bus_address_x11 ();
 #endif
   if (!address)
     address = get_accessibility_bus_address_dbus ();
@@ -1563,7 +1614,8 @@ atspi_get_a11y_bus (void)
 
   if (!a11y_bus)
     {
-      g_warning ("Couldn't connect to accessibility bus: %s", error.message);
+      if (!g_getenv("SSH_CONNECTION"))
+        g_warning ("Couldn't connect to accessibility bus: %s", error.message);
       dbus_error_free (&error);
       return NULL;
     }
@@ -1641,6 +1693,17 @@ atspi_set_main_context (GMainContext *cnx)
   }
   atspi_main_context = cnx;
   atspi_dbus_connection_setup_with_g_main (atspi_get_a11y_bus (), cnx);
+
+  if (desktop)
+  {
+    gint i;
+    for (i = desktop->children->len - 1; i >= 0; i--)
+    {
+      AtspiAccessible *child = g_ptr_array_index (desktop->children, i);
+      if (child->parent.app && child->parent.app->bus)
+        atspi_dbus_connection_setup_with_g_main (child->parent.app->bus, cnx);
+    }
+  }
 }
 
 #ifdef DEBUG_REF_COUNTS
@@ -1796,3 +1859,50 @@ _atspi_set_error_no_sync (GError **error)
   g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_SYNC_NOT_ALLOWED,
                         _("Attempted synchronous call where prohibited"));
 }
+
+static const char *sr_introspection = "<!DOCTYPE node PUBLIC \"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN\"\n"
+"\"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd\">\n"
+"<node name=\"/org/a11y/atspi/screenreader\">\n"
+"  <interface name=\"org.a11y.Atspi.ScreenReader\">\n"
+"    <signal name=\"ReadingPosition\">\n"
+"      <arg type=\"i\"/>\n"
+"      <arg type=\"i\"/>\n"
+"    </signal>\n"
+"  </interface>\n"
+"</node>";
+
+static DBusHandlerResult
+screen_reader_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
+{
+  if (dbus_message_is_method_call (message, DBUS_INTERFACE_INTROSPECTABLE,
+      "Introspect"))
+  {
+    DBusMessage *reply = dbus_message_new_method_return (message);
+    dbus_message_append_args (reply, DBUS_TYPE_STRING, &sr_introspection,
+                              DBUS_TYPE_INVALID);
+    dbus_connection_send (bus, reply, NULL);
+    dbus_message_unref (reply);
+    return DBUS_HANDLER_RESULT_HANDLED;
+  }
+  return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
+}
+
+gboolean
+_atspi_prepare_screen_reader_interface ()
+{
+  static gint initialized = 0;
+  DBusConnection *a11y_bus = _atspi_bus ();
+
+  if (initialized)
+    return (initialized > 0);
+
+  if (dbus_bus_request_name (a11y_bus, "org.a11y.Atspi.ScreenReader", 0, NULL) < 0)
+  {
+    initialized = -1;
+    return FALSE;
+  }
+
+  initialized = 1;
+  dbus_connection_add_filter (a11y_bus, screen_reader_filter, NULL, NULL);
+  return TRUE;
+}