dbus/dbus-object-tree.c

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