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 URLs like C<search/suggest/FieldName>

It will return field from URL (C<FieldName> in example>) and use
same filed in paramerers (comming from form or URL) or if it doesn't
exist field named C<all>.

=cut

sub suggest : Regex('^search/suggest/*([^/]*)') {
        my ( $self, $c ) = @_;

        my $what = $c->request->snippets->[0];

        my $log = $c->log;

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

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


        $log->info("search for '$q' in $what\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;
        }

        my @hits = $webpac->search(
                phrase => $q,
                max => $max,
                get_attr => [ $what ],
        );

        my $used;
        my @suggestions;

        foreach my $res (@hits) {
                my $v = $res->{ $what } || 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 = qr/(:?\[(:?BW|EW|RX)\]|AND|OR|ANDNOT)/o;

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 @attr;
        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 @attr, "$f ISTRINC $v";
                } else {
                        map {
                                push @attr, "$f ISTRINC $_";
                        } grep { ! $hest_op_regex } split(/\s+/, $v);
                }
        }

        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 @attr, '@uri STRRX /' . $type . '/' . $attr . '/';
        }

        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 => \@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->{attr} = \@attr;
        $c->stash->{page} = $params->{'_page'};
        $c->stash->{hits_on_page} = $hits_on_page;

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

}

=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			Returns results for URLs like C<search/suggest/FieldName>
44
45	dpavlin	155	It will return field from URL (C<FieldName> in example>) and use
46			same filed in paramerers (comming from form or URL) or if it doesn't
47			exist field named C<all>.
48
49	dpavlin	109	=cut
50
51			sub suggest : Regex('^search/suggest/([^/])') {
52	dpavlin	143	my ( $self, $c ) = @_;
53	dpavlin	109
54	dpavlin	143	my $what = $c->request->snippets->[0];
55	dpavlin	109
56	dpavlin	143	my $log = $c->log;
57	dpavlin	109
58	dpavlin	155	my $webpac = $c->comp('Model::WebPAC');
59	dpavlin	109
60	dpavlin	143	my $q = $c->req->params->{$what} \|\|
61	dpavlin	237	$c->req->params->{all} \|\| $c->response->body("no results");
62	dpavlin	109
63	dpavlin	143
64	dpavlin	109	$log->info("search for '$q' in $what\n");
65
66	dpavlin	155	my $max = $c->config->{'hits_for_suggest'};
67	dpavlin	143	if (! $max) {
68			$log->info("hits_for_suggest isn't defined, defaulting to 10");
69			$c->config->{'hits_for_suggest'} = 10;
70			$max = 10;
71			}
72	dpavlin	109
73	dpavlin	155	my @hits = $webpac->search(
74			phrase => $q,
75			max => $max,
76			get_attr => [ $what ],
77			);
78	dpavlin	109
79	dpavlin	143	my $used;
80			my @suggestions;
81
82			foreach my $res (@hits) {
83			my $v = $res->{ $what } \|\| next;
84			next if ($used->{ $v }++);
85			push @suggestions, $v;
86			}
87
88			$log->debug( ($#suggestions + 1) . " unique hits returned");
89
90	dpavlin	228	$c->response->body( $c->prototype->auto_complete_result( \@suggestions ) );
91	dpavlin	109	}
92
93	dpavlin	153
94			=item results
95
96	dpavlin	270	Returns results for search query
97	dpavlin	153
98			=cut
99
100			sub results : Local {
101			my ( $self, $c ) = @_;
102
103	dpavlin	270	my $params = $c->req->params;
104
105	dpavlin	283	# do full-page refresh for clients without JavaScript
106			$c->stash->{results} = $c->subreq('/search/results/ajax', {}, $params);
107			$c->stash->{template} = 'search.tt';
108	dpavlin	270	}
109
110
111			=item results_ajax
112
113			Private method which uses C<Model::WebPAC> and returns results for search
114			query It generatets just I<inner> HTML for results div, so it has C<_ajax>
115			in name.
116
117			=cut
118
119			# specify all Hyper Estraier operators which should stop this module
120			# from splitting search query and joining it with default operator
121			my $hest_op_regex = qr/(:?\[(:?BW\|EW\|RX)\]\|AND\|OR\|ANDNOT)/o;
122
123			sub results_ajax : Path( 'results/ajax' ) {
124			my ( $self, $c ) = @_;
125
126			my $params = $c->req->params;
127	dpavlin	153	my $webpac = $c->comp('Model::WebPAC');
128			my $log = $c->log;
129
130			$log->debug("results got params: " . Dumper( $params ) );
131
132	dpavlin	200	if (! $params->{_page} \|\| $params->{_page} < 1) {
133	dpavlin	161	$params->{_page} = 1;
134			$log->warn("fixed _page parametar to 1");
135			}
136
137	dpavlin	153	my @attr;
138			my @words;
139			# default operator to join fields/words
140			my $operator = 'AND';
141
142			foreach my $f (keys %{ $params }) {
143
144			next if ($f =~ m/^_/o);
145
146			my $v = $params->{$f} \|\| next;
147
148			if (my $op = $params->{ '_' . $f}) {
149			if ($v =~ $hest_op_regex) {
150			# don't split words if there is Hyper Estraier
151			# operator in them
152			push @words, $v;
153			} else {
154			push @words, join(" $op ", split(/\s+/, $v) );
155			}
156			} else {
157			push @words, $v;
158			}
159
160			next if ($f eq 'all'); # don't add_attr for magic field all
161
162			if ($v !~ /\s/) {
163			push @attr, "$f ISTRINC $v";
164			} else {
165			map {
166			push @attr, "$f ISTRINC $_";
167			} grep { ! $hest_op_regex } split(/\s+/, $v);
168			}
169			}
170
171	dpavlin	275	if ($params->{_database}) {
172			my $type = $c->config->{hyperstraier}->{type} \|\| 'search';
173			my $attr;
174			if (ref($params->{_database}) eq 'ARRAY') {
175			# FIXME do we need to add $ at end?
176			$attr .= '(' . join("\|",@{$params->{_database}}) . ')';
177			} else {
178			$attr .= $params->{_database};
179			}
180			push @attr, '@uri STRRX /' . $type . '/' . $attr . '/';
181			}
182
183	dpavlin	153	my $q = join(" $operator ", @words);
184
185	dpavlin	155	my $template = $params->{'_template'} \|\| $c->config->{webpac}->{template};
186
187			$log->die("can't find _template or default from configuration!") unless ($template);
188
189	dpavlin	160	my $hits_on_page = $c->config->{'hyperestraier'}->{'hits_on_page'} \|\| 10;
190	dpavlin	153
191	dpavlin	160	$log->debug("using template $template to produce $hits_on_page results");
192
193	dpavlin	153	$c->stash->{html_results} = sub {
194			my $res = $webpac->search(
195			phrase => $q,
196			template => $template,
197	dpavlin	155	add_attr => \@attr,
198			get_attr => [ '@uri' ],
199	dpavlin	160	max => $hits_on_page,
200	dpavlin	159	page => $params->{'_page'},
201	dpavlin	153	);
202	dpavlin	160	# $log->debug("controller got " . ( $#{$res} + 1 ) . " results for '$q' " . Dumper( $res ));
203	dpavlin	153	return $res;
204			};
205
206			$c->stash->{phrase} = $q;
207			$c->stash->{attr} = \@attr;
208	dpavlin	160	$c->stash->{page} = $params->{'_page'};
209			$c->stash->{hits_on_page} = $hits_on_page;
210	dpavlin	153
211			$c->stash->{template} = 'results.tt';
212	dpavlin	270
213	dpavlin	153	}
214
215	dpavlin	187	=item record
216
217			forwarded to C</editor/record>
218
219			=cut
220
221			sub record : Local {
222			my ( $self, $c ) = @_;
223
224			$c->forward( '/editor/record' );
225			}
226
227	dpavlin	109	=back
228
229			=head1 AUTHOR
230
231	dpavlin	153	Dobrica Pavlinusic C<< <dpavlin@rot13.org> >>
232	dpavlin	109
233			=head1 LICENSE
234
235			This library is free software, you can redistribute it and/or modify
236			it under the same terms as Perl itself.
237
238			=cut
239
240			1;