1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
#
# This file is part of Config-Model-TkUI
#
# This software is Copyright (c) 2008-2021 by Dominique Dumont.
#
# This is free software, licensed under:
#
# The GNU Lesser General Public License, Version 2.1, February 1999
#
package Config::Model::Tk::Filter 1.379;
use 5.10.1;
use strict;
use warnings;
use Carp;
use Log::Log4perl 1.11;
require Exporter;
our @ISA = qw(Exporter);
our @EXPORT_OK = qw/apply_filter/;
my $logger = Log::Log4perl::get_logger('Tk::Filter');
sub _get_filter_action {
my ($elt, $elt_filter, $filtered_state, $unfiltered_state, $default_state) = @_;
my $action = $default_state;
# filter is active only when the filter string is 3 or more chars long
if (length($elt_filter) > 2) {
if ($elt =~ /$elt_filter/) {
$action = $filtered_state ;
}
else {
$action = $unfiltered_state;
}
}
return $action;
}
# scan a tree and return a hash where each found path is the key and the
# value is either hide, show or an empty string.
sub apply_filter {
my (%args) = @_;
# fd_path: force display path. The show action must be set in the
# call back so that the 'show' action can be propagated from the
# shown leaf up to the root of the tree.
my $show_only_custom = $args{show_only_custom} // 0;
my $hide_empty_values = $args{hide_empty_values} // 0;
my $instance = $args{instance} // carp "missing instance" ;
my $actions = $args{actions} // carp "missing actions ref" ;
my $fd_path = $args{fd_path} // '';
# flush the hash, but keep the ref
%$actions = ();
# actions need 3 state logic. '' means that tree node is left as
# is, either closed or opened, depending on user's choice.
# 'show' trumps '' which trumps 'hide'
my %combine_actions = (
show => { show => 'show', '' => 'show', hide => 'show'},
'' => { show => 'show', '' => '' , hide => '' },
hide => { show => 'show', '' => '' , hide => 'hide'},
);
my $leaf_cb = sub {
my ($scanner, $data_ref, $node,$element_name,$index, $leaf_object) = @_ ;
my $loc = $leaf_object->location;
my $action = '';
if ($show_only_custom) {
$action = $leaf_object->has_data ? 'show' : 'hide';
}
if ( $hide_empty_values ) {
my $v = $leaf_object->fetch(qw/check no/);
$action = 'hide' unless (defined $v and length($v)) ;
}
$action = 'show' if $loc eq $fd_path;
$logger->trace("leaf '$loc' filter is '$action'");
$data_ref->{return} = $data_ref->{actions}{$loc} = $action ;
};
my $check_list_cb = sub {
my ($scanner, $data_ref,$node,$element_name,undef, $obj) = @_;
my $loc = $obj->location;
my $action = '';
if ( $hide_empty_values and not $obj->fetch()) {
$action = 'hide';
}
$action = 'show' if $loc eq $fd_path;
$logger->trace("check_list '$loc' filter is '$action'");
$data_ref->{return} = $data_ref->{actions}{$loc} = $action ;
};
my $hash_cb = sub {
my ($scanner, $data_ref,$node,$element_name,@keys) = @_ ;
my $obj = $node->fetch_element($element_name);
my $loc = $obj->location;
# resume exploration
my $hash_action = $hide_empty_values || $show_only_custom ? 'hide' : '';
foreach my $key (@keys) {
my $inner_ref = { actions => $data_ref->{actions}, filter => $data_ref->{filter} };
$scanner->scan_hash($inner_ref, $node, $element_name, $key);
$hash_action = $combine_actions{$hash_action}{$inner_ref->{return}};
}
$hash_action = 'show' if $loc eq $fd_path;
$logger->trace("hash '$loc' filter is '$hash_action'");
$data_ref->{return} = $data_ref->{actions}{$loc} = $hash_action;
};
my $node_cb = sub {
my ($scanner, $data_ref,$node, @element_list) = @_ ;
my $node_loc = $node->location;
my $elt_filter = $data_ref->{filter};
my $all_elt_action = $show_only_custom ? 'hide' : '';
my $default_action = (length($elt_filter) > 3) ? 'hide' : '';
foreach my $elt ( @element_list ) {
my $filter_action = _get_filter_action($elt,$elt_filter,'show','hide','');
my $obj = $node->fetch_element($elt);
my $loc = $obj->location;
# make sure that the hash ref stays attached to $data_ref
$data_ref->{actions} //= {};
my $elt_action;
if ($filter_action eq 'show') {
my $inner_ref = {
actions => $data_ref->{actions},
# stop filter propagation when current element is
# shown so all elements below can be shown or hidden
# at user's choice
filter => ''
};
$scanner->scan_element($inner_ref, $node,$elt);
# this clobbers the elt_action computed in leaf
$elt_action = $data_ref->{actions}{$loc} = $filter_action;
$logger->trace("node '$loc' elt $elt filter is active '$elt_action'");
} else {
my $inner_ref = { actions => $data_ref->{actions}, filter => $data_ref->{filter} };
$scanner->scan_element($inner_ref, $node,$elt);
$elt_action = $data_ref->{actions}{$loc} = $inner_ref->{return} || $default_action;
$logger->trace("node '$loc' elt $elt filter is not active '$elt_action'");
}
$all_elt_action = $combine_actions{$all_elt_action}{$elt_action};
$logger->trace("node '$loc' elt $elt all_elt_action is '$all_elt_action'");
}
my $node_action = $node_loc eq $fd_path ? 'show' : $all_elt_action;
$logger->trace("node '$node_loc' filter is '$node_action'");
$data_ref->{return} = $data_ref->{actions}{$node_loc} = $node_action;
};
my $scan = Config::Model::ObjTreeScanner-> new (
leaf_cb => $leaf_cb,
hash_element_cb => $hash_cb,
list_element_cb => $hash_cb,
node_content_cb => $node_cb,
) ;
my $data_ref = {
filter => $args{elt_filter_value} // '',
actions => $actions,
};
$scan->scan_node($data_ref, $instance->config_root) ;
}
1;
|
