1 package SL::Controller::Helper::ParseFilter;
5 use Exporter qw(import);
6 our @EXPORT = qw(parse_filter);
9 use SL::Helper::DateTime;
10 use List::MoreUtils qw(uniq);
14 date => sub { DateTime->from_lxoffice($_[0]) },
15 number => sub { $::form->parse_amount(\%::myconfig, $_[0]) },
16 percent => sub { $::form->parse_amount(\%::myconfig, $_[0]) / 100 },
17 head => sub { $_[0] . '%' },
18 tail => sub { '%' . $_[0] },
19 substr => sub { '%' . $_[0] . '%' },
23 enable => sub { ;;;; },
25 # since $_ is an alias it can't be used in a closure. even "".$_ or "$_"
26 # does not work, we need a real copy.
28 $_ => sub { +{ $_copy => $_[0] } },
29 } qw(similar match imatch regex regexp like ilike rlike is is_not ne eq lt gt le ge),
33 my ($filter, %params) = @_;
35 my $hint_objects = $params{with_objects} || [];
37 my ($flattened, $objects) = _pre_parse($filter, $hint_objects, '', %params);
39 my $query = _parse_filter($flattened, %params);
41 _launder_keys($filter, $params{launder_to}) unless $params{no_launder};
44 ($query && @$query ? (query => $query) : ()),
45 ($objects && @$objects ? ( with_objects => [ uniq @$objects ]) : ());
49 my ($filter, $launder_to) = @_;
50 $launder_to ||= $filter;
51 return unless ref $filter eq 'HASH';
52 for my $key (keys %$filter) {
55 if ('' eq ref $filter->{$orig}) {
56 $launder_to->{$key} = $filter->{$orig};
57 } elsif ('ARRAY' eq ref $filter->{$orig}) {
58 $launder_to->{$key} = [ @{ $filter->{$orig} } ];
60 $launder_to->{$key} ||= { };
61 _launder_keys($filter->{$key}, $launder_to->{$key});
67 my ($filter, $with_objects, $prefix, %params) = @_;
69 return (undef, $with_objects) unless 'HASH' eq ref $filter;
74 while (my ($key, $value) = each %$filter) {
75 next if !defined $value || $value eq ''; # 0 is fine
76 if ('HASH' eq ref $value) {
77 my ($query, $more_objects) = _pre_parse($value, $with_objects, _prefix($prefix, $key));
78 push @result, @$query if $query;
79 push @$with_objects, _prefix($prefix, $key), ($more_objects ? @$more_objects : ());
81 push @result, _prefix($prefix, $key) => $value;
85 return \@result, $with_objects;
89 my ($flattened, %params) = @_;
91 return () unless 'ARRAY' eq ref $flattened;
93 my %sorted = ( @$flattened );
95 my @keys = sort { length($b) <=> length($a) } keys %sorted;
97 next unless $key =~ /^(.*\b)::$/;
98 $sorted{$1 . '::' . delete $sorted{$key} } = delete $sorted{$1} if $sorted{$1} && $sorted{$key};
102 while (my ($key, $value) = each %sorted) {
103 ($key, $value) = _apply_all($key, $value, qr/\b:(\w+)/, { %filters, %{ $params{filters} || {} } });
104 ($key, $value) = _apply_all($key, $value, qr/\b::(\w+)/, { %methods, %{ $params{methods} || {} } });
105 $result{$key} = $value;
111 join '.', grep $_, @_;
115 my ($value, $name, $filters) = @_;
116 return $value unless $name && $filters->{$name};
117 return [ map { _apply($_, $name, $filters) } @$value ] if 'ARRAY' eq ref $value;
118 return $filters->{$name}->($value);
122 my ($key, $value, $re, $subs) = @_;
124 while ($key =~ s/$re//) {
125 $value = _apply($value, $1, $subs);
137 SL::Controller::Helper::ParseFilter - Convert a form filter spec into a RDBO get_all filter
141 use SL::Controller::Helper::ParseFilter;
142 SL::DB::Object->get_all(parse_filter($::form->{filter}));
145 SL::DB::Object->get_all(parse_filter($::form->{filter},
146 with_objects => [ qw(part customer) ]));
150 A search filter will usually search for things in relations of the actual
151 search target. A search for sales orders may be filtered by the name of the
152 customer. L<Rose::DB::Object> alloes you to search for these by filtering them prefixed with their table:
155 'customer.name' => 'John Doe',
156 'department.description' => [ ilike => '%Sales%' ],
157 'orddate' => [ lt => DateTime->today ],
160 Unfortunately, if you specify them in you form as these strings, the form
161 parser will convert them into nested structures like this:
171 And the substring match requires you to recognize the ilike, and modify the value.
173 C<parse_filter> tries to ease this by recognizing these structures and
174 providing suffixes for common search patterns.
180 =item C<parse_filter \%FILTER, [ %PARAMS ]>
182 First argument is the filter from form. It is highly recommended that you put
183 all filter attributes into a named container as to not confuse them with the
186 Nested structures will be parsed and interpreted as foreign references. For
187 example if you search for L<Order>s, this input will search for those with a
188 specific L<Salesman>:
190 [% L.select_tag('filter.salesman.id', ...) %]
192 Additionally you can add modifier to the name to set a certain method:
194 [% L.input_tag('filter.department.description:substr::ilike', ...) %]
196 This will add the "% .. %" wildcards for substr matching in SQL, and add an
197 C<< ilike => $value >> block around it to match case insensitively.
199 As a rule all value filters require a single colon and must be placed before
200 match method suffixes, which are appended with 2 colons. See below for a full
203 The reason for the method being last is that it is possible to specify the
204 method in another input. Suppose you want a date input and a separate
205 before/after/equal select, you can use the following:
207 [% L.date_tag('filter.appointed_date:date', ... ) %]
211 [% L.select_tag('filter.appointed_date::', ... ) %]
213 The special empty method will be used to set the method for the previous
220 Unfortunately Template cannot parse the postfixes if you want to
221 rerender the filter. For this reason all colons filter keys are by
222 default laundered into underscores, so you can use them like this:
224 [% L.input_tag('filter.price:number::lt', filter.price_number__lt) %]
226 All of your original entries will stay intactg. If you don't want this to
227 happen pass C<< no_launder => 1 >> as a parameter. Additionally you can pass a
228 different target for the laundered values with the C<launder_to> parameter. It
229 takes an hashref and will deep copy all values in your filter to the target. So
230 if you have a filter that looks liek this:
233 'price:number::lt' => '2,30',
239 parse_filter($filter, launder_to => $laundered_filter = { })
241 the original filter will be unchanged, and C<$laundered_filter> will end up
245 'price_number__lt' => '2,30',
249 =head1 FILTERS (leading with :)
251 The following filters are built in, and can be used.
257 Parses the input string with C<< DateTime->from_lxoffice >>
261 Pasres the input string with C<< Form->parse_amount >>
265 Parses the input string with C<< Form->parse_amount / 100 >>
269 Adds "%" at the end of the string.
273 Adds "%" at the end of the string.
277 Adds "% .. %" around the search string.
281 =head2 METHODS (leading with ::)
293 All these are recognized like the L<Rose::DB::Object> methods.
297 =head1 BUGS AND CAVEATS
299 This will not properly handle multiple versions of the same object in different
302 Suppose you want all L<SL::DB::Order>s which have either themselves a certain
303 customer, or are linked to a L<SL::DB::Invoice> with this customer, the
304 following will not work as you expect:
307 L.input_tag('customer.name:substr::ilike', ...)
308 L.input_tag('invoice.customer.name:substr::ilike', ...)
310 This will sarch for orders whoe invoice has the _same_ customer, which matches
311 both inputs. This is because tables are aliased by their name and not by their
312 position in with_objects.
320 Additional filters shoud be pluggable.
326 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>