Webpacus/Model/WebPAC.pm

package Webpacus::Model::WebPAC;

use strict;
use warnings;
use lib '/data/webpac2/lib';
use base qw/
        Catalyst::Model
/;
use Data::Dumper;
use WebPAC::Store 0.03;
use WebPAC::Output::TT 0.02;
use WebPAC::Search::Estraier 0.05;
use File::Slurp;
use Time::HiRes;

=head1 NAME

Webpacus::Model::WebPAC - Catalyst Model

=head1 SYNOPSIS

See L<Webpacus> and L<WebPAC>.

=head1 DESCRIPTION

Catalyst Model for access to WebPAC data.

=head2 new

Configuration for hyperestraier in C<config.yaml> like this:

 --- #YAML:1.0
 # DO NOT USE TABS FOR INDENTATION OR label/value SEPARATION!!!

 # configuration for hyper estraier full text search engine
 hyperestraier:
  masterurl: 'http://localhost:1978/node/webpac2'
  defaultnode: 'webpac2'
  defaultdepth: 1
  user: 'admin'
  passwd: 'admin'
  hits_on_page: 100

 webpac:
  db_path: '/data/webpac2/db'
  template_path: '/data/webpac2/conf/output/tt'
  template: 'html_ffzg_results_short.tt'
  # encoding comming from webpac
  webpac_encoding: 'iso-8859-2'
  # encoding expected by Catalyst
  out_encoding: 'UTF-8'

=cut

sub new {
        my ( $self, $c, $config ) = @_;

        $self = $self->NEXT::new($c, $config);
        $self->config($config);

        my $log = $c->log;
        $self->{log} = $log;

        my $est_cfg = $c->config->{hyperestraier};
        $est_cfg->{'log'} = $log;

        $est_cfg->{encoding} = $est_cfg->{catalyst_encoding};

        $log->debug("using config:" . Dumper($est_cfg) );

        if (! $est_cfg->{database}) {
                my $defaultnode = $est_cfg->{defaultnode} || $log->logdie("can't find defaultnode in estraier configuration");
                $log->info("using default node $defaultnode");
                $est_cfg->{database} = $defaultnode;
        }

        $self->{est} = new WebPAC::Search::Estraier( %{ $est_cfg } );

        # save config parametars in object
        foreach my $f (qw/db_path template_path hits_on_page webpac_encoding out_encoding defaultdepth/) {
                $self->{$f} = $c->config->{hyperestraier}->{$f} ||
                        $c->config->{webpac}->{$f};
                $log->debug("self->{$f} = " . $self->{$f});
        }
        my $db_path = $self->{db_path};
        my $template_path = $self->{template_path};

        $log->debug("using db path '$db_path', template path '$template_path'");

        $self->{db} = new WebPAC::Store(
                path => $db_path,
                read_only => 1,
                database => $est_cfg->{database},
        );

        $self->{out} = new WebPAC::Output::TT(
                include_path => $template_path,
                filters => { foo => sub { shift } },
        );

        # default template from config.yaml
        $self->{template} ||= $c->config->{webpac}->{template};

        $self->{iconv} = new Text::Iconv(
                $c->config->{webpac}->{webpac_encoding},
                $c->config->{webpac}->{out_encoding}
        );

        $log->debug("converting encoding from webpac_encoding '" .
                $c->config->{webpac}->{webpac_encoding} .
                "' to '" .
                $c->config->{webpac}->{out_encoding} .
                "'"
        );


        return $self;

}


=head2 search

  my $m->search(
        phrase => 'query phrase',
        add_attr => \@add_attr
        get_attr => [ '@uri' ],
        max => 42,
        template => 'result_template.tt',
        depth => 1,
  );

All fields are standard C<WebPAC::Search::Estraier> parametars except
C<template> which will (if specified) return results in HTML using
selected template.

=cut

