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.08;
use WebPAC::Output::TT 0.07;
use WebPAC::Search::Estraier 0.05;
use File::Slurp;
use Time::HiRes;
use Encode qw/encode decode from_to/;
use Data::HTMLDumper;

=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
  hits_for_pager: 1000

 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'

=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} || $c->config->{catalyst_encoding} or $c->log->fatal("can't find 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 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 => {
                        dump_html => sub {
                                my $t = shift || return;
                                #return Data::HTMLDumper->Dumper( $t );
                                return Data::HTMLDumper->Dump([$t],[qw/dump/]);
                        }
                },
        );

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

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

        $self->{databases} = $c->config->{databases} || $log->error("can't find databases in config");

        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("search 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_for_pager'};
        if (! $args->{max}) {
                $args->{max} = 100;
                $log->warn("max not set when calling model. Using default of $args->{max}");
        }

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

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

                $t = time();

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

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

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

                $t = time();

                my $html = $self->{out}->apply(
                        template => $template_filename,
                        data => $ds,
                        record_uri => "${database}/${prefix}/${id}",
                        config => $self->{databases}->{$database},
                );

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

                $t = time();

                $html = decode($self->{webpac_encoding}, $html);

                push @html_results, $html;

        }

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

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

        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("record args: " . Dumper( $args ));

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

        my ($database, $prefix, $id);

        if ($args->{record_uri} =~ m#^([^/]+)/([^/]+)/([^/]+)$#) {
                ($database, $prefix, $id) = ($1,$2,$3);
        } else {
                $log->error("can't parse $args->{record_uri} into prefix, database and uri");
                return;
        }

        my $ds = $self->{db}->load_ds( id => $id, prefix => $prefix, database => $database );
        if (! $ds) {
                $log->error("can't load_ds( $database/$prefix/$id )");
                return;
        }

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

        $html = decode($self->{webpac_encoding}, $html);

        return $html;
}


=head2 save_html

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

It will use C<Encode> 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) = @_;

        # FIXME Should this be UTF-8 or someting?
        my $js_encoding = $self->{webpac_encoding};
        $js_encoding = 'UTF-16';

        sub _conv_js {
                return '0x' . $_[1];
                return encode($_[0], chr(hex($_[1])));
        }
        #$content =~ s/%u([a-fA-F0-9]{4})/_conv_js($js_encoding,$1)/gex;
        $content =~ s/^[\n\r]+//s;
        $content =~ s/[\n\r]+$/\n/s;
        $content =~ s/\n\r/\n/gs;

        my $disk_encoding = $self->{webpac_encoding} || 'utf-8';
        $self->{log}->debug("convert encoding to $disk_encoding");
        from_to($content, 'utf-8', $disk_encoding) || $self->{log}->warn("encoding from utf-8 to $disk_encoding failed for: $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: $!";

        return decode($self->{webpac_encoding}, $content);
}

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