2 * Samba Unix/Linux SMB client library
4 * Copyright (C) Christopher Davis 2012
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 #include "regedit_treeview.h"
21 #include "regedit_list.h"
22 #include "lib/registry/registry.h"
26 static int tree_node_free(struct tree_node *node)
28 DEBUG(9, ("tree_node_free('%s', %p)\n", node->name, node));
32 struct tree_node *tree_node_new(TALLOC_CTX *ctx, struct tree_node *parent,
33 const char *name, struct registry_key *key)
35 struct tree_node *node;
37 node = talloc_zero(ctx, struct tree_node);
41 talloc_set_destructor(node, tree_node_free);
42 DEBUG(9, ("tree_node_new('%s', %p)\n", name, node));
44 node->name = talloc_strdup(node, name);
51 node->key = talloc_steal(node, key);
55 /* Check if this node is the first descendant of parent. */
56 if (!parent->child_head) {
57 parent->child_head = node;
59 node->parent = parent;
65 /* prepare a root node with all available hives as children */
66 struct tree_node *tree_node_new_root(TALLOC_CTX *ctx,
67 struct registry_context *regctx)
69 const char *hives[] = {
73 "HKEY_PERFORMANCE_DATA",
75 "HKEY_CURRENT_CONFIG",
77 "HKEY_PERFORMANCE_TEXT",
78 "HKEY_PERFORMANCE_NLSTEXT",
81 struct tree_node *root, *prev, *node;
82 struct registry_key *key;
86 root = tree_node_new(ctx, NULL, "ROOT", NULL);
92 for (i = 0; hives[i] != NULL; ++i) {
93 rv = reg_get_predefined_key_by_name(regctx, hives[i], &key);
94 if (!W_ERROR_IS_OK(rv)) {
98 node = tree_node_new(root, root, hives[i], key);
103 tree_node_append(prev, node);
111 void tree_node_append(struct tree_node *left, struct tree_node *right)
114 right->next = left->next;
115 left->next->previous = right;
118 right->previous = left;
121 void tree_node_append_last(struct tree_node *list, struct tree_node *node)
123 tree_node_append(tree_node_last(list), node);
126 struct tree_node *tree_node_pop(struct tree_node **plist)
128 struct tree_node *node;
135 *plist = node->previous;
136 if (*plist == NULL) {
139 if (node->previous) {
140 node->previous->next = node->next;
143 node->next->previous = node->previous;
145 if (node->parent && node->parent->child_head == node) {
146 node->parent->child_head = node->next;
149 node->previous = NULL;
154 struct tree_node *tree_node_first(struct tree_node *list)
156 /* Grab the first node in this list from the parent if available. */
158 return list->parent->child_head;
161 while (list && list->previous) {
162 list = list->previous;
168 struct tree_node *tree_node_last(struct tree_node *list)
170 while (list && list->next) {
177 static uint32_t get_num_subkeys(struct tree_node *node)
179 const char *classname;
180 uint32_t num_subkeys;
182 NTTIME last_change_time;
183 uint32_t max_subkeynamelen;
184 uint32_t max_valnamelen;
185 uint32_t max_valbufsize;
188 rv = reg_key_get_info(node, node->key, &classname, &num_subkeys,
189 &num_values, &last_change_time,
190 &max_subkeynamelen, &max_valnamelen,
193 if (W_ERROR_IS_OK(rv)) {
200 WERROR tree_node_reopen_key(struct registry_context *ctx,
201 struct tree_node *node)
203 SMB_ASSERT(node->parent != NULL);
204 SMB_ASSERT(node->name != NULL);
205 TALLOC_FREE(node->key);
207 if (tree_node_is_top_level(node)) {
209 struct registry_key *key;
210 rv = reg_get_predefined_key_by_name(ctx, node->name, &key);
211 if (W_ERROR_IS_OK(rv)) {
212 node->key = talloc_steal(node, key);
217 return reg_open_key(node, node->parent->key, node->name, &node->key);
220 bool tree_node_has_children(struct tree_node *node)
222 if (node->child_head) {
226 return get_num_subkeys(node) > 0;
229 static int node_cmp(struct tree_node **a, struct tree_node **b)
231 return strcmp((*a)->name, (*b)->name);
234 void tree_node_insert_sorted(struct tree_node *list, struct tree_node *node)
236 list = tree_node_first(list);
238 if (node_cmp(&list, &node) >= 0) {
239 tree_node_append(node, list);
241 list->parent->child_head = node;
246 while (list->next && node_cmp(&list->next, &node) < 0) {
250 tree_node_append(list, node);
253 WERROR tree_node_load_children(struct tree_node *node)
255 struct registry_key *key;
256 const char *key_name, *klass;
258 uint32_t i, nsubkeys, count;
260 struct tree_node *prev, **array;
262 /* does this node already have it's children loaded? */
263 if (node->child_head)
266 nsubkeys = get_num_subkeys(node);
270 array = talloc_zero_array(node, struct tree_node *, nsubkeys);
275 for (count = 0, i = 0; i < nsubkeys; ++i) {
276 rv = reg_key_get_subkey_by_index(node, node->key, i,
279 if (!W_ERROR_IS_OK(rv)) {
283 rv = reg_open_key(node, node->key, key_name, &key);
284 if (!W_ERROR_IS_OK(rv)) {
288 array[count] = tree_node_new(array, node, key_name, key);
289 if (array[count] == NULL) {
297 TYPESAFE_QSORT(array, count, node_cmp);
299 for (i = 1, prev = array[0]; i < count; ++i) {
300 talloc_steal(node, array[i]);
301 tree_node_append(prev, array[i]);
304 node->child_head = talloc_steal(node, array[0]);
315 static WERROR next_depth_first(struct tree_node **node)
319 SMB_ASSERT(node != NULL && *node != NULL);
321 if (tree_node_has_children(*node)) {
322 /* 1. If the node has children, go to the first one. */
323 rv = tree_node_load_children(*node);
324 if (W_ERROR_IS_OK(rv)) {
325 SMB_ASSERT((*node)->child_head != NULL);
326 *node = (*node)->child_head;
328 } else if ((*node)->next) {
329 /* 2. If there's a node directly after this one, go there */
330 *node = (*node)->next;
332 /* 3. Otherwise, go up the hierarchy to find the next one */
334 *node = (*node)->parent;
335 if (*node && (*node)->next) {
336 *node = (*node)->next;
345 bool tree_node_next(struct tree_node **node, bool depth, WERROR *err)
354 *err = next_depth_first(node);
356 *node = (*node)->next;
359 return *node != NULL && W_ERROR_IS_OK(*err);
362 void tree_view_clear(struct tree_view *view)
364 multilist_set_data(view->list, NULL);
367 WERROR tree_view_set_root(struct tree_view *view, struct tree_node *root)
369 multilist_set_data(view->list, NULL);
370 talloc_free(view->root);
372 return tree_view_update(view, root->child_head);
375 WERROR tree_view_set_path(struct tree_view *view, const char **path)
377 struct tree_node *top, *node;
380 top = view->root->child_head;
382 for (node = top; node != NULL; node = node->next) {
383 if (strcmp(*path, node->name) == 0) {
384 if (path[1] && tree_node_has_children(node)) {
385 rv = tree_node_load_children(node);
386 if (!W_ERROR_IS_OK(rv)) {
389 SMB_ASSERT(node->child_head);
390 top = node->child_head;
393 tree_view_update(view, top);
394 tree_view_set_current_node(view, node);
405 WERROR tree_view_update(struct tree_view *view, struct tree_node *list)
409 rv = multilist_set_data(view->list, list);
410 if (W_ERROR_IS_OK(rv)) {
411 multilist_refresh(view->list);
417 /* is this node in the current level? */
418 bool tree_view_is_node_visible(struct tree_view *view, struct tree_node *node)
420 const struct tree_node *first;
422 first = multilist_get_data(view->list);
424 return first && first->parent == node->parent;
427 void tree_view_set_current_node(struct tree_view *view, struct tree_node *node)
429 multilist_set_current_row(view->list, node);
432 struct tree_node *tree_view_get_current_node(struct tree_view *view)
434 const void *row = multilist_get_current_row(view->list);
435 return talloc_get_type_abort(row, struct tree_node);
438 void tree_view_driver(struct tree_view *view, int c)
440 multilist_driver(view->list, c);
443 void tree_view_set_selected(struct tree_view *view, bool select)
445 attr_t attr = A_NORMAL;
450 mvwchgat(view->window, 0, HEADING_X, 3, attr, 0, NULL);
453 void tree_view_show(struct tree_view *view)
455 multilist_refresh(view->list);
456 touchwin(view->window);
457 wnoutrefresh(view->window);
458 wnoutrefresh(view->sub);
461 static int tree_view_free(struct tree_view *view)
464 del_panel(view->panel);
470 delwin(view->window);
476 static const char *tv_get_column_header(const void *data, unsigned col)
478 SMB_ASSERT(col == 0);
482 static const void *tv_get_first_row(const void *data)
488 return talloc_get_type_abort(data, struct tree_node);
491 static const void *tv_get_next_row(const void *data, const void *row)
493 const struct tree_node *node;
494 SMB_ASSERT(row != NULL);
495 node = talloc_get_type_abort(row, struct tree_node);
499 static const void *tv_get_prev_row(const void *data, const void *row)
501 const struct tree_node *node;
502 SMB_ASSERT(row != NULL);
503 node = talloc_get_type_abort(row, struct tree_node);
504 return node->previous;
507 static const char *tv_get_item_prefix(const void *row, unsigned col)
509 struct tree_node *node;
511 SMB_ASSERT(col == 0);
512 SMB_ASSERT(row != NULL);
513 node = talloc_get_type_abort(row, struct tree_node);
514 if (tree_node_has_children(node)) {
520 static const char *tv_get_item_label(const void *row, unsigned col)
522 const struct tree_node *node;
523 SMB_ASSERT(col == 0);
524 SMB_ASSERT(row != NULL);
525 node = talloc_get_type_abort(row, struct tree_node);
529 static struct multilist_accessors tv_accessors = {
530 .get_column_header = tv_get_column_header,
531 .get_first_row = tv_get_first_row,
532 .get_next_row = tv_get_next_row,
533 .get_prev_row = tv_get_prev_row,
534 .get_item_prefix = tv_get_item_prefix,
535 .get_item_label = tv_get_item_label
538 struct tree_view *tree_view_new(TALLOC_CTX *ctx, struct tree_node *root,
539 int nlines, int ncols, int begin_y,
542 struct tree_view *view;
544 view = talloc_zero(ctx, struct tree_view);
549 talloc_set_destructor(view, tree_view_free);
551 view->window = newwin(nlines, ncols, begin_y, begin_x);
552 if (view->window == NULL) {
555 view->sub = subwin(view->window, nlines - 2, ncols - 2,
556 begin_y + 1, begin_x + 1);
557 if (view->sub == NULL) {
560 box(view->window, 0, 0);
561 mvwprintw(view->window, 0, HEADING_X, "Key");
563 view->panel = new_panel(view->window);
564 if (view->panel == NULL) {
569 view->list = multilist_new(view, view->sub, &tv_accessors, 1);
570 if (view->list == NULL) {
573 tree_view_update(view, root->child_head);
583 void tree_view_resize(struct tree_view *view, int nlines, int ncols,
584 int begin_y, int begin_x)
588 nwin = newwin(nlines, ncols, begin_y, begin_x);
592 nsub = subwin(nwin, nlines - 2, ncols - 2, begin_y + 1, begin_x + 1);
597 replace_panel(view->panel, nwin);
599 delwin(view->window);
602 box(view->window, 0, 0);
603 mvwprintw(view->window, 0, HEADING_X, "Key");
604 multilist_set_window(view->list, view->sub);
605 tree_view_show(view);
608 const char **tree_node_get_path(TALLOC_CTX *ctx, struct tree_node *node)
611 size_t nitems, index;
614 for (nitems = 0, p = node; !tree_node_is_root(p); p = p->parent) {
618 array = talloc_zero_array(ctx, const char *, nitems + 1);
623 for (index = nitems - 1, p = node;
624 !tree_node_is_root(p);
625 p = p->parent, --index) {
626 array[index] = talloc_strdup(array, p->name);
627 if (array[index] == NULL) {
628 talloc_free(discard_const(array));
636 /* print the path of node to label */
637 size_t tree_node_print_path(WINDOW *label, struct tree_node *node)
649 if (tree_node_is_top_level(node))
652 frame = talloc_stackframe();
653 path = tree_node_get_path(frame, node->parent);
656 len += strlen(*path) + 1;
657 wprintw(label, "%s/", *path);