sub search {
        my $self = shift;

        my $args = {@_};

        my $log = $self->{log};

        $log->debug("args: " . Dumper( $args ));

        my $query = $args->{phrase} || $log->warn("no query phrase") && return;

        $log->debug("search model query: '$query'");
        if ($args->{add_attr}) {
                $log->debug(" + add_attr: " .
                        join("','", @{ $args->{add_attr} })
                );
        }

        my $template_filename = $args->{template} || $self->{template};

        $args->{max} ||= $self->{'hits_on_page'};
        if (! $args->{max}) {
                $args->{max} = 10;
                $log->warn("max not set when calling model. Using default of 10");
        }

        my $times;      # store some times for benchmarking

        my $t = time();

        # transfer depth of search
        if (! $args->{depth}) {
                my $default = $self->{defaultdepth} || $log->logdie("can't find defaultdepth in estraier configuration");
                $args->{depth} = $default;
                $log->warn("using default search depth $default");
        }

        my @results = $self->{est}->search( %{ $args } );

        $times->{est} += time() - $t;

        my $hits = $#results + 1;

        $log->debug( sprintf("search took %.2fs and returned $hits hits.", $times->{est}) );

        # just return results?
        return @results unless ($args->{'template'});

        #
        # construct HTML results
        #

        my @html_results;

        for my $i ( 0 .. $#results ) {

                my ($id, $prefix);
                if ( $results[$i]->{'@uri'} =~ m!/([^/]+)#(\d+)$!) {
                        ($prefix,$id) = ($1,$2);
                } else {
                        $log->warn("can't decode prefix#id from " .  $results[$i]->{'@uri'});
                        next;
                }

                #$log->debug("load_ds( id => $id, prefix => '$prefix' )");

                $t = time();

                my $ds = $self->{db}->load_ds( id => $id, prefix => $prefix ) || $log->error("can't load_ds( id => $id, prefix => '$prefix' )") && next;

                $times->{db} += time() - $t;

                #$log->debug( "ds = " . Dumper( \@html_results ) );

                $t = time();

                my $html = $self->{out}->apply(
                        template => $template_filename,
                        data => $ds,
                );

                $times->{out} += time() - $t;

                $t = time();

                $html = $self->{iconv}->convert( $html ) || $log->error("can't convert: $html");

                $times->{iconv} += time() - $t;

                push @html_results, $html;

        }

        #$log->debug( '@html_results = ' . Dumper( \@html_results ) );

        $log->debug( sprintf(
                "time spent: db = %.2f, out = %.2f, iconv = %.2f",
                $times->{db}, $times->{out}, $times->{iconv},
        ) );

        return \@html_results;
}

=head2 record

  my $html = $m->record(
        mfn => 42,
        template => 'foo.tt',
  );

This will load one record, convert it to html using C<template> and return
it.

=cut

sub record {
        my $self = shift;

        my $args = {@_};
        my $log = $self->{log};
        $log->debug("args: " . Dumper( $args ));

        foreach my $f (qw/mfn template prefix/) {
                $log->fatal("need $f") unless ($args->{$f});
        }

        my $mfn = $args->{mfn};

        my $ds = $self->{db}->load_ds( id => $mfn, prefix => 'FIXME' ) || $log->error("can't load_ds( $mfn )") && return;

        my $html = $self->{out}->apply(
                template => $args->{template},
                data => $ds,
        );

        $html = $self->{iconv}->convert( $html ) || $log->error("can't convert: $html");

        return $html;
}

=head2 save_html

  $m->save_html( '/full/path/to/file', $content );

It will use C<Text::Iconv> to convert content encoding back to
Webpac codepage, recode JavaScript Unicode entities (%u1234),
strip extra newlines at beginning and end, and save to 
C</full/path/to/file.new> and if that succeeds, just rename
it over original file which should be atomic on filesystem level.

=cut

sub save_html {
        my ($self, $path, $content) = @_;

        sub _conv_js {
                my $t = shift || return;
                return $self->{iconv}->convert(chr(hex($t)));
        }
        $content =~ s/%u([a-fA-F0-9]{4})/_conv_js($1)/gex;
        $content =~ s/^[\n\r]+//s;
        $content =~ s/[\n\r]+$/\n/s;

        my ($from, $to) = (
                $self->{out_encoding},
                $self->{webpac_encoding},
        );

        $self->{log}->debug("using iconv to convert from $from to $to encoding");

        my $iconv_on_save = new Text::Iconv($from, $to)
                || $self->{log}->fatal("can't create iconv for saving");

        $content = $iconv_on_save->convert( $content ) || die "no content?";

        write_file($path . '.new', {binmode => ':raw' }, $content) || die "can't save ${path}.new $!";
        rename $path . '.new', $path || die "can't rename to $path: $!";
}

=head2 load_html

  my $html = $m->load_html('/full/path/to/file');

