Webpacus/Controller/Search.pm

package Webpacus::Controller::Search;

use strict;
use warnings;
use base 'Catalyst::Controller';

use Data::Dumper;

use lib '/data/webpac2/lib';
use WebPAC::Search::Estraier 0.03;


=head1 NAME

Webpacus::Controller::Search - Search WebPAC data

=head1 SYNOPSIS

See L<WebPAC>, L<Webpacus>

=head1 DESCRIPTION

Catalyst Controller for search fields Hyper Estraier

=head1 METHODS

=over 4

=item default

=cut

sub default : Private {
    my ( $self, $c ) = @_;

    $c->log->debug("default search got param: ".Dumper($c->req->params));

    $c->stash->{template} = 'search.tt';
}

=item suggest

Returns results for REST URIs like:

C<search/suggest?search=FieldName&show=TitleProper&FieldName=query%20string>

It will use C<search> field to filter results (and using additional
C<FieldName> as value of search) and return C<TitleProper> field
for results.

If C<search> field has magic value <all>, it will search over all data, not
just one specified field:

C<search/suggest?search=all&show=TitleProper&all=query%20string>

=cut

sub suggest : Local {
        my ( $self, $c ) = @_;

        my $search = $c->req->params->{search};
        my $show = $c->req->params->{show};

        my $log = $c->log;

        my $webpac = $c->comp('Model::WebPAC');

        my $q = $c->req->params->{ $search || 'all' } || $c->response->body("no results");

        $log->info("search for '$q' in $search and display $show\n");

        my $max = $c->config->{'hits_for_suggest'};
        if (! $max) {
                $log->info("hits_for_suggest isn't defined, defaulting to 10");
                $c->config->{'hits_for_suggest'} = 10;
                $max = 10;
        }

        $c->forward('filter_database');

        my $hits = $webpac->search(
                phrase => $q,
                add_attr => $c->stash->{attr},
                get_attr => [ $show ],
                max => $max,
        );

        my $used;
        my @suggestions;

        foreach my $res (@{$hits}) {
                my $v = $res->{ $show } || next;
                next if ($used->{ $v }++);
                push @suggestions, $v;
        }

        $log->debug( ($#suggestions + 1) . " unique hits returned");

        $c->response->body( $c->prototype->auto_complete_result( \@suggestions ) );
}


=item results

Returns results for search query

=cut

sub results : Local {
        my ( $self, $c ) = @_;

        my $params = $c->req->params;

        # do full-page refresh for clients without JavaScript
        $c->stash->{results} = $c->subreq('/search/results/ajax', {}, $params);
        $c->stash->{template} = 'search.tt';
}


=item results_ajax

Private method which uses C<Model::WebPAC> and returns results for search
query It generatets just I<inner> HTML for results div, so it has C<_ajax>
in name.

=cut

# specify all Hyper Estraier operators which should stop this module
# from splitting search query and joining it with default operator
my $hest_op_regex = '(:?\[(:?BW|EW|RX)\]|AND|OR|ANDNOT)';

sub results_ajax : Path( 'results/ajax' ) {
        my ( $self, $c ) = @_;

        my $params = $c->req->params;
        my $webpac = $c->comp('Model::WebPAC');
        my $log = $c->log;

        $log->debug("results got params: " . Dumper( $params ) );

        if (! $params->{_page} || $params->{_page} < 1) {
                $params->{_page} = 1;
                $log->warn("fixed _page parametar to 1");
        }

        my @words;
        # default operator to join fields/words
        my $operator = 'AND';

        foreach my $f (keys %{ $params }) {

                next if ($f =~ m/^_/o);

                my $v = $params->{$f} || next;

                if (my $op = $params->{ '_' . $f}) {
                        if ($v =~ /$hest_op_regex/) {
                                # don't split words if there is Hyper Estraier
                                # operator in them
                                push @words, $v;
                        } else {
                                push @words, join(" $op ", split(/\s+/, $v) );
                        }
                } else {
                        push @words, $v;
                }

                next if ($f eq 'all');  # don't add_attr for magic field all

                if ($v !~ /\s/) {
                        push @{ $c->stash->{attr} }, "$f ISTRINC $v";
                } else {
                        map {
                                push @{ $c->stash->{attr} }, "$f ISTRINC $_";
                        } grep { ! /$hest_op_regex/ } split(/\s+/, $v);
                }
        }

    $c->forward('filter_database');

        my $q = join(" $operator ", @words);

        my $template = $params->{'_template'} || $c->config->{webpac}->{template};

        $log->die("can't find _template or default from configuration!") unless ($template);

        my $hits_on_page = $c->config->{'hyperestraier'}->{'hits_on_page'} || 10;

        $log->debug("using template $template to produce $hits_on_page results");

        $c->stash->{html_results} = sub {
                my $res = $webpac->search( 
                        phrase => $q,
                        template => $template,
                        add_attr => $c->{stash}->{attr},
                        get_attr => [ '@uri' ],
                        max => $hits_on_page,
                        page => $params->{'_page'},
                );
#               $log->debug("controller got " . ( $#{$res} + 1 ) . " results for '$q' " . Dumper( $res ));
                return $res;
        };

        $c->stash->{phrase} = $q;
        $c->stash->{page} = $params->{'_page'};
        $c->stash->{hits_on_page} = $hits_on_page;

        $c->stash->{template} = 'results.tt';

}

=item filter_database

Takes C<< $c->req->params >> and adds Hyper Estraier
filters for checked databases to C<< $c->stash->{attr} >>.

=cut

sub filter_database : Private {
        my ( $self, $c ) = @_;

        my $params = $c->req->params;

        if ($params->{_database}) {
                my $type = $c->config->{hyperstraier}->{type} || 'search';
                my $attr;
                if (ref($params->{_database}) eq 'ARRAY') {
                        # FIXME do we need to add $ at end?
                        $attr .= '(' . join("|",@{$params->{_database}}) . ')';
                } else {
                        $attr .= $params->{_database};
                }
                push @{ $c->stash->{attr} }, '@uri STRRX /' . $type . '/' . $attr . '/';
                $c->log->debug("filter_database: " . join(",", @{ $c->stash->{attr} }) );
        }


}

=item record

forwarded to C</editor/record>

=cut

sub record : Local {
        my ( $self, $c ) = @_;

        $c->forward( '/editor/record' );
}

=back

=head1 AUTHOR

Dobrica Pavlinusic C<< <dpavlin@rot13.org> >>

=head1 LICENSE

This library is free software, you can redistribute it and/or modify
it under the same terms as Perl itself.

=cut

1;
1	dpavlin	109	package Webpacus::Controller::Search;
2
3			use strict;
4			use warnings;
5			use base 'Catalyst::Controller';
6
7	dpavlin	153	use Data::Dumper;
8
9	dpavlin	109	use lib '/data/webpac2/lib';
10	dpavlin	159	use WebPAC::Search::Estraier 0.03;
11	dpavlin	109
12	dpavlin	153
13	dpavlin	109	=head1 NAME
14
15	dpavlin	155	Webpacus::Controller::Search - Search WebPAC data
16	dpavlin	109
17			=head1 SYNOPSIS
18
19	dpavlin	155	See L<WebPAC>, L<Webpacus>
20	dpavlin	109
21			=head1 DESCRIPTION
22
23	dpavlin	155	Catalyst Controller for search fields Hyper Estraier
24	dpavlin	109
25			=head1 METHODS
26
27			=over 4
28
29			=item default
30
31			=cut
32
33			sub default : Private {
34			my ( $self, $c ) = @_;
35	dpavlin	270
36			$c->log->debug("default search got param: ".Dumper($c->req->params));
37
38	dpavlin	109	$c->stash->{template} = 'search.tt';
39			}
40
41			=item suggest
42
43	dpavlin	326	Returns results for REST URIs like:
44	dpavlin	109
45	dpavlin	326	C<search/suggest?search=FieldName&show=TitleProper&FieldName=query%20string>
46	dpavlin	155
47	dpavlin	326	It will use C<search> field to filter results (and using additional
48			C<FieldName> as value of search) and return C<TitleProper> field
49			for results.
50
51			If C<search> field has magic value <all>, it will search over all data, not
52			just one specified field:
53
54			C<search/suggest?search=all&show=TitleProper&all=query%20string>
55
56	dpavlin	109	=cut
57
58	dpavlin	326	sub suggest : Local {
59	dpavlin	143	my ( $self, $c ) = @_;
60	dpavlin	109
61	dpavlin	326	my $search = $c->req->params->{search};
62			my $show = $c->req->params->{show};
63	dpavlin	109
64	dpavlin	143	my $log = $c->log;
65	dpavlin	109
66	dpavlin	155	my $webpac = $c->comp('Model::WebPAC');
67	dpavlin	109
68	dpavlin	326	my $q = $c->req->params->{ $search \|\| 'all' } \|\| $c->response->body("no results");
69	dpavlin	109
70	dpavlin	326	$log->info("search for '$q' in $search and display $show\n");
71	dpavlin	143
72	dpavlin	155	my $max = $c->config->{'hits_for_suggest'};
73	dpavlin	143	if (! $max) {
74			$log->info("hits_for_suggest isn't defined, defaulting to 10");
75			$c->config->{'hits_for_suggest'} = 10;
76			$max = 10;
77			}
78	dpavlin	109
79	dpavlin	326	$c->forward('filter_database');
80
81	dpavlin	382	my $hits = $webpac->search(
82	dpavlin	155	phrase => $q,
83	dpavlin	326	add_attr => $c->stash->{attr},
84			get_attr => [ $show ],
85	dpavlin	155	max => $max,
86			);
87	dpavlin	109
88	dpavlin	143	my $used;
89			my @suggestions;
90
91	dpavlin	382	foreach my $res (@{$hits}) {
92	dpavlin	326	my $v = $res->{ $show } \|\| next;
93	dpavlin	143	next if ($used->{ $v }++);
94			push @suggestions, $v;
95			}
96
97			$log->debug( ($#suggestions + 1) . " unique hits returned");
98
99	dpavlin	228	$c->response->body( $c->prototype->auto_complete_result( \@suggestions ) );
100	dpavlin	109	}
101
102	dpavlin	153
103			=item results
104
105	dpavlin	270	Returns results for search query
106	dpavlin	153
107			=cut
108
109			sub results : Local {
110			my ( $self, $c ) = @_;
111
112	dpavlin	270	my $params = $c->req->params;
113
114	dpavlin	283	# do full-page refresh for clients without JavaScript
115			$c->stash->{results} = $c->subreq('/search/results/ajax', {}, $params);
116			$c->stash->{template} = 'search.tt';
117	dpavlin	270	}
118
119
120			=item results_ajax
121
122			Private method which uses C<Model::WebPAC> and returns results for search
123			query It generatets just I<inner> HTML for results div, so it has C<_ajax>
124			in name.
125
126			=cut
127
128			# specify all Hyper Estraier operators which should stop this module
129			# from splitting search query and joining it with default operator
130	dpavlin	313	my $hest_op_regex = '(:?\[(:?BW\|EW\|RX)\]\|AND\|OR\|ANDNOT)';
131	dpavlin	270
132			sub results_ajax : Path( 'results/ajax' ) {
133			my ( $self, $c ) = @_;
134
135			my $params = $c->req->params;
136	dpavlin	153	my $webpac = $c->comp('Model::WebPAC');
137			my $log = $c->log;
138
139			$log->debug("results got params: " . Dumper( $params ) );
140
141	dpavlin	200	if (! $params->{_page} \|\| $params->{_page} < 1) {
142	dpavlin	161	$params->{_page} = 1;
143			$log->warn("fixed _page parametar to 1");
144			}
145
146	dpavlin	153	my @words;
147			# default operator to join fields/words
148			my $operator = 'AND';
149
150			foreach my $f (keys %{ $params }) {
151
152			next if ($f =~ m/^_/o);
153
154			my $v = $params->{$f} \|\| next;
155
156			if (my $op = $params->{ '_' . $f}) {
157	dpavlin	313	if ($v =~ /$hest_op_regex/) {
158	dpavlin	153	# don't split words if there is Hyper Estraier
159			# operator in them
160			push @words, $v;
161			} else {
162			push @words, join(" $op ", split(/\s+/, $v) );
163			}
164			} else {
165			push @words, $v;
166			}
167
168			next if ($f eq 'all'); # don't add_attr for magic field all
169
170			if ($v !~ /\s/) {
171	dpavlin	326	push @{ $c->stash->{attr} }, "$f ISTRINC $v";
172	dpavlin	153	} else {
173			map {
174	dpavlin	326	push @{ $c->stash->{attr} }, "$f ISTRINC $_";
175	dpavlin	313	} grep { ! /$hest_op_regex/ } split(/\s+/, $v);
176	dpavlin	153	}
177			}
178
179	dpavlin	326	$c->forward('filter_database');
180	dpavlin	275
181	dpavlin	153	my $q = join(" $operator ", @words);
182
183	dpavlin	155	my $template = $params->{'_template'} \|\| $c->config->{webpac}->{template};
184
185			$log->die("can't find _template or default from configuration!") unless ($template);
186
187	dpavlin	160	my $hits_on_page = $c->config->{'hyperestraier'}->{'hits_on_page'} \|\| 10;
188	dpavlin	153
189	dpavlin	160	$log->debug("using template $template to produce $hits_on_page results");
190
191	dpavlin	153	$c->stash->{html_results} = sub {
192			my $res = $webpac->search(
193			phrase => $q,
194			template => $template,
195	dpavlin	326	add_attr => $c->{stash}->{attr},
196	dpavlin	155	get_attr => [ '@uri' ],
197	dpavlin	160	max => $hits_on_page,
198	dpavlin	159	page => $params->{'_page'},
199	dpavlin	153	);
200	dpavlin	160	# $log->debug("controller got " . ( $#{$res} + 1 ) . " results for '$q' " . Dumper( $res ));
201	dpavlin	153	return $res;
202			};
203
204			$c->stash->{phrase} = $q;
205	dpavlin	160	$c->stash->{page} = $params->{'_page'};
206			$c->stash->{hits_on_page} = $hits_on_page;
207	dpavlin	153
208			$c->stash->{template} = 'results.tt';
209	dpavlin	270
210	dpavlin	153	}
211
212	dpavlin	326	=item filter_database
213
214			Takes C<< $c->req->params >> and adds Hyper Estraier
215			filters for checked databases to C<< $c->stash->{attr} >>.
216
217			=cut
218
219			sub filter_database : Private {
220			my ( $self, $c ) = @_;
221
222			my $params = $c->req->params;
223
224			if ($params->{_database}) {
225			my $type = $c->config->{hyperstraier}->{type} \|\| 'search';
226			my $attr;
227			if (ref($params->{_database}) eq 'ARRAY') {
228			# FIXME do we need to add $ at end?
229			$attr .= '(' . join("\|",@{$params->{_database}}) . ')';
230			} else {
231			$attr .= $params->{_database};
232			}
233			push @{ $c->stash->{attr} }, '@uri STRRX /' . $type . '/' . $attr . '/';
234			$c->log->debug("filter_database: " . join(",", @{ $c->stash->{attr} }) );
235			}
236
237
238			}
239
240	dpavlin	187	=item record
241
242			forwarded to C</editor/record>
243
244			=cut
245
246			sub record : Local {
247			my ( $self, $c ) = @_;
248
249			$c->forward( '/editor/record' );
250			}
251
252	dpavlin	109	=back
253
254			=head1 AUTHOR
255
256	dpavlin	153	Dobrica Pavlinusic C<< <dpavlin@rot13.org> >>
257	dpavlin	109
258			=head1 LICENSE
259
260			This library is free software, you can redistribute it and/or modify
261			it under the same terms as Perl itself.
262
263			=cut
264
265			1;