dbus/dbus-object-tree.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-object-tree.c  DBusObjectTree (internals of DBusConnection)
   3  *
   4  * Copyright (C) 2003  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.1
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23 #include "dbus-object-tree.h"
  24 #include "dbus-connection-internal.h"
  25 #include "dbus-internals.h"
  26 #include "dbus-hash.h"
  27 #include "dbus-protocol.h"
  28 #include "dbus-string.h"
  29 #include <string.h>
  30 #include <stdlib.h>
  31
  32 /**
  33  * @defgroup DBusObjectTree A hierarchy of objects with container-contained relationship
  34  * @ingroup  DBusInternals
  35  * @brief DBusObjectTree is used by DBusConnection to track the object tree
  36  *
  37  * Types and functions related to DBusObjectTree. These
  38  * are all library-internal.
  39  *
  40  * @{
  41  */
  42
  43 /** Subnode of the object hierarchy */
  44 typedef struct DBusObjectSubtree DBusObjectSubtree;
  45
  46 static DBusObjectSubtree* _dbus_object_subtree_new   (const char                  *name,
  47                                                       const DBusObjectPathVTable  *vtable,
  48                                                       void                        *user_data);
  49 static DBusObjectSubtree* _dbus_object_subtree_ref   (DBusObjectSubtree           *subtree);
  50 static void               _dbus_object_subtree_unref (DBusObjectSubtree           *subtree);
  51
  52 /**
  53  * Internals of DBusObjectTree
  54  */
  55 struct DBusObjectTree
  56 {
  57   int                 refcount;   /**< Reference count */
  58   DBusConnection     *connection; /**< Connection this tree belongs to */
  59
  60   DBusObjectSubtree  *root;       /**< Root of the tree ("/" node) */
  61 };
  62
  63 /**
  64  * Struct representing a single registered subtree handler, or node
  65  * that's a parent of a registered subtree handler. If
  66  * message_function != NULL there's actually a handler at this node.
  67  */
  68 struct DBusObjectSubtree
  69 {
  70   DBusAtomic                         refcount;            /**< Reference count */
  71   DBusObjectSubtree                 *parent;              /**< Parent node */
  72   DBusObjectPathUnregisterFunction   unregister_function; /**< Function to call on unregister */
  73   DBusObjectPathMessageFunction      message_function;    /**< Function to handle messages */
  74   void                              *user_data;           /**< Data for functions */
  75   DBusObjectSubtree                **subtrees;            /**< Child nodes */
  76   int                                n_subtrees;          /**< Number of child nodes */
  77   unsigned int                       subtrees_sorted : 1; /**< Whether children are sorted */
  78   unsigned int                       invoke_as_fallback : 1; /**< Whether to invoke message_function when child nodes don't handle the message */
  79   char                               name[1]; /**< Allocated as large as necessary */
  80 };
  81
  82 /**
  83  * Creates a new object tree, representing a mapping from paths
  84  * to handler vtables.
  85  *
  86  * @param connection the connection this tree belongs to
  87  * @returns the new tree or #NULL if no memory
  88  */
  89 DBusObjectTree*
  90 _dbus_object_tree_new (DBusConnection *connection)
  91 {
  92   DBusObjectTree *tree;
  93
  94   /* the connection passed in here isn't fully constructed,
  95    * so don't do anything more than store a pointer to
  96    * it
  97    */
  98
  99   tree = dbus_new0 (DBusObjectTree, 1);
 100   if (tree == NULL)
 101     goto oom;
 102
 103   tree->refcount = 1;
 104   tree->connection = connection;
 105   tree->root = _dbus_object_subtree_new ("/", NULL, NULL);
 106   if (tree->root == NULL)
 107     goto oom;
 108   tree->root->invoke_as_fallback = TRUE;
 109
 110   return tree;
 111
 112  oom:
 113   if (tree)
 114     {
 115       dbus_free (tree);
 116     }
 117
 118   return NULL;
 119 }
 120
 121 /**
 122  * Increment the reference count
 123  * @param tree the object tree
 124  * @returns the object tree
 125  */
 126 DBusObjectTree *
 127 _dbus_object_tree_ref (DBusObjectTree *tree)
 128 {
 129   _dbus_assert (tree->refcount > 0);
 130
 131   tree->refcount += 1;
 132
 133   return tree;
 134 }
 135
 136 /**
 137  * Decrement the reference count
 138  * @param tree the object tree
 139  */
 140 void
 141 _dbus_object_tree_unref (DBusObjectTree *tree)
 142 {
 143   _dbus_assert (tree->refcount > 0);
 144
 145   tree->refcount -= 1;
 146
 147   if (tree->refcount == 0)
 148     {
 149       _dbus_object_tree_free_all_unlocked (tree);
 150
 151       dbus_free (tree);
 152     }
 153 }
 154
 155 static int
 156 subtree_cmp (DBusObjectSubtree *subtree_a,
 157              DBusObjectSubtree *subtree_b)
 158 {
 159   return strcmp (subtree_a->name, subtree_b->name);
 160 }
 161
 162 static int
 163 subtree_qsort_cmp (const void *a,
 164                    const void *b)
 165 {
 166   DBusObjectSubtree **subtree_a_p = (void*) a;
 167   DBusObjectSubtree **subtree_b_p = (void*) b;
 168
 169   return subtree_cmp (*subtree_a_p, *subtree_b_p);
 170 }
 171
 172 static void
 173 ensure_sorted (DBusObjectSubtree *subtree)
 174 {
 175   if (subtree->subtrees && !subtree->subtrees_sorted)
 176     {
 177       qsort (subtree->subtrees,
 178              subtree->n_subtrees,
 179              sizeof (DBusObjectSubtree*),
 180              subtree_qsort_cmp);
 181       subtree->subtrees_sorted = TRUE;
 182     }
 183 }
 184
 185 /** Set to 1 to get a bunch of debug spew about finding the
 186  * subtree nodes
 187  */
 188 #define VERBOSE_FIND 0
 189
 190 static DBusObjectSubtree*
 191 find_subtree_recurse (DBusObjectSubtree  *subtree,
 192                       const char        **path,
 193                       dbus_bool_t         create_if_not_found,
 194                       int                *index_in_parent,
 195                       dbus_bool_t        *exact_match)
 196 {
 197   int i;
 198   dbus_bool_t return_deepest_match;
 199
 200   return_deepest_match = exact_match != NULL;
 201
 202   _dbus_assert (!(return_deepest_match && create_if_not_found));
 203
 204   if (path[0] == NULL)
 205     {
 206 #if VERBOSE_FIND
 207       _dbus_verbose ("  path exhausted, returning %s\n",
 208                      subtree->name);
 209 #endif
 210       if (exact_match != NULL)
 211         *exact_match = TRUE;
 212       return subtree;
 213     }
 214
 215 #if VERBOSE_FIND
 216   _dbus_verbose ("  searching children of %s for %s\n",
 217                  subtree->name, path[0]);
 218 #endif
 219
 220   ensure_sorted (subtree);
 221
 222   /* FIXME we should do a binary search here instead
 223    * of O(n)
 224    */
 225
 226   i = 0;
 227   while (i < subtree->n_subtrees)
 228     {
 229       int v;
 230
 231       v = strcmp (path[0], subtree->subtrees[i]->name);
 232
 233 #if VERBOSE_FIND
 234       _dbus_verbose ("  %s cmp %s = %d\n",
 235                      path[0], subtree->subtrees[i]->name,
 236                      v);
 237 #endif
 238
 239       if (v == 0)
 240         {
 241           if (index_in_parent)
 242             {
 243 #if VERBOSE_FIND
 244               _dbus_verbose ("  storing parent index %d\n", i);
 245 #endif
 246               *index_in_parent = i;
 247             }
 248
 249           if (return_deepest_match)
 250             {
 251               DBusObjectSubtree *next;
 252
 253               next = find_subtree_recurse (subtree->subtrees[i],
 254                                            &path[1], create_if_not_found,
 255                                            index_in_parent, exact_match);
 256               if (next == NULL &&
 257                   subtree->invoke_as_fallback)
 258                 {
 259 #if VERBOSE_FIND
 260                   _dbus_verbose ("  no deeper match found, returning %s\n",
 261                                  subtree->name);
 262 #endif
 263                   if (exact_match != NULL)
 264                     *exact_match = FALSE;
 265                   return subtree;
 266                 }
 267               else
 268                 return next;
 269             }
 270           else
 271             return find_subtree_recurse (subtree->subtrees[i],
 272                                          &path[1], create_if_not_found,
 273                                          index_in_parent, exact_match);
 274         }
 275       else if (v < 0)
 276         {
 277           goto not_found;
 278         }
 279
 280       ++i;
 281     }
 282
 283  not_found:
 284 #if VERBOSE_FIND
 285   _dbus_verbose ("  no match found, current tree %s, create_if_not_found = %d\n",
 286                  subtree->name, create_if_not_found);
 287 #endif
 288
 289   if (create_if_not_found)
 290     {
 291       DBusObjectSubtree* child;
 292       DBusObjectSubtree **new_subtrees;
 293       int new_n_subtrees;
 294
 295 #if VERBOSE_FIND
 296       _dbus_verbose ("  creating subtree %s\n",
 297                      path[0]);
 298 #endif
 299
 300       child = _dbus_object_subtree_new (path[0],
 301                                         NULL, NULL);
 302       if (child == NULL)
 303         return NULL;
 304
 305       /* FIXME we should do the "double alloc each time" standard thing */
 306       new_n_subtrees = subtree->n_subtrees + 1;
 307       new_subtrees = dbus_realloc (subtree->subtrees,
 308                                    new_n_subtrees * sizeof (DBusObjectSubtree*));
 309       if (new_subtrees == NULL)
 310         {
 311           child->unregister_function = NULL;
 312           child->message_function = NULL;
 313           _dbus_object_subtree_unref (child);
 314           return NULL;
 315         }
 316
 317       new_subtrees[subtree->n_subtrees] = child;
 318       if (index_in_parent)
 319         *index_in_parent = subtree->n_subtrees;
 320       subtree->subtrees_sorted = FALSE;
 321       subtree->n_subtrees = new_n_subtrees;
 322       subtree->subtrees = new_subtrees;
 323
 324       child->parent = subtree;
 325
 326       return find_subtree_recurse (child,
 327                                    &path[1], create_if_not_found,
 328                                    index_in_parent, exact_match);
 329     }
 330   else
 331     {
 332       if (exact_match != NULL)
 333         *exact_match = FALSE;
 334       return (return_deepest_match && subtree->invoke_as_fallback) ? subtree : NULL;
 335     }
 336 }
 337
 338 static DBusObjectSubtree*
 339 find_subtree (DBusObjectTree *tree,
 340               const char    **path,
 341               int            *index_in_parent)
 342 {
 343   DBusObjectSubtree *subtree;
 344
 345 #if VERBOSE_FIND
 346   _dbus_verbose ("Looking for exact registered subtree\n");
 347 #endif
 348
 349   subtree = find_subtree_recurse (tree->root, path, FALSE, index_in_parent, NULL);
 350
 351   if (subtree && subtree->message_function == NULL)
 352     return NULL;
 353   else
 354     return subtree;
 355 }
 356
 357 static DBusObjectSubtree*
 358 lookup_subtree (DBusObjectTree *tree,
 359                 const char    **path)
 360 {
 361 #if VERBOSE_FIND
 362   _dbus_verbose ("Looking for subtree\n");
 363 #endif
 364   return find_subtree_recurse (tree->root, path, FALSE, NULL, NULL);
 365 }
 366
 367 static DBusObjectSubtree*
 368 find_handler (DBusObjectTree *tree,
 369               const char    **path,
 370               dbus_bool_t    *exact_match)
 371 {
 372 #if VERBOSE_FIND
 373   _dbus_verbose ("Looking for deepest handler\n");
 374 #endif
 375   _dbus_assert (exact_match != NULL);
 376   return find_subtree_recurse (tree->root, path, FALSE, NULL, exact_match);
 377 }
 378
 379 static DBusObjectSubtree*
 380 ensure_subtree (DBusObjectTree *tree,
 381                 const char    **path)
 382 {
 383 #if VERBOSE_FIND
 384   _dbus_verbose ("Ensuring subtree\n");
 385 #endif
 386   return find_subtree_recurse (tree->root, path, TRUE, NULL, NULL);
 387 }
 388
 389 /**
 390  * Registers a new subtree in the global object tree.
 391  *
 392  * @param tree the global object tree
 393  * @param fallback #TRUE to handle messages to children of this path
 394  * @param path NULL-terminated array of path elements giving path to subtree
 395  * @param vtable the vtable used to traverse this subtree
 396  * @param user_data user data to pass to methods in the vtable
 397  * @returns #FALSE if not enough memory
 398  */
 399 dbus_bool_t
 400 _dbus_object_tree_register (DBusObjectTree              *tree,
 401                             dbus_bool_t                  fallback,
 402                             const char                 **path,
 403                             const DBusObjectPathVTable  *vtable,
 404                             void                        *user_data)
 405 {
 406   DBusObjectSubtree  *subtree;
 407
 408   _dbus_assert (tree != NULL);
 409   _dbus_assert (vtable->message_function != NULL);
 410   _dbus_assert (path != NULL);
 411
 412   subtree = ensure_subtree (tree, path);
 413   if (subtree == NULL)
 414     return FALSE;
 415
 416 #ifndef DBUS_DISABLE_CHECKS
 417   if (subtree->message_function != NULL)
 418     {
 419       _dbus_warn ("A handler is already registered for the path starting with path[0] = \"%s\"\n",
 420                   path[0] ? path[0] : "null");
 421       return FALSE;
 422     }
 423 #else
 424   _dbus_assert (subtree->message_function == NULL);
 425 #endif
 426
 427   subtree->message_function = vtable->message_function;
 428   subtree->unregister_function = vtable->unregister_function;
 429   subtree->user_data = user_data;
 430   subtree->invoke_as_fallback = fallback != FALSE;
 431
 432   return TRUE;
 433 }
 434
 435 /**
 436  * Unregisters an object subtree that was registered with the
 437  * same path.
 438  *
 439  * @param tree the global object tree
 440  * @param path path to the subtree (same as the one passed to _dbus_object_tree_register())
 441  */
 442 void
 443 _dbus_object_tree_unregister_and_unlock (DBusObjectTree          *tree,
 444                                          const char             **path)
 445 {
 446   int i;
 447   DBusObjectSubtree *subtree;
 448   DBusObjectPathUnregisterFunction unregister_function;
 449   void *user_data;
 450   DBusConnection *connection;
 451
 452   _dbus_assert (path != NULL);
 453
 454   subtree = find_subtree (tree, path, &i);
 455
 456 #ifndef DBUS_DISABLE_CHECKS
 457   if (subtree == NULL)
 458     {
 459       _dbus_warn ("Attempted to unregister path (path[0] = %s path[1] = %s) which isn't registered\n",
 460                   path[0] ? path[0] : "null",
 461                   path[1] ? path[1] : "null");
 462       return;
 463     }
 464 #else
 465   _dbus_assert (subtree != NULL);
 466 #endif
 467
 468   _dbus_assert (subtree->parent == NULL ||
 469                 (i >= 0 && subtree->parent->subtrees[i] == subtree));
 470
 471   subtree->message_function = NULL;
 472
 473   unregister_function = subtree->unregister_function;
 474   user_data = subtree->user_data;
 475
 476   subtree->unregister_function = NULL;
 477   subtree->user_data = NULL;
 478
 479   /* If we have no subtrees of our own, remove from
 480    * our parent (FIXME could also be more aggressive
 481    * and remove our parent if it becomes empty)
 482    */
 483   if (subtree->parent && subtree->n_subtrees == 0)
 484     {
 485       /* assumes a 0-byte memmove is OK */
 486       memmove (&subtree->parent->subtrees[i],
 487                &subtree->parent->subtrees[i+1],
 488                (subtree->parent->n_subtrees - i - 1) *
 489                sizeof (subtree->parent->subtrees[0]));
 490       subtree->parent->n_subtrees -= 1;
 491
 492       subtree->parent = NULL;
 493
 494       _dbus_object_subtree_unref (subtree);
 495     }
 496   subtree = NULL;
 497
 498   connection = tree->connection;
 499
 500   /* Unlock and call application code */
 501 #ifdef DBUS_BUILD_TESTS
 502   if (connection)
 503 #endif
 504     {
 505       _dbus_connection_ref_unlocked (connection);
 506       _dbus_connection_unlock (connection);
 507     }
 508
 509   if (unregister_function)
 510     (* unregister_function) (connection, user_data);
 511
 512 #ifdef DBUS_BUILD_TESTS
 513   if (connection)
 514 #endif
 515     dbus_connection_unref (connection);
 516 }
 517
 518 static void
 519 free_subtree_recurse (DBusConnection    *connection,
 520                       DBusObjectSubtree *subtree)
 521 {
 522   /* Delete them from the end, for slightly
 523    * more robustness against odd reentrancy.
 524    */
 525   while (subtree->n_subtrees > 0)
 526     {
 527       DBusObjectSubtree *child;
 528
 529       child = subtree->subtrees[subtree->n_subtrees - 1];
 530       subtree->subtrees[subtree->n_subtrees - 1] = NULL;
 531       subtree->n_subtrees -= 1;
 532       child->parent = NULL;
 533
 534       free_subtree_recurse (connection, child);
 535     }
 536
 537   /* Call application code */
 538   if (subtree->unregister_function)
 539     (* subtree->unregister_function) (connection,
 540                                       subtree->user_data);
 541
 542   subtree->message_function = NULL;
 543   subtree->unregister_function = NULL;
 544   subtree->user_data = NULL;
 545
 546   /* Now free ourselves */
 547   _dbus_object_subtree_unref (subtree);
 548 }
 549
 550 /**
 551  * Free all the handlers in the tree. Lock on tree's connection
 552  * must not be held.
 553  *
 554  * @param tree the object tree
 555  */
 556 void
 557 _dbus_object_tree_free_all_unlocked (DBusObjectTree *tree)
 558 {
 559   if (tree->root)
 560     free_subtree_recurse (tree->connection,
 561                           tree->root);
 562   tree->root = NULL;
 563 }
 564
 565 static dbus_bool_t
 566 _dbus_object_tree_list_registered_unlocked (DBusObjectTree *tree,
 567                                             const char    **parent_path,
 568                                             char         ***child_entries)
 569 {
 570   DBusObjectSubtree *subtree;
 571   char **retval;
 572
 573   _dbus_assert (parent_path != NULL);
 574   _dbus_assert (child_entries != NULL);
 575
 576   *child_entries = NULL;
 577
 578   subtree = lookup_subtree (tree, parent_path);
 579   if (subtree == NULL)
 580     {
 581       retval = dbus_new0 (char *, 1);
 582     }
 583   else
 584     {
 585       int i;
 586       retval = dbus_new0 (char*, subtree->n_subtrees + 1);
 587       if (retval == NULL)
 588         goto out;
 589       i = 0;
 590       while (i < subtree->n_subtrees)
 591         {
 592           retval[i] = _dbus_strdup (subtree->subtrees[i]->name);
 593           if (retval[i] == NULL)
 594             {
 595               dbus_free_string_array (retval);
 596               retval = NULL;
 597               goto out;
 598             }
 599           ++i;
 600         }
 601     }
 602
 603  out:
 604
 605   *child_entries = retval;
 606   return retval != NULL;
 607 }
 608
 609 static DBusHandlerResult
 610 handle_default_introspect_unlocked (DBusObjectTree          *tree,
 611                                     DBusMessage             *message,
 612                                     const char             **path)
 613 {
 614   DBusString xml;
 615   DBusHandlerResult result;
 616   char **children;
 617   int i;
 618   DBusMessage *reply;
 619   DBusMessageIter iter;
 620   const char *v_STRING;
 621
 622   /* We have the connection lock here */
 623
 624   _dbus_verbose (" considering default Introspect() handler...\n");
 625
 626   reply = NULL;
 627
 628   if (!dbus_message_is_method_call (message,
 629                                     DBUS_INTERFACE_ORG_FREEDESKTOP_INTROSPECTABLE,
 630                                     "Introspect"))
 631     return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 632
 633   _dbus_verbose (" using default Introspect() handler!\n");
 634
 635   if (!_dbus_string_init (&xml))
 636     return DBUS_HANDLER_RESULT_NEED_MEMORY;
 637
 638   result = DBUS_HANDLER_RESULT_NEED_MEMORY;
 639
 640   children = NULL;
 641   if (!_dbus_object_tree_list_registered_unlocked (tree, path, &children))
 642     goto out;
 643
 644   if (!_dbus_string_append (&xml, DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE))
 645     goto out;
 646
 647   if (!_dbus_string_append (&xml, "<node>\n"))
 648     goto out;
 649
 650   i = 0;
 651   while (children[i] != NULL)
 652     {
 653       if (!_dbus_string_append_printf (&xml, "  <node name=\"%s\"/>\n",
 654                                        children[i]))
 655         goto out;
 656
 657       ++i;
 658     }
 659
 660   if (!_dbus_string_append (&xml, "</node>\n"))
 661     goto out;
 662
 663   reply = dbus_message_new_method_return (message);
 664   if (reply == NULL)
 665     goto out;
 666
 667   dbus_message_iter_init_append (reply, &iter);
 668   v_STRING = _dbus_string_get_const_data (&xml);
 669   if (!dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &v_STRING))
 670     goto out;
 671
 672 #ifdef DBUS_BUILD_TESTS
 673   if (tree->connection)
 674 #endif
 675     {
 676       if (!_dbus_connection_send_unlocked (tree->connection, reply, NULL))
 677         goto out;
 678     }
 679
 680   result = DBUS_HANDLER_RESULT_HANDLED;
 681
 682  out:
 683   _dbus_string_free (&xml);
 684   dbus_free_string_array (children);
 685   if (reply)
 686     dbus_message_unref (reply);
 687
 688   return result;
 689 }
 690
 691 /**
 692  * Tries to dispatch a message by directing it to handler for the
 693  * object path listed in the message header, if any. Messages are
 694  * dispatched first to the registered handler that matches the largest
 695  * number of path elements; that is, message to /foo/bar/baz would go
 696  * to the handler for /foo/bar before the one for /foo.
 697  *
 698  * @todo thread problems
 699  *
 700  * @param tree the global object tree
 701  * @param message the message to dispatch
 702  * @returns whether message was handled successfully
 703  */
 704 DBusHandlerResult
 705 _dbus_object_tree_dispatch_and_unlock (DBusObjectTree          *tree,
 706                                        DBusMessage             *message)
 707 {
 708   char **path;
 709   dbus_bool_t exact_match;
 710   DBusList *list;
 711   DBusList *link;
 712   DBusHandlerResult result;
 713   DBusObjectSubtree *subtree;
 714
 715 #if 0
 716   _dbus_verbose ("Dispatch of message by object path\n");
 717 #endif
 718
 719   path = NULL;
 720   if (!dbus_message_get_path_decomposed (message, &path))
 721     {
 722 #ifdef DBUS_BUILD_TESTS
 723       if (tree->connection)
 724 #endif
 725         _dbus_connection_unlock (tree->connection);
 726
 727       _dbus_verbose ("No memory to get decomposed path\n");
 728
 729       return DBUS_HANDLER_RESULT_NEED_MEMORY;
 730     }
 731
 732   if (path == NULL)
 733     {
 734 #ifdef DBUS_BUILD_TESTS
 735       if (tree->connection)
 736 #endif
 737         _dbus_connection_unlock (tree->connection);
 738
 739       _dbus_verbose ("No path field in message\n");
 740       return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 741     }
 742
 743   /* Find the deepest path that covers the path in the message */
 744   subtree = find_handler (tree, (const char**) path, &exact_match);
 745
 746   /* Build a list of all paths that cover the path in the message */
 747
 748   list = NULL;
 749
 750   while (subtree != NULL)
 751     {
 752       if (subtree->message_function != NULL && (exact_match || subtree->invoke_as_fallback))
 753         {
 754           _dbus_object_subtree_ref (subtree);
 755
 756           /* run deepest paths first */
 757           if (!_dbus_list_append (&list, subtree))
 758             {
 759               result = DBUS_HANDLER_RESULT_NEED_MEMORY;
 760               _dbus_object_subtree_unref (subtree);
 761               goto free_and_return;
 762             }
 763         }
 764
 765       exact_match = FALSE;
 766       subtree = subtree->parent;
 767     }
 768
 769   _dbus_verbose ("%d handlers in the path tree for this message\n",
 770                  _dbus_list_get_length (&list));
 771
 772   /* Invoke each handler in the list */
 773
 774   result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 775
 776   link = _dbus_list_get_first_link (&list);
 777   while (link != NULL)
 778     {
 779       DBusList *next = _dbus_list_get_next_link (&list, link);
 780       subtree = link->data;
 781
 782       /* message_function is NULL if we're unregistered
 783        * due to reentrancy
 784        */
 785       if (subtree->message_function)
 786         {
 787           DBusObjectPathMessageFunction message_function;
 788           void *user_data;
 789
 790           message_function = subtree->message_function;
 791           user_data = subtree->user_data;
 792
 793 #if 0
 794           _dbus_verbose ("  (invoking a handler)\n");
 795 #endif
 796
 797 #ifdef DBUS_BUILD_TESTS
 798           if (tree->connection)
 799 #endif
 800             _dbus_connection_unlock (tree->connection);
 801
 802           /* FIXME you could unregister the subtree in another thread
 803            * before we invoke the callback, and I can't figure out a
 804            * good way to solve this.
 805            */
 806
 807           result = (* message_function) (tree->connection,
 808                                          message,
 809                                          user_data);
 810
 811 #ifdef DBUS_BUILD_TESTS
 812           if (tree->connection)
 813 #endif
 814             _dbus_connection_lock (tree->connection);
 815
 816           if (result != DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
 817             goto free_and_return;
 818         }
 819
 820       link = next;
 821     }
 822
 823  free_and_return:
 824
 825   if (result == DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
 826     {
 827       /* This hardcoded default handler does a minimal Introspect()
 828        */
 829       result = handle_default_introspect_unlocked (tree, message,
 830                                                    (const char**) path);
 831     }
 832
 833 #ifdef DBUS_BUILD_TESTS
 834   if (tree->connection)
 835 #endif
 836     _dbus_connection_unlock (tree->connection);
 837
 838   while (list != NULL)
 839     {
 840       link = _dbus_list_get_first_link (&list);
 841       _dbus_object_subtree_unref (link->data);
 842       _dbus_list_remove_link (&list, link);
 843     }
 844
 845   dbus_free_string_array (path);
 846
 847   return result;
 848 }
 849
 850 /**
 851  * Allocates a subtree object.
 852  *
 853  * @param name name to duplicate.
 854  * @returns newly-allocated subtree
 855  */
 856 static DBusObjectSubtree*
 857 allocate_subtree_object (const char *name)
 858 {
 859   int len;
 860   DBusObjectSubtree *subtree;
 861   const size_t front_padding = _DBUS_STRUCT_OFFSET (DBusObjectSubtree, name);
 862
 863   _dbus_assert (name != NULL);
 864
 865   len = strlen (name);
 866
 867   subtree = dbus_malloc (front_padding + (len + 1));
 868
 869   if (subtree == NULL)
 870     return NULL;
 871
 872   memcpy (subtree->name, name, len + 1);
 873
 874   return subtree;
 875 }
 876
 877 static DBusObjectSubtree*
 878 _dbus_object_subtree_new (const char                  *name,
 879                           const DBusObjectPathVTable  *vtable,
 880                           void                        *user_data)
 881 {
 882   DBusObjectSubtree *subtree;
 883
 884   subtree = allocate_subtree_object (name);
 885   if (subtree == NULL)
 886     goto oom;
 887
 888   _dbus_assert (name != NULL);
 889
 890   subtree->parent = NULL;
 891
 892   if (vtable)
 893     {
 894       subtree->message_function = vtable->message_function;
 895       subtree->unregister_function = vtable->unregister_function;
 896     }
 897   else
 898     {
 899       subtree->message_function = NULL;
 900       subtree->unregister_function = NULL;
 901     }
 902
 903   subtree->user_data = user_data;
 904   subtree->refcount.value = 1;
 905   subtree->subtrees = NULL;
 906   subtree->n_subtrees = 0;
 907   subtree->subtrees_sorted = TRUE;
 908   subtree->invoke_as_fallback = FALSE;
 909
 910   return subtree;
 911
 912  oom:
 913   if (subtree)
 914     {
 915       dbus_free (subtree);
 916     }
 917
 918   return NULL;
 919 }
 920
 921 static DBusObjectSubtree *
 922 _dbus_object_subtree_ref (DBusObjectSubtree *subtree)
 923 {
 924   _dbus_assert (subtree->refcount.value > 0);
 925   _dbus_atomic_inc (&subtree->refcount);
 926
 927   return subtree;
 928 }
 929
 930 static void
 931 _dbus_object_subtree_unref (DBusObjectSubtree *subtree)
 932 {
 933   _dbus_assert (subtree->refcount.value > 0);
 934
 935   if (_dbus_atomic_dec (&subtree->refcount) == 1)
 936     {
 937       _dbus_assert (subtree->unregister_function == NULL);
 938       _dbus_assert (subtree->message_function == NULL);
 939
 940       dbus_free (subtree->subtrees);
 941       dbus_free (subtree);
 942     }
 943 }
 944
 945 /**
 946  * Lists the registered fallback handlers and object path handlers at
 947  * the given parent_path. The returned array should be freed with
 948  * dbus_free_string_array().
 949  *
 950  * @param tree the object tree
 951  * @param parent_path the path to list the child handlers of
 952  * @param child_entries returns #NULL-terminated array of children
 953  * @returns #FALSE if no memory to allocate the child entries
 954  */
 955 dbus_bool_t
 956 _dbus_object_tree_list_registered_and_unlock (DBusObjectTree *tree,
 957                                               const char    **parent_path,
 958                                               char         ***child_entries)
 959 {
 960   dbus_bool_t result;
 961
 962   result = _dbus_object_tree_list_registered_unlocked (tree,
 963                                                        parent_path,
 964                                                        child_entries);
 965
 966 #ifdef DBUS_BUILD_TESTS
 967   if (tree->connection)
 968 #endif
 969     _dbus_connection_unlock (tree->connection);
 970
 971   return result;
 972 }
 973
 974
 975 /** Set to 1 to get a bunch of spew about disassembling the path string */
 976 #define VERBOSE_DECOMPOSE 0
 977
 978 /**
 979  * Decompose an object path.  A path of just "/" is
 980  * represented as an empty vector of strings.
 981  * The path need not be nul terminated.
 982  *
 983  * @param data the path data
 984  * @param len  the length of the path string
 985  * @param path address to store new object path
 986  * @param path_len length of stored path
 987  */
 988 dbus_bool_t
 989 _dbus_decompose_path (const char*     data,
 990                       int             len,
 991                       char         ***path,
 992                       int            *path_len)
 993 {
 994   char **retval;
 995   int n_components;
 996   int i, j, comp;
 997
 998   _dbus_assert (data != NULL);
 999
1000 #if VERBOSE_DECOMPOSE
1001   _dbus_verbose ("Decomposing path \"%s\"\n",
1002                  data);
1003 #endif
1004
1005   n_components = 0;
1006   if (len > 1) /* if path is not just "/" */
1007     {
1008       i = 0;
1009       while (i < len)
1010         {
1011           if (data[i] == '/')
1012             n_components += 1;
1013           ++i;
1014         }
1015     }
1016
1017   retval = dbus_new0 (char*, n_components + 1);
1018
1019   if (retval == NULL)
1020     return FALSE;
1021
1022   comp = 0;
1023   if (n_components == 0)
1024     i = 1;
1025   else
1026     i = 0;
1027   while (comp < n_components)
1028     {
1029       _dbus_assert (i < len);
1030
1031       if (data[i] == '/')
1032         ++i;
1033       j = i;
1034
1035       while (j < len && data[j] != '/')
1036         ++j;
1037
1038       /* Now [i, j) is the path component */
1039       _dbus_assert (i < j);
1040       _dbus_assert (data[i] != '/');
1041       _dbus_assert (j == len || data[j] == '/');
1042
1043 #if VERBOSE_DECOMPOSE
1044       _dbus_verbose ("  (component in [%d,%d))\n",
1045                      i, j);
1046 #endif
1047
1048       retval[comp] = _dbus_memdup (&data[i], j - i + 1);
1049       if (retval[comp] == NULL)
1050         {
1051           dbus_free_string_array (retval);
1052           return FALSE;
1053         }
1054       retval[comp][j-i] = '\0';
1055 #if VERBOSE_DECOMPOSE
1056       _dbus_verbose ("  (component %d = \"%s\")\n",
1057                      comp, retval[comp]);
1058 #endif
1059
1060       ++comp;
1061       i = j;
1062     }
1063   _dbus_assert (i == len);
1064
1065   *path = retval;
1066   if (path_len)
1067     *path_len = n_components;
1068
1069   return TRUE;
1070 }
1071
1072 /** @} */
1073
1074 #ifdef DBUS_BUILD_TESTS
1075 #include "dbus-test.h"
1076 #include <stdio.h>
1077
1078 static char*
1079 flatten_path (const char **path)
1080 {
1081   DBusString str;
1082   char *s;
1083
1084   if (!_dbus_string_init (&str))
1085     return NULL;
1086
1087   if (path[0] == NULL)
1088     {
1089       if (!_dbus_string_append_byte (&str, '/'))
1090         goto nomem;
1091     }
1092   else
1093     {
1094       int i;
1095
1096       i = 0;
1097       while (path[i])
1098         {
1099           if (!_dbus_string_append_byte (&str, '/'))
1100             goto nomem;
1101
1102           if (!_dbus_string_append (&str, path[i]))
1103             goto nomem;
1104
1105           ++i;
1106         }
1107     }
1108
1109   if (!_dbus_string_steal_data (&str, &s))
1110     goto nomem;
1111
1112   _dbus_string_free (&str);
1113
1114   return s;
1115
1116  nomem:
1117   _dbus_string_free (&str);
1118   return NULL;
1119 }
1120
1121
1122 typedef enum
1123 {
1124   STR_EQUAL,
1125   STR_PREFIX,
1126   STR_DIFFERENT
1127 } StrComparison;
1128
1129 /* Returns TRUE if container is a parent of child
1130  */
1131 static StrComparison
1132 path_contains (const char **container,
1133                const char **child)
1134 {
1135   int i;
1136
1137   i = 0;
1138   while (child[i] != NULL)
1139     {
1140       int v;
1141
1142       if (container[i] == NULL)
1143         return STR_PREFIX; /* container ran out, child continues;
1144                         * thus the container is a parent of the
1145                         * child.
1146                         */
1147
1148       _dbus_assert (container[i] != NULL);
1149       _dbus_assert (child[i] != NULL);
1150
1151       v = strcmp (container[i], child[i]);
1152
1153       if (v != 0)
1154         return STR_DIFFERENT; /* they overlap until here and then are different,
1155                            * not overlapping
1156                            */
1157
1158       ++i;
1159     }
1160
1161   /* Child ran out; if container also did, they are equal;
1162    * otherwise, the child is a parent of the container.
1163    */
1164   if (container[i] == NULL)
1165     return STR_EQUAL;
1166   else
1167     return STR_DIFFERENT;
1168 }
1169
1170 #if 0
1171 static void
1172 spew_subtree_recurse (DBusObjectSubtree *subtree,
1173                       int                indent)
1174 {
1175   int i;
1176
1177   i = 0;
1178   while (i < indent)
1179     {
1180       _dbus_verbose (" ");
1181       ++i;
1182     }
1183
1184   _dbus_verbose ("%s (%d children)\n",
1185                  subtree->name, subtree->n_subtrees);
1186
1187   i = 0;
1188   while (i < subtree->n_subtrees)
1189     {
1190       spew_subtree_recurse (subtree->subtrees[i], indent + 2);
1191
1192       ++i;
1193     }
1194 }
1195
1196 static void
1197 spew_tree (DBusObjectTree *tree)
1198 {
1199   spew_subtree_recurse (tree->root, 0);
1200 }
1201 #endif
1202
1203 /**
1204  * Callback data used in tests
1205  */
1206 typedef struct
1207 {
1208   const char **path; /**< Path */
1209   dbus_bool_t handler_fallback; /**< true if the handler may be called as fallback */
1210   dbus_bool_t message_handled; /**< Gets set to true if message handler called */
1211   dbus_bool_t handler_unregistered; /**< gets set to true if handler is unregistered */
1212 } TreeTestData;
1213
1214
1215 static void
1216 test_unregister_function (DBusConnection  *connection,
1217                           void            *user_data)
1218 {
1219   TreeTestData *ttd = user_data;
1220
1221   ttd->handler_unregistered = TRUE;
1222 }
1223
1224 static DBusHandlerResult
1225 test_message_function (DBusConnection  *connection,
1226                        DBusMessage     *message,
1227                        void            *user_data)
1228 {
1229   TreeTestData *ttd = user_data;
1230
1231   ttd->message_handled = TRUE;
1232
1233   return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1234 }
1235
1236 static dbus_bool_t
1237 do_register (DBusObjectTree *tree,
1238              const char    **path,
1239              dbus_bool_t     fallback,
1240              int             i,
1241              TreeTestData   *tree_test_data)
1242 {
1243   DBusObjectPathVTable vtable = { test_unregister_function,
1244                                   test_message_function, NULL };
1245
1246   tree_test_data[i].message_handled = FALSE;
1247   tree_test_data[i].handler_unregistered = FALSE;
1248   tree_test_data[i].handler_fallback = fallback;
1249   tree_test_data[i].path = path;
1250
1251   if (!_dbus_object_tree_register (tree, fallback, path,
1252                                    &vtable,
1253                                    &tree_test_data[i]))
1254     return FALSE;
1255
1256   return TRUE;
1257 }
1258
1259 static dbus_bool_t
1260 do_test_dispatch (DBusObjectTree *tree,
1261                   const char    **path,
1262                   int             i,
1263                   TreeTestData   *tree_test_data,
1264                   int             n_test_data)
1265 {
1266   DBusMessage *message;
1267   int j;
1268   DBusHandlerResult result;
1269   char *flat;
1270
1271   message = NULL;
1272
1273   flat = flatten_path (path);
1274   if (flat == NULL)
1275     goto oom;
1276
1277   message = dbus_message_new_method_call (NULL,
1278                                           flat,
1279                                           "org.freedesktop.TestInterface",
1280                                           "Foo");
1281   dbus_free (flat);
1282   if (message == NULL)
1283     goto oom;
1284
1285   j = 0;
1286   while (j < n_test_data)
1287     {
1288       tree_test_data[j].message_handled = FALSE;
1289       ++j;
1290     }
1291
1292   result = _dbus_object_tree_dispatch_and_unlock (tree, message);
1293   if (result == DBUS_HANDLER_RESULT_NEED_MEMORY)
1294     goto oom;
1295
1296   _dbus_assert (tree_test_data[i].message_handled);
1297
1298   j = 0;
1299   while (j < n_test_data)
1300     {
1301       if (tree_test_data[j].message_handled)
1302         {
1303           if (tree_test_data[j].handler_fallback)
1304             _dbus_assert (path_contains (tree_test_data[j].path,
1305                                          path) != STR_DIFFERENT);
1306           else
1307             _dbus_assert (path_contains (tree_test_data[j].path, path) == STR_EQUAL);
1308         }
1309       else
1310         {
1311           if (tree_test_data[j].handler_fallback)
1312             _dbus_assert (path_contains (tree_test_data[j].path,
1313                                          path) == STR_DIFFERENT);
1314           else
1315             _dbus_assert (path_contains (tree_test_data[j].path, path) != STR_EQUAL);
1316         }
1317
1318       ++j;
1319     }
1320
1321   dbus_message_unref (message);
1322
1323   return TRUE;
1324
1325  oom:
1326   if (message)
1327     dbus_message_unref (message);
1328   return FALSE;
1329 }
1330
1331 static size_t
1332 string_array_length (const char **array)
1333 {
1334   size_t i;
1335   for (i = 0; array[i]; i++) ;
1336   return i;
1337 }
1338
1339 typedef struct
1340 {
1341   const char *path;
1342   const char *result[20];
1343 } DecomposePathTest;
1344
1345 static DecomposePathTest decompose_tests[] = {
1346   { "/foo", { "foo", NULL } },
1347   { "/foo/bar", { "foo", "bar", NULL } },
1348   { "/", { NULL } },
1349   { "/a/b", { "a", "b", NULL } },
1350   { "/a/b/c", { "a", "b", "c", NULL } },
1351   { "/a/b/c/d", { "a", "b", "c", "d", NULL } },
1352   { "/foo/bar/q", { "foo", "bar", "q", NULL } },
1353   { "/foo/bar/this/is/longer", { "foo", "bar", "this", "is", "longer", NULL } }
1354 };
1355
1356 static dbus_bool_t
1357 run_decompose_tests (void)
1358 {
1359   int i;
1360
1361   i = 0;
1362   while (i < _DBUS_N_ELEMENTS (decompose_tests))
1363     {
1364       char **result;
1365       int    result_len;
1366       int    expected_len;
1367
1368       if (!_dbus_decompose_path (decompose_tests[i].path,
1369                                  strlen (decompose_tests[i].path),
1370                                  &result, &result_len))
1371         return FALSE;
1372
1373       expected_len = string_array_length (decompose_tests[i].result);
1374
1375       if (result_len != (int) string_array_length ((const char**)result) ||
1376           expected_len != result_len ||
1377           path_contains (decompose_tests[i].result,
1378                          (const char**) result) != STR_EQUAL)
1379         {
1380           int real_len = string_array_length ((const char**)result);
1381           _dbus_warn ("Expected decompose of %s to have len %d, returned %d, appears to have %d\n",
1382                       decompose_tests[i].path, expected_len, result_len,
1383                       real_len);
1384           _dbus_warn ("Decompose resulted in elements: { ");
1385           i = 0;
1386           while (i < real_len)
1387             {
1388               _dbus_warn ("\"%s\"%s", result[i],
1389                           (i + 1) == real_len ? "" : ", ");
1390               ++i;
1391             }
1392           _dbus_warn ("}\n");
1393           _dbus_assert_not_reached ("path decompose failed\n");
1394         }
1395
1396       dbus_free_string_array (result);
1397
1398       ++i;
1399     }
1400
1401   return TRUE;
1402 }
1403
1404 static dbus_bool_t
1405 object_tree_test_iteration (void *data)
1406 {
1407   const char *path0[] = { NULL };
1408   const char *path1[] = { "foo", NULL };
1409   const char *path2[] = { "foo", "bar", NULL };
1410   const char *path3[] = { "foo", "bar", "baz", NULL };
1411   const char *path4[] = { "foo", "bar", "boo", NULL };
1412   const char *path5[] = { "blah", NULL };
1413   const char *path6[] = { "blah", "boof", NULL };
1414   const char *path7[] = { "blah", "boof", "this", "is", "really", "long", NULL };
1415   const char *path8[] = { "childless", NULL };
1416   DBusObjectTree *tree;
1417   TreeTestData tree_test_data[9];
1418   int i;
1419   dbus_bool_t exact_match;
1420
1421   if (!run_decompose_tests ())
1422     return FALSE;
1423
1424   tree = NULL;
1425
1426   tree = _dbus_object_tree_new (NULL);
1427   if (tree == NULL)
1428     goto out;
1429
1430   if (!do_register (tree, path0, TRUE, 0, tree_test_data))
1431     goto out;
1432
1433   _dbus_assert (find_subtree (tree, path0, NULL));
1434   _dbus_assert (!find_subtree (tree, path1, NULL));
1435   _dbus_assert (!find_subtree (tree, path2, NULL));
1436   _dbus_assert (!find_subtree (tree, path3, NULL));
1437   _dbus_assert (!find_subtree (tree, path4, NULL));
1438   _dbus_assert (!find_subtree (tree, path5, NULL));
1439   _dbus_assert (!find_subtree (tree, path6, NULL));
1440   _dbus_assert (!find_subtree (tree, path7, NULL));
1441   _dbus_assert (!find_subtree (tree, path8, NULL));
1442
1443   _dbus_assert (find_handler (tree, path0, &exact_match) && exact_match);
1444   _dbus_assert (find_handler (tree, path1, &exact_match) == tree->root && !exact_match);
1445   _dbus_assert (find_handler (tree, path2, &exact_match) == tree->root && !exact_match);
1446   _dbus_assert (find_handler (tree, path3, &exact_match) == tree->root && !exact_match);
1447   _dbus_assert (find_handler (tree, path4, &exact_match) == tree->root && !exact_match);
1448   _dbus_assert (find_handler (tree, path5, &exact_match) == tree->root && !exact_match);
1449   _dbus_assert (find_handler (tree, path6, &exact_match) == tree->root && !exact_match);
1450   _dbus_assert (find_handler (tree, path7, &exact_match) == tree->root && !exact_match);
1451   _dbus_assert (find_handler (tree, path8, &exact_match) == tree->root && !exact_match);
1452
1453   if (!do_register (tree, path1, TRUE, 1, tree_test_data))
1454     goto out;
1455
1456   _dbus_assert (find_subtree (tree, path0, NULL));
1457   _dbus_assert (find_subtree (tree, path1, NULL));
1458   _dbus_assert (!find_subtree (tree, path2, NULL));
1459   _dbus_assert (!find_subtree (tree, path3, NULL));
1460   _dbus_assert (!find_subtree (tree, path4, NULL));
1461   _dbus_assert (!find_subtree (tree, path5, NULL));
1462   _dbus_assert (!find_subtree (tree, path6, NULL));
1463   _dbus_assert (!find_subtree (tree, path7, NULL));
1464   _dbus_assert (!find_subtree (tree, path8, NULL));
1465
1466   _dbus_assert (find_handler (tree, path0, &exact_match) &&  exact_match);
1467   _dbus_assert (find_handler (tree, path1, &exact_match) &&  exact_match);
1468   _dbus_assert (find_handler (tree, path2, &exact_match) && !exact_match);
1469   _dbus_assert (find_handler (tree, path3, &exact_match) && !exact_match);
1470   _dbus_assert (find_handler (tree, path4, &exact_match) && !exact_match);
1471   _dbus_assert (find_handler (tree, path5, &exact_match) == tree->root && !exact_match);
1472   _dbus_assert (find_handler (tree, path6, &exact_match) == tree->root && !exact_match);
1473   _dbus_assert (find_handler (tree, path7, &exact_match) == tree->root && !exact_match);
1474   _dbus_assert (find_handler (tree, path8, &exact_match) == tree->root && !exact_match);
1475
1476   if (!do_register (tree, path2, TRUE, 2, tree_test_data))
1477     goto out;
1478
1479   _dbus_assert (find_subtree (tree, path1, NULL));
1480   _dbus_assert (find_subtree (tree, path2, NULL));
1481   _dbus_assert (!find_subtree (tree, path3, NULL));
1482   _dbus_assert (!find_subtree (tree, path4, NULL));
1483   _dbus_assert (!find_subtree (tree, path5, NULL));
1484   _dbus_assert (!find_subtree (tree, path6, NULL));
1485   _dbus_assert (!find_subtree (tree, path7, NULL));
1486   _dbus_assert (!find_subtree (tree, path8, NULL));
1487
1488   if (!do_register (tree, path3, TRUE, 3, tree_test_data))
1489     goto out;
1490
1491   _dbus_assert (find_subtree (tree, path0, NULL));
1492   _dbus_assert (find_subtree (tree, path1, NULL));
1493   _dbus_assert (find_subtree (tree, path2, NULL));
1494   _dbus_assert (find_subtree (tree, path3, NULL));
1495   _dbus_assert (!find_subtree (tree, path4, NULL));
1496   _dbus_assert (!find_subtree (tree, path5, NULL));
1497   _dbus_assert (!find_subtree (tree, path6, NULL));
1498   _dbus_assert (!find_subtree (tree, path7, NULL));
1499   _dbus_assert (!find_subtree (tree, path8, NULL));
1500
1501   if (!do_register (tree, path4, TRUE, 4, tree_test_data))
1502     goto out;
1503
1504   _dbus_assert (find_subtree (tree, path0, NULL));
1505   _dbus_assert (find_subtree (tree, path1, NULL));
1506   _dbus_assert (find_subtree (tree, path2, NULL));
1507   _dbus_assert (find_subtree (tree, path3, NULL));
1508   _dbus_assert (find_subtree (tree, path4, NULL));
1509   _dbus_assert (!find_subtree (tree, path5, NULL));
1510   _dbus_assert (!find_subtree (tree, path6, NULL));
1511   _dbus_assert (!find_subtree (tree, path7, NULL));
1512   _dbus_assert (!find_subtree (tree, path8, NULL));
1513
1514   if (!do_register (tree, path5, TRUE, 5, tree_test_data))
1515     goto out;
1516
1517   _dbus_assert (find_subtree (tree, path0, NULL));
1518   _dbus_assert (find_subtree (tree, path1, NULL));
1519   _dbus_assert (find_subtree (tree, path2, NULL));
1520   _dbus_assert (find_subtree (tree, path3, NULL));
1521   _dbus_assert (find_subtree (tree, path4, NULL));
1522   _dbus_assert (find_subtree (tree, path5, NULL));
1523   _dbus_assert (!find_subtree (tree, path6, NULL));
1524   _dbus_assert (!find_subtree (tree, path7, NULL));
1525   _dbus_assert (!find_subtree (tree, path8, NULL));
1526
1527   _dbus_assert (find_handler (tree, path0, &exact_match) == tree->root &&  exact_match);
1528   _dbus_assert (find_handler (tree, path1, &exact_match) != tree->root &&  exact_match);
1529   _dbus_assert (find_handler (tree, path2, &exact_match) != tree->root &&  exact_match);
1530   _dbus_assert (find_handler (tree, path3, &exact_match) != tree->root &&  exact_match);
1531   _dbus_assert (find_handler (tree, path4, &exact_match) != tree->root &&  exact_match);
1532   _dbus_assert (find_handler (tree, path5, &exact_match) != tree->root &&  exact_match);
1533   _dbus_assert (find_handler (tree, path6, &exact_match) != tree->root && !exact_match);
1534   _dbus_assert (find_handler (tree, path7, &exact_match) != tree->root && !exact_match);
1535   _dbus_assert (find_handler (tree, path8, &exact_match) == tree->root && !exact_match);
1536
1537   if (!do_register (tree, path6, TRUE, 6, tree_test_data))
1538     goto out;
1539
1540   _dbus_assert (find_subtree (tree, path0, NULL));
1541   _dbus_assert (find_subtree (tree, path1, NULL));
1542   _dbus_assert (find_subtree (tree, path2, NULL));
1543   _dbus_assert (find_subtree (tree, path3, NULL));
1544   _dbus_assert (find_subtree (tree, path4, NULL));
1545   _dbus_assert (find_subtree (tree, path5, NULL));
1546   _dbus_assert (find_subtree (tree, path6, NULL));
1547   _dbus_assert (!find_subtree (tree, path7, NULL));
1548   _dbus_assert (!find_subtree (tree, path8, NULL));
1549
1550   if (!do_register (tree, path7, TRUE, 7, tree_test_data))
1551     goto out;
1552
1553   _dbus_assert (find_subtree (tree, path0, NULL));
1554   _dbus_assert (find_subtree (tree, path1, NULL));
1555   _dbus_assert (find_subtree (tree, path2, NULL));
1556   _dbus_assert (find_subtree (tree, path3, NULL));
1557   _dbus_assert (find_subtree (tree, path4, NULL));
1558   _dbus_assert (find_subtree (tree, path5, NULL));
1559   _dbus_assert (find_subtree (tree, path6, NULL));
1560   _dbus_assert (find_subtree (tree, path7, NULL));
1561   _dbus_assert (!find_subtree (tree, path8, NULL));
1562
1563   if (!do_register (tree, path8, TRUE, 8, tree_test_data))
1564     goto out;
1565
1566   _dbus_assert (find_subtree (tree, path0, NULL));
1567   _dbus_assert (find_subtree (tree, path1, NULL));
1568   _dbus_assert (find_subtree (tree, path2, NULL));
1569   _dbus_assert (find_subtree (tree, path3, NULL));
1570   _dbus_assert (find_subtree (tree, path4, NULL));
1571   _dbus_assert (find_subtree (tree, path5, NULL));
1572   _dbus_assert (find_subtree (tree, path6, NULL));
1573   _dbus_assert (find_subtree (tree, path7, NULL));
1574   _dbus_assert (find_subtree (tree, path8, NULL));
1575
1576   _dbus_assert (find_handler (tree, path0, &exact_match) == tree->root &&  exact_match);
1577   _dbus_assert (find_handler (tree, path1, &exact_match) != tree->root && exact_match);
1578   _dbus_assert (find_handler (tree, path2, &exact_match) != tree->root && exact_match);
1579   _dbus_assert (find_handler (tree, path3, &exact_match) != tree->root && exact_match);
1580   _dbus_assert (find_handler (tree, path4, &exact_match) != tree->root && exact_match);
1581   _dbus_assert (find_handler (tree, path5, &exact_match) != tree->root && exact_match);
1582   _dbus_assert (find_handler (tree, path6, &exact_match) != tree->root && exact_match);
1583   _dbus_assert (find_handler (tree, path7, &exact_match) != tree->root && exact_match);
1584   _dbus_assert (find_handler (tree, path8, &exact_match) != tree->root && exact_match);
1585
1586   /* test the list_registered function */
1587
1588   {
1589     const char *root[] = { NULL };
1590     char **child_entries;
1591     int nb;
1592
1593     _dbus_object_tree_list_registered_unlocked (tree, path1, &child_entries);
1594     if (child_entries != NULL)
1595       {
1596         nb = string_array_length ((const char**)child_entries);
1597         _dbus_assert (nb == 1);
1598         dbus_free_string_array (child_entries);
1599       }
1600
1601     _dbus_object_tree_list_registered_unlocked (tree, path2, &child_entries);
1602     if (child_entries != NULL)
1603       {
1604         nb = string_array_length ((const char**)child_entries);
1605         _dbus_assert (nb == 2);
1606         dbus_free_string_array (child_entries);
1607       }
1608
1609     _dbus_object_tree_list_registered_unlocked (tree, path8, &child_entries);
1610     if (child_entries != NULL)
1611       {
1612         nb = string_array_length ((const char**)child_entries);
1613         _dbus_assert (nb == 0);
1614         dbus_free_string_array (child_entries);
1615       }
1616
1617     _dbus_object_tree_list_registered_unlocked (tree, root, &child_entries);
1618     if (child_entries != NULL)
1619       {
1620         nb = string_array_length ((const char**)child_entries);
1621         _dbus_assert (nb == 3);
1622         dbus_free_string_array (child_entries);
1623       }
1624   }
1625
1626   /* Check that destroying tree calls unregister funcs */
1627   _dbus_object_tree_unref (tree);
1628
1629   i = 0;
1630   while (i < (int) _DBUS_N_ELEMENTS (tree_test_data))
1631     {
1632       _dbus_assert (tree_test_data[i].handler_unregistered);
1633       _dbus_assert (!tree_test_data[i].message_handled);
1634       ++i;
1635     }
1636
1637   /* Now start again and try the individual unregister function */
1638   tree = _dbus_object_tree_new (NULL);
1639   if (tree == NULL)
1640     goto out;
1641
1642   if (!do_register (tree, path0, TRUE, 0, tree_test_data))
1643     goto out;
1644   if (!do_register (tree, path1, TRUE, 1, tree_test_data))
1645     goto out;
1646   if (!do_register (tree, path2, TRUE, 2, tree_test_data))
1647     goto out;
1648   if (!do_register (tree, path3, TRUE, 3, tree_test_data))
1649     goto out;
1650   if (!do_register (tree, path4, TRUE, 4, tree_test_data))
1651     goto out;
1652   if (!do_register (tree, path5, TRUE, 5, tree_test_data))
1653     goto out;
1654   if (!do_register (tree, path6, TRUE, 6, tree_test_data))
1655     goto out;
1656   if (!do_register (tree, path7, TRUE, 7, tree_test_data))
1657     goto out;
1658   if (!do_register (tree, path8, TRUE, 8, tree_test_data))
1659     goto out;
1660
1661   _dbus_object_tree_unregister_and_unlock (tree, path0);
1662
1663   _dbus_assert (!find_subtree (tree, path0, NULL));
1664   _dbus_assert (find_subtree (tree, path1, NULL));
1665   _dbus_assert (find_subtree (tree, path2, NULL));
1666   _dbus_assert (find_subtree (tree, path3, NULL));
1667   _dbus_assert (find_subtree (tree, path4, NULL));
1668   _dbus_assert (find_subtree (tree, path5, NULL));
1669   _dbus_assert (find_subtree (tree, path6, NULL));
1670   _dbus_assert (find_subtree (tree, path7, NULL));
1671   _dbus_assert (find_subtree (tree, path8, NULL));
1672
1673   _dbus_object_tree_unregister_and_unlock (tree, path1);
1674
1675   _dbus_assert (!find_subtree (tree, path0, NULL));
1676   _dbus_assert (!find_subtree (tree, path1, NULL));
1677   _dbus_assert (find_subtree (tree, path2, NULL));
1678   _dbus_assert (find_subtree (tree, path3, NULL));
1679   _dbus_assert (find_subtree (tree, path4, NULL));
1680   _dbus_assert (find_subtree (tree, path5, NULL));
1681   _dbus_assert (find_subtree (tree, path6, NULL));
1682   _dbus_assert (find_subtree (tree, path7, NULL));
1683   _dbus_assert (find_subtree (tree, path8, NULL));
1684
1685   _dbus_object_tree_unregister_and_unlock (tree, path2);
1686
1687   _dbus_assert (!find_subtree (tree, path0, NULL));
1688   _dbus_assert (!find_subtree (tree, path1, NULL));
1689   _dbus_assert (!find_subtree (tree, path2, NULL));
1690   _dbus_assert (find_subtree (tree, path3, NULL));
1691   _dbus_assert (find_subtree (tree, path4, NULL));
1692   _dbus_assert (find_subtree (tree, path5, NULL));
1693   _dbus_assert (find_subtree (tree, path6, NULL));
1694   _dbus_assert (find_subtree (tree, path7, NULL));
1695   _dbus_assert (find_subtree (tree, path8, NULL));
1696
1697   _dbus_object_tree_unregister_and_unlock (tree, path3);
1698
1699   _dbus_assert (!find_subtree (tree, path0, NULL));
1700   _dbus_assert (!find_subtree (tree, path1, NULL));
1701   _dbus_assert (!find_subtree (tree, path2, NULL));
1702   _dbus_assert (!find_subtree (tree, path3, NULL));
1703   _dbus_assert (find_subtree (tree, path4, NULL));
1704   _dbus_assert (find_subtree (tree, path5, NULL));
1705   _dbus_assert (find_subtree (tree, path6, NULL));
1706   _dbus_assert (find_subtree (tree, path7, NULL));
1707   _dbus_assert (find_subtree (tree, path8, NULL));
1708
1709   _dbus_object_tree_unregister_and_unlock (tree, path4);
1710
1711   _dbus_assert (!find_subtree (tree, path0, NULL));
1712   _dbus_assert (!find_subtree (tree, path1, NULL));
1713   _dbus_assert (!find_subtree (tree, path2, NULL));
1714   _dbus_assert (!find_subtree (tree, path3, NULL));
1715   _dbus_assert (!find_subtree (tree, path4, NULL));
1716   _dbus_assert (find_subtree (tree, path5, NULL));
1717   _dbus_assert (find_subtree (tree, path6, NULL));
1718   _dbus_assert (find_subtree (tree, path7, NULL));
1719   _dbus_assert (find_subtree (tree, path8, NULL));
1720
1721   _dbus_object_tree_unregister_and_unlock (tree, path5);
1722
1723   _dbus_assert (!find_subtree (tree, path0, NULL));
1724   _dbus_assert (!find_subtree (tree, path1, NULL));
1725   _dbus_assert (!find_subtree (tree, path2, NULL));
1726   _dbus_assert (!find_subtree (tree, path3, NULL));
1727   _dbus_assert (!find_subtree (tree, path4, NULL));
1728   _dbus_assert (!find_subtree (tree, path5, NULL));
1729   _dbus_assert (find_subtree (tree, path6, NULL));
1730   _dbus_assert (find_subtree (tree, path7, NULL));
1731   _dbus_assert (find_subtree (tree, path8, NULL));
1732
1733   _dbus_object_tree_unregister_and_unlock (tree, path6);
1734
1735   _dbus_assert (!find_subtree (tree, path0, NULL));
1736   _dbus_assert (!find_subtree (tree, path1, NULL));
1737   _dbus_assert (!find_subtree (tree, path2, NULL));
1738   _dbus_assert (!find_subtree (tree, path3, NULL));
1739   _dbus_assert (!find_subtree (tree, path4, NULL));
1740   _dbus_assert (!find_subtree (tree, path5, NULL));
1741   _dbus_assert (!find_subtree (tree, path6, NULL));
1742   _dbus_assert (find_subtree (tree, path7, NULL));
1743   _dbus_assert (find_subtree (tree, path8, NULL));
1744
1745   _dbus_object_tree_unregister_and_unlock (tree, path7);
1746
1747   _dbus_assert (!find_subtree (tree, path0, NULL));
1748   _dbus_assert (!find_subtree (tree, path1, NULL));
1749   _dbus_assert (!find_subtree (tree, path2, NULL));
1750   _dbus_assert (!find_subtree (tree, path3, NULL));
1751   _dbus_assert (!find_subtree (tree, path4, NULL));
1752   _dbus_assert (!find_subtree (tree, path5, NULL));
1753   _dbus_assert (!find_subtree (tree, path6, NULL));
1754   _dbus_assert (!find_subtree (tree, path7, NULL));
1755   _dbus_assert (find_subtree (tree, path8, NULL));
1756
1757   _dbus_object_tree_unregister_and_unlock (tree, path8);
1758
1759   _dbus_assert (!find_subtree (tree, path0, NULL));
1760   _dbus_assert (!find_subtree (tree, path1, NULL));
1761   _dbus_assert (!find_subtree (tree, path2, NULL));
1762   _dbus_assert (!find_subtree (tree, path3, NULL));
1763   _dbus_assert (!find_subtree (tree, path4, NULL));
1764   _dbus_assert (!find_subtree (tree, path5, NULL));
1765   _dbus_assert (!find_subtree (tree, path6, NULL));
1766   _dbus_assert (!find_subtree (tree, path7, NULL));
1767   _dbus_assert (!find_subtree (tree, path8, NULL));
1768
1769   i = 0;
1770   while (i < (int) _DBUS_N_ELEMENTS (tree_test_data))
1771     {
1772       _dbus_assert (tree_test_data[i].handler_unregistered);
1773       _dbus_assert (!tree_test_data[i].message_handled);
1774       ++i;
1775     }
1776
1777   /* Register it all again, and test dispatch */
1778
1779   if (!do_register (tree, path0, TRUE, 0, tree_test_data))
1780     goto out;
1781   if (!do_register (tree, path1, FALSE, 1, tree_test_data))
1782     goto out;
1783   if (!do_register (tree, path2, TRUE, 2, tree_test_data))
1784     goto out;
1785   if (!do_register (tree, path3, TRUE, 3, tree_test_data))
1786     goto out;
1787   if (!do_register (tree, path4, TRUE, 4, tree_test_data))
1788     goto out;
1789   if (!do_register (tree, path5, TRUE, 5, tree_test_data))
1790     goto out;
1791   if (!do_register (tree, path6, FALSE, 6, tree_test_data))
1792     goto out;
1793   if (!do_register (tree, path7, TRUE, 7, tree_test_data))
1794     goto out;
1795   if (!do_register (tree, path8, TRUE, 8, tree_test_data))
1796     goto out;
1797
1798 #if 0
1799   spew_tree (tree);
1800 #endif
1801
1802   if (!do_test_dispatch (tree, path0, 0, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1803     goto out;
1804   if (!do_test_dispatch (tree, path1, 1, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1805     goto out;
1806   if (!do_test_dispatch (tree, path2, 2, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1807     goto out;
1808   if (!do_test_dispatch (tree, path3, 3, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1809     goto out;
1810   if (!do_test_dispatch (tree, path4, 4, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1811     goto out;
1812   if (!do_test_dispatch (tree, path5, 5, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1813     goto out;
1814   if (!do_test_dispatch (tree, path6, 6, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1815     goto out;
1816   if (!do_test_dispatch (tree, path7, 7, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1817     goto out;
1818   if (!do_test_dispatch (tree, path8, 8, tree_test_data, _DBUS_N_ELEMENTS (tree_test_data)))
1819     goto out;
1820
1821  out:
1822   if (tree)
1823     {
1824       /* test ref */
1825       _dbus_object_tree_ref (tree);
1826       _dbus_object_tree_unref (tree);
1827       _dbus_object_tree_unref (tree);
1828     }
1829
1830   return TRUE;
1831 }
1832
1833 /**
1834  * @ingroup DBusObjectTree
1835  * Unit test for DBusObjectTree
1836  * @returns #TRUE on success.
1837  */
1838 dbus_bool_t
1839 _dbus_object_tree_test (void)
1840 {
1841   _dbus_test_oom_handling ("object tree",
1842                            object_tree_test_iteration,
1843                            NULL);
1844
1845   return TRUE;
1846 }
1847
1848 #endif /* DBUS_BUILD_TESTS */