This will convert file from Webpac encoding to Catalyst and
convert that data to escaped HTML (for sending into
C<< <textarea/> >> tags in html.

=cut

sub load_html {
        my ($self, $path) = @_;

        die "no path?" unless ($path);

        my $content = read_file($path, {binmode => ':raw' }) || die "can't read $path: $!";
        #$content = $q->escapeHTML($iconv_utf8->convert($content));
        $content = $self->{iconv}->convert($content);

        return $content;
}

=head1 AUTHOR

Dobrica Pavlinusic

=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	92	package Webpacus::Model::WebPAC;
2
3			use strict;
4			use warnings;
5			use lib '/data/webpac2/lib';
6	dpavlin	93	use base qw/
7			Catalyst::Model
8			/;
9	dpavlin	92	use Data::Dumper;
10	dpavlin	222	use WebPAC::Store 0.03;
11	dpavlin	200	use WebPAC::Output::TT 0.02;
12	dpavlin	222	use WebPAC::Search::Estraier 0.05;
13	dpavlin	135	use File::Slurp;
14	dpavlin	155	use Time::HiRes;
15	dpavlin	92
16			=head1 NAME
17
18			Webpacus::Model::WebPAC - Catalyst Model
19
20			=head1 SYNOPSIS
21
22			See L<Webpacus> and L<WebPAC>.
23
24			=head1 DESCRIPTION
25
26			Catalyst Model for access to WebPAC data.
27
28			=head2 new
29
30			Configuration for hyperestraier in C<config.yaml> like this:
31
32			--- #YAML:1.0
33			# DO NOT USE TABS FOR INDENTATION OR label/value SEPARATION!!!
34
35			# configuration for hyper estraier full text search engine
36			hyperestraier:
37	dpavlin	222	masterurl: 'http://localhost:1978/node/webpac2'
38			defaultnode: 'webpac2'
39			defaultdepth: 1
40	dpavlin	96	user: 'admin'
41			passwd: 'admin'
42	dpavlin	143	hits_on_page: 100
43	dpavlin	92
44	dpavlin	96	webpac:
45			db_path: '/data/webpac2/db'
46			template_path: '/data/webpac2/conf/output/tt'
47			template: 'html_ffzg_results_short.tt'
48			# encoding comming from webpac
49			webpac_encoding: 'iso-8859-2'
50			# encoding expected by Catalyst
51			out_encoding: 'UTF-8'
52
53	dpavlin	92	=cut
54
55			sub new {
56			my ( $self, $c, $config ) = @_;
57
58			$self = $self->NEXT::new($c, $config);
59			$self->config($config);
60
61			my $log = $c->log;
62	dpavlin	94	$self->{log} = $log;
63	dpavlin	92
64	dpavlin	93	my $est_cfg = $c->config->{hyperestraier};
65			$est_cfg->{'log'} = $log;
66	dpavlin	92
67	dpavlin	142	$est_cfg->{encoding} = $est_cfg->{catalyst_encoding};
68
69	dpavlin	93	$log->debug("using config:" . Dumper($est_cfg) );
70	dpavlin	92
71	dpavlin	222	if (! $est_cfg->{database}) {
72			my $defaultnode = $est_cfg->{defaultnode} \|\| $log->logdie("can't find defaultnode in estraier configuration");
73			$log->info("using default node $defaultnode");
74			$est_cfg->{database} = $defaultnode;
75			}
76
77	dpavlin	93	$self->{est} = new WebPAC::Search::Estraier( %{ $est_cfg } );
78	dpavlin	92
79	dpavlin	167	# save config parametars in object
80	dpavlin	222	foreach my $f (qw/db_path template_path hits_on_page webpac_encoding out_encoding defaultdepth/) {
81	dpavlin	167	$self->{$f} = $c->config->{hyperestraier}->{$f} \|\|
82			$c->config->{webpac}->{$f};
83			$log->debug("self->{$f} = " . $self->{$f});
84			}
85			my $db_path = $self->{db_path};
86			my $template_path = $self->{template_path};
87	dpavlin	95
88			$log->debug("using db path '$db_path', template path '$template_path'");
89
90	dpavlin	222	$self->{db} = new WebPAC::Store(
91	dpavlin	95	path => $db_path,
92			read_only => 1,
93	dpavlin	224	database => $est_cfg->{database},
94	dpavlin	95	);
95
96			$self->{out} = new WebPAC::Output::TT(
97			include_path => $template_path,
98			filters => { foo => sub { shift } },
99			);
100
101	dpavlin	101	# default template from config.yaml
102	dpavlin	95	$self->{template} \|\|= $c->config->{webpac}->{template};
103
104	dpavlin	96	$self->{iconv} = new Text::Iconv(
105			$c->config->{webpac}->{webpac_encoding},
106			$c->config->{webpac}->{out_encoding}
107			);
108
109	dpavlin	100	$log->debug("converting encoding from webpac_encoding '" .
110			$c->config->{webpac}->{webpac_encoding} .
111			"' to '" .
112			$c->config->{webpac}->{out_encoding} .
113	dpavlin	99	"'"
114			);
115	dpavlin	96
116	dpavlin	155
117	dpavlin	92	return $self;
118
119			}
120
121	dpavlin	135
122			=head2 search
123
124	dpavlin	150	my $m->search(
125			phrase => 'query phrase',
126	dpavlin	155	add_attr => \@add_attr
127			get_attr => [ '@uri' ],
128			max => 42,
129	dpavlin	150	template => 'result_template.tt',
130	dpavlin	222	depth => 1,
131	dpavlin	150	);
132	dpavlin	135
133	dpavlin	155	All fields are standard C<WebPAC::Search::Estraier> parametars except
134			C<template> which will (if specified) return results in HTML using
135			selected template.
136
137	dpavlin	135	=cut
138
139	dpavlin	93	sub search {
140	dpavlin	150	my $self = shift;
141	dpavlin	93
142	dpavlin	150	my $args = {@_};
143
144	dpavlin	95	my $log = $self->{log};
145	dpavlin	94
146	dpavlin	150	$log->debug("args: " . Dumper( $args ));
147	dpavlin	95
148	dpavlin	150	my $query = $args->{phrase} \|\| $log->warn("no query phrase") && return;
149	dpavlin	95
150	dpavlin	155	$log->debug("search model query: '$query'");
151			if ($args->{add_attr}) {
152			$log->debug(" + add_attr: " .
153			join("','", @{ $args->{add_attr} })
154			);
155			}
156	dpavlin	150
157			my $template_filename = $args->{template} \|\| $self->{template};
158
159	dpavlin	155	$args->{max} \|\|= $self->{'hits_on_page'};
160			if (! $args->{max}) {
161			$args->{max} = 10;
162			$log->warn("max not set when calling model. Using default of 10");
163			}
164	dpavlin	93
165	dpavlin	155	my $times; # store some times for benchmarking
166
167			my $t = time();
168
169	dpavlin	222	# transfer depth of search
170			if (! $args->{depth}) {
171			my $default = $self->{defaultdepth} \|\| $log->logdie("can't find defaultdepth in estraier configuration");
172			$args->{depth} = $default;
173			$log->warn("using default search depth $default");
174			}
175
176	dpavlin	155	my @results = $self->{est}->search( %{ $args } );
177
178			$times->{est} += time() - $t;
179
180	dpavlin	150	my $hits = $#results + 1;
181	dpavlin	99
182	dpavlin	155	$log->debug( sprintf("search took %.2fs and returned $hits hits.", $times->{est}) );
183	dpavlin	150
184	dpavlin	155	# just return results?
185			return @results unless ($args->{'template'});
186
187			#
188			# construct HTML results
189			#
190
191	dpavlin	100	my @html_results;
192
193	dpavlin	95	for my $i ( 0 .. $#results ) {
194
195	dpavlin	224	my ($id, $prefix);
196			if ( $results[$i]->{'@uri'} =~ m!/([^/]+)#(\d+)$!) {
197			($prefix,$id) = ($1,$2);
198			} else {
199			$log->warn("can't decode prefix#id from " . $results[$i]->{'@uri'});
200			next;
201			}
202	dpavlin	95
203	dpavlin	224	#$log->debug("load_ds( id => $id, prefix => '$prefix' )");
204	dpavlin	95
205	dpavlin	155	$t = time();
206
207	dpavlin	224	my $ds = $self->{db}->load_ds( id => $id, prefix => $prefix ) \|\| $log->error("can't load_ds( id => $id, prefix => '$prefix' )") && next;
208	dpavlin	155
209			$times->{db} += time() - $t;
210
211	dpavlin	115	#$log->debug( "ds = " . Dumper( \@html_results ) );
212
213	dpavlin	155	$t = time();
214
215	dpavlin	100	my $html = $self->{out}->apply(
216	dpavlin	95	template => $template_filename,
217			data => $ds,
218	dpavlin	100	);
219
220	dpavlin	155	$times->{out} += time() - $t;
221
222			$t = time();
223
224	dpavlin	100	$html = $self->{iconv}->convert( $html ) \|\| $log->error("can't convert: $html");
225
226	dpavlin	155	$times->{iconv} += time() - $t;
227
228	dpavlin	100	push @html_results, $html;
229
230	dpavlin	95	}
231
232	dpavlin	115	#$log->debug( '@html_results = ' . Dumper( \@html_results ) );
233
234	dpavlin	155	$log->debug( sprintf(
235			"time spent: db = %.2f, out = %.2f, iconv = %.2f",
236			$times->{db}, $times->{out}, $times->{iconv},
237			) );
238
239	dpavlin	100	return \@html_results;
240	dpavlin	93	}
241
242	dpavlin	165	=head2 record
243
244			my $html = $m->record(
245			mfn => 42,
246			template => 'foo.tt',
247			);
248
249			This will load one record, convert it to html using C<template> and return
250			it.
251
252			=cut
253
254			sub record {
255			my $self = shift;
256
257			my $args = {@_};
258			my $log = $self->{log};
259			$log->debug("args: " . Dumper( $args ));
260
261	dpavlin	224	foreach my $f (qw/mfn template prefix/) {
262	dpavlin	228	$log->fatal("need $f") unless ($args->{$f});
263	dpavlin	165	}
264
265			my $mfn = $args->{mfn};
266
267	dpavlin	228	my $ds = $self->{db}->load_ds( id => $mfn, prefix => 'FIXME' ) \|\| $log->error("can't load_ds( $mfn )") && return;
268	dpavlin	165
269			my $html = $self->{out}->apply(
270			template => $args->{template},
271			data => $ds,
272			);
273
274			$html = $self->{iconv}->convert( $html ) \|\| $log->error("can't convert: $html");
275
276			return $html;
277			}
278
279	dpavlin	135	=head2 save_html
280	dpavlin	93
281	dpavlin	135	$m->save_html( '/full/path/to/file', $content );
282	dpavlin	93
283	dpavlin	179	It will use C<Text::Iconv> to convert content encoding back to
284	dpavlin	135	Webpac codepage, recode JavaScript Unicode entities (%u1234),
285			strip extra newlines at beginning and end, and save to
286			C</full/path/to/file.new> and if that succeeds, just rename
287			it over original file which should be atomic on filesystem level.
288
289			=cut
290
291			sub save_html {
292			my ($self, $path, $content) = @_;
293
294			sub _conv_js {
295			my $t = shift \|\| return;
296			return $self->{iconv}->convert(chr(hex($t)));
297			}
298			$content =~ s/%u([a-fA-F0-9]{4})/_conv_js($1)/gex;
299			$content =~ s/^[\n\r]+//s;
300			$content =~ s/[\n\r]+$/\n/s;
301
302	dpavlin	179	my ($from, $to) = (
303			$self->{out_encoding},
304			$self->{webpac_encoding},
305	dpavlin	178	);
306	dpavlin	179
307			$self->{log}->debug("using iconv to convert from $from to $to encoding");
308
309			my $iconv_on_save = new Text::Iconv($from, $to)
310			\|\| $self->{log}->fatal("can't create iconv for saving");
311
312	dpavlin	178	$content = $iconv_on_save->convert( $content ) \|\| die "no content?";
313
314	dpavlin	179	write_file($path . '.new', {binmode => ':raw' }, $content) \|\| die "can't save ${path}.new $!";
315	dpavlin	135	rename $path . '.new', $path \|\| die "can't rename to $path: $!";
316			}
317
318			=head2 load_html
319
320			my $html = $m->load_html('/full/path/to/file');
321
322			This will convert file from Webpac encoding to Catalyst and
323			convert that data to escaped HTML (for sending into
324			C<< <textarea/> >> tags in html.
325
326			=cut
327
328			sub load_html {
329			my ($self, $path) = @_;
330
331			die "no path?" unless ($path);
332
333	dpavlin	179	my $content = read_file($path, {binmode => ':raw' }) \|\| die "can't read $path: $!";
334	dpavlin	135	#$content = $q->escapeHTML($iconv_utf8->convert($content));
335			$content = $self->{iconv}->convert($content);
336
337			return $content;
338			}
339
340	dpavlin	92	=head1 AUTHOR
341
342			Dobrica Pavlinusic
343
344			=head1 LICENSE
345
346			This library is free software, you can redistribute it and/or modify
347			it under the same terms as Perl itself.
348
349			=cut
350
351			1;