/[webpac2]/Webpacus/lib/Webpacus/Model/WebPAC.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Diff of /Webpacus/lib/Webpacus/Model/WebPAC.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 378 by dpavlin, Sat Jan 21 23:27:16 2006 UTC revision 405 by dpavlin, Sun Feb 19 22:40:40 2006 UTC
# Line 7  use base qw/ Line 7  use base qw/
7          Catalyst::Model          Catalyst::Model
8  /;  /;
9  use WebPAC::Store 0.08;  use WebPAC::Store 0.08;
10  use WebPAC::Search::Estraier 0.05;  use Search::Estraier 0.04;
11  use File::Slurp;  use File::Slurp;
12  use Time::HiRes qw/time/;  use Time::HiRes qw/time/;
13  use Encode qw/encode decode from_to/;  use Encode qw/encode decode from_to/;
14  use Data::Dumper;  use Template;
15    
16  =head1 NAME  =head1 NAME
17    
# Line 65  sub new { Line 65  sub new {
65    
66          $est_cfg->{encoding} = $est_cfg->{catalyst_encoding} || $c->config->{catalyst_encoding} or $c->log->fatal("can't find catalyst_encoding");          $est_cfg->{encoding} = $est_cfg->{catalyst_encoding} || $c->config->{catalyst_encoding} or $c->log->fatal("can't find catalyst_encoding");
67    
68          $log->debug("using config:" . Dumper($est_cfg) );          $log->dumper($est_cfg, 'est_cfg');
69    
70          if (! $est_cfg->{database}) {          if (! $est_cfg->{database}) {
71                  my $defaultnode = $est_cfg->{defaultnode} || $log->logdie("can't find defaultnode in estraier configuration");                  my $defaultnode = $est_cfg->{defaultnode} || $log->logdie("can't find defaultnode in estraier configuration");
# Line 73  sub new { Line 73  sub new {
73                  $est_cfg->{database} = $defaultnode;                  $est_cfg->{database} = $defaultnode;
74          }          }
75    
76          $self->{est} = new WebPAC::Search::Estraier( %{ $est_cfg } );          my $url = $est_cfg->{masterurl} . '/node/' . $est_cfg->{database};
77    
78            $log->info("opening Hyper Estraier index $url as $est_cfg->{'user'}");
79    
80            $self->{est_node} = Search::Estraier::Node->new(
81                    url => $url,
82                    user => $est_cfg->{user},
83                    passwd => $est_cfg->{passwd},
84            );
85    
86            $log->fatal("can't create Search::Estraier::Node $url") unless ($self->{est_node});
87    
88          # save config parametars in object          # save config parametars in object
89          foreach my $f (qw/db_path template_path hits_on_page webpac_encoding defaultdepth/) {          foreach my $f (qw/
90                    db_path template_path hits_on_page webpac_encoding defaultdepth
91                    masterurl defaultnode
92                    /) {
93                  $self->{$f} = $c->config->{hyperestraier}->{$f} ||                  $self->{$f} = $c->config->{hyperestraier}->{$f} ||
94                          $c->config->{webpac}->{$f};                          $c->config->{webpac}->{$f};
95                  $log->debug("self->{$f} = " . $self->{$f});                  $log->debug("self->{$f} = " . $self->{$f});
# Line 100  sub new { Line 113  sub new {
113                  "'"                  "'"
114          );          );
115    
116          $self->{databases} = $c->config->{databases} || $log->error("can't find databases in config");          $self->{databases} = $c->config->{databases} || $log->fatal("can't find databases in config");
117    
118          $self->{model_record} = $c->comp('Model::Record') or $log->error("can't find Model::Record");          # create Template toolkit instance
119            $self->{'tt'} = Template->new(
120                    INCLUDE_PATH => $template_path,
121                    FILTERS => {
122                            dump_html => sub {
123                                    return unless (@_);
124                                    my $out;
125                                    my $i = 1;
126                                    foreach my $v (@_) {
127                                            $out .= qq{<div id="dump_$i">} .
128                                                    Data::HTMLDumper->Dump([ $v ],[ "v$i" ]) .
129                                                    qq{</div>};
130                                            $i++;
131                                    }
132                                    $out =~ s!<table[^>/]*>!<table class="dump">!gis if ($out);
133                                    return $out;
134                            }
135                    },
136                    EVAL_PERL => 1,
137            );
138    
139          return $self;          return $self;
140    
141  }  }
142    
143    =head2 setup_site
144    
145     $self->setup_site('site_name');
146    
147    Change node URL and database name according to site name (if available) or fallback
148    to C<defaultnode> from configuration.
149    
150    =cut
151    
152    sub setup_site {
153            my $self = shift;
154    
155            my $site = shift || $self->{defaultnode};
156    
157            $self->{log}->fatal("setup_site can't find site or defaultnode") unless ($site);
158    
159            my $url = $self->{masterurl} . '/node/' . $site;
160            $self->{est_node}->set_url( $url );
161            $self->{log}->debug("setup_site $site using $url");
162    }
163    
164  =head2 search  =head2 search
165    
# Line 135  sub search { Line 187  sub search {
187    
188          my $log = $self->{log};          my $log = $self->{log};
189    
190          $log->debug("search args: " . Dumper( $args ));          $log->dumper($args, 'args');
191    
192          my $query = $args->{phrase} || $log->warn("no query phrase") && return;          my $query = $args->{phrase} || $log->warn("no query phrase") && return;
193    
         $log->debug("search model query: '$query'");  
         if ($args->{add_attr}) {  
                 $log->debug(" + add_attr: " .  
                         join("','", @{ $args->{add_attr} })  
                 );  
         }  
   
194          my $template_filename = $args->{template} || $self->{template};          my $template_filename = $args->{template} || $self->{template};
195    
196          $args->{max} ||= $self->{'hits_for_pager'};          $args->{max} ||= $self->{'hits_for_pager'};
# Line 164  sub search { Line 209  sub search {
209                  $args->{depth} = $default;                  $args->{depth} = $default;
210                  $log->warn("using default search depth $default");                  $log->warn("using default search depth $default");
211          }          }
212            $args->{depth} ||= 0;
213    
214          my @results = $self->{est}->search( %{ $args } );          $log->debug("searching for maximum $args->{max} results using depth $args->{depth} phrase: ", $query || '[none]');
215    
216          $times->{est} += time() - $t;          #
217            # construct condition for Hyper Estraier
218            #
219            my $cond = Search::Estraier::Condition->new();
220            if ( ref($args->{add_attr}) eq 'ARRAY' ) {
221                    $log->debug("adding search attributes: " . join(", ", @{ $args->{add_attr} }) );
222                    map {
223                            $cond->add_attr( $_ );
224                            $log->debug(" + $_");
225                    } @{ $args->{add_attr} };
226            };
227    
228            $cond->set_phrase( $query ) if ($query);
229            $cond->set_options( $args->{options} ) if ($args->{options});
230            $cond->set_order( $args->{order} ) if ($args->{order});
231    
232            my $max = $args->{max} || 7;
233            my $page = $args->{page} || 1;
234            if ($page < 1) {
235                    $log->warn("page number $page < 1");
236                    $page = 1;
237            }
238    
239            $cond->set_max( $page * $max );
240    
241          my $hits = $#results + 1;          my $result = $self->{est_node}->search($cond, $args->{depth});
242            my $hits = $result->doc_num;
243    
244          $log->debug( sprintf("search took %.6fs and returned $hits hits.", $times->{est}) );          $times->{est} += time() - $t;
245    
246          # just return results?          $log->debug( sprintf("search took %.6fs and returned $hits hits.", $times->{est}) );
247          return @results unless ($args->{'template'});  
248            $self->{hints} = $result->{hints};
249            $log->dumper($self->{hints}, 'hints' );
250    
251          #          #
252          # construct HTML results          # fetch results
253          #          #
254    
255          my @html_results;          my @results;
256    
257          for my $i ( 0 .. $#results ) {          for my $i ( (($page - 1) * $max) .. ( $hits - 1 ) ) {
258    
259                  my ($database, $prefix, $id);                  $t = time();
260                  if ( $results[$i]->{'@uri'} =~ m!/([^/]+)/([^/]+)/(\d+)$!) {  
261                          ($database, $prefix,$id) = ($1,$2,$3);                  #$log->debug("get_doc($i)");
262                  } else {                  my $doc = $result->get_doc( $i );
263                          $log->warn("can't decode database/prefix/id from " .  $results[$i]->{'@uri'});                  if (! $doc) {
264                            $log->warn("can't find result $i");
265                          next;                          next;
266                  }                  }
267    
268                  #$log->debug("load_ds( id => $id, prefix => '$prefix' )");                  my $hash;
269    
270                  $t = time();                  foreach my $attr (@{ $args->{get_attr} }) {
271                            my $val = $doc->attr( $attr );
272                  my $ds = $self->{db}->load_ds( database => $database, prefix => $prefix, id => $id );                          #$log->debug("attr $attr = ", $val || 'undef');
273                  if (! $ds) {                          $hash->{$attr} = $val if (defined($val));
                         $log->error("can't load_ds( ${database}/${prefix}/${id} )");  
                         next;  
274                  }                  }
275    
276                  $times->{db} += time() - $t;                  $times->{hash} += time() - $t;
277    
278                  #$log->debug( "ds = " . Dumper( \@html_results ) );                  next unless ($hash);
279    
280                  $t = time();                  if (! $args->{'template'}) {
281                            push @results, $hash;
282                    } else {
283                            my ($database, $prefix, $id);
284    
285                            if ( $hash->{'@uri'} =~ m!/([^/]+)/([^/]+)/(\d+)$!) {
286                                    ($database, $prefix,$id) = ($1,$2,$3);
287                            } else {
288                                    $log->warn("can't decode database/prefix/id from " .  $hash->{'@uri'});
289                                    next;
290                            }
291    
292                            #$log->debug("load_ds( id => $id, prefix => '$prefix' )");
293    
294                            $t = time();
295    
296                  my $html = '[no output]';                          my $ds = $self->{db}->load_ds( database => $database, prefix => $prefix, id => $id );
297                            if (! $ds) {
298                                    $log->error("can't load_ds( ${database}/${prefix}/${id} )");
299                                    next;
300                            }
301    
302                  if ($self->{model_record}) {                          $times->{db} += time() - $t;
303                          $html = $self->{model_record}->apply(  
304                            $t = time();
305    
306                            my $html = $self->apply(
307                                  template => $template_filename,                                  template => $template_filename,
308                                  data => $ds,                                  data => $ds,
309                                  record_uri => "${database}/${prefix}/${id}",                                  record_uri => "${database}/${prefix}/${id}",
310                                  config => $self->{databases}->{$database},                                  config => $self->{databases}->{$database},
311                          );                          );
                 } else {  
                         $log->warn("skipped apply");  
                 }  
312    
313                  $times->{out} += time() - $t;                          $times->{apply} += time() - $t;
314    
315                  $t = time();                          $t = time();
316    
317                  $html = decode($self->{webpac_encoding}, $html);                          $html = decode($self->{webpac_encoding}, $html);
318    
319                  push @html_results, $html;                          $times->{decode} += time() - $t;
320    
321          }                          push @results, $html;
322                    }
323    
324          #$log->debug( '@html_results = ' . Dumper( \@html_results ) );          }
325    
326          $log->debug( sprintf(          $log->debug( sprintf(
327                  "duration breakdown: store %.6fs, apply %.6fs, total: %.6fs",                  "duration breakdown: estraier %.6fs, hash %.6fs, store %.6fs, apply %.6fs, decode %.06f, total: %.6fs",
328                  $times->{db}, $times->{out}, time() - $search_start_t,                  $times->{est}, $times->{hash}, $times->{db}, $times->{apply}, $times->{decode}, time() - $search_start_t,
329          ) );          ) );
330    
331          return \@html_results;          return \@results;
332    }
333    
334    =head2 hints
335    
336      my $hints = $m->hints;
337    
338    Return various useful hints about result
339    
340    =cut
341    
342    sub hints {
343            my $self = shift;
344    
345            unless ($self->{hints}) {
346                    $self->{log}->fatal("no hints found!");
347                    return;
348            }
349    
350            my $hints;
351    
352            while (my ($key,$val) = each %{ $self->{hints} }) {
353    
354                    if ($key =~ m/^(?:HITS*|TIME|DOCNUM|WORDNUM)$/) {
355                            $hints->{ lc($key) } = $val;
356                    } elsif ($key =~ m/^HINT#/) {
357                            my ($word,$count) = split(/\t/,$val,2);
358                            $hints->{words}->{$word} = $count;
359                    } elsif ($key =~ m/^LINK#/) {
360                            my ($url,undef,undef,undef,undef,undef,$results) = split(/\t/,$val,7);
361                            if ($url =~ m#/node/(.+)$#) {
362                                    $hints->{node}->{$1} = $results;
363                            }
364                    }
365            }
366    
367            return $hints;
368  }  }
369    
370    
371  =head2 record  =head2 record
372    
373    my $html = $m->record(    my $html = $m->record(
# Line 258  sub record { Line 385  sub record {
385    
386          my $args = {@_};          my $args = {@_};
387          my $log = $self->{log};          my $log = $self->{log};
388          $log->debug("record args: " . Dumper( $args ));          $log->dumper( $args, 'args' );
389    
390          foreach my $f (qw/record_uri template/) {          foreach my $f (qw/record_uri template/) {
391                  $log->fatal("need $f") unless ($args->{$f});                  $log->fatal("need $f") unless ($args->{$f});
# Line 279  sub record { Line 406  sub record {
406                  return;                  return;
407          }          }
408    
409          my $html = $self->{model_record}->apply(          my $html = $self->apply(
410                  template => $args->{template},                  template => $args->{template},
411                  data => $ds,                  data => $ds,
412                  record_uri => $args->{record_uri},                  record_uri => $args->{record_uri},
# Line 292  sub record { Line 419  sub record {
419  }  }
420    
421    
422    =head2 list_nodes
423    
424      my @nodes = $m->list_nodes( 'site' );
425    
426    Return all databases which have records for selected site. Returned array of
427    hashes has elements C<name> and C<label>.
428    
429    =cut
430    
431    sub list_nodes {
432            my $self = shift;
433    
434            my $site = shift;
435    
436            $self->{log}->debug("list_nodes use site $site");
437    
438            $self->setup_site( $site );
439    
440            my @nodes;
441    
442            if ($self->{est_node}->doc_num > 0) {
443                    push @nodes, {
444                            name => $self->{est_node}->name,
445                            label => $self->{est_node}->label,
446                            doc_num => $self->{est_node}->doc_num,
447                    }
448            }
449    
450            # refresh set info
451            $self->{est_node}->_set_info;
452    
453            my $links = $self->{est_node}->links || return @nodes;
454    
455            $self->{log}->dumper( $links, 'links' );
456    
457            foreach my $link (@{ $links }) {
458                    my ($url, $label, $credit) = split(/\t/, $link, 3);
459                    if ($url =~ m#/node/(.+)$#) {
460                            my $node = $1;
461                            $self->setup_site( $node );
462                            $self->{est_node}->_set_info;
463                            push @nodes, {
464                                    name => $node,
465                                    label => $label,
466                                    doc_num => $self->{est_node}->doc_num,
467                            }
468                    } else {
469                            $self->{log}->warn("can't find node name in link $link");
470                    }
471            }
472    
473            $self->setup_site( $site );
474            $self->{est_node}->_set_info;
475    
476            $self->{log}->dumper( \@nodes, 'nodes' );
477    
478            return @nodes;
479    }
480    
481    =cut
482    
483    
484  =head2 save_html  =head2 save_html
485    
486    $m->save_html( '/full/path/to/file', $content );    $m->save_html( '/full/path/to/file', $content );
# Line 348  sub load_html { Line 537  sub load_html {
537          return decode($self->{webpac_encoding}, $content);          return decode($self->{webpac_encoding}, $content);
538  }  }
539    
540    
541    =head2 apply
542    
543    Create output from in-memory data structure using Template Toolkit template.
544    
545     my $text = $tt->apply(
546            template => 'text.tt',
547            data => $ds,
548            record_uri => 'database/prefix/mfn',
549     );
550    
551    It also has follwing template toolikit filter routies defined:
552    
553    =cut
554    
555    sub apply {
556            my $self = shift;
557    
558            my $args = {@_};
559    
560            my $log = $self->{log} || die "no log?";
561    
562            foreach my $a (qw/template data/) {
563                    $log->fatal("need $a") unless ($args->{$a});
564            }
565    
566    =head3 tt_filter_type
567    
568    filter to return values of specified from $ds, usage from TT template is in form
569    C<d('FieldName','delimiter')>, where C<delimiter> is optional, like this:
570    
571      [% d('Title') %]
572      [% d('Author',', ' %]
573    
574    =cut
575    
576            sub tt_filter_type {
577                    my ($data,$type) = @_;
578                    
579                    die "no data?" unless ($data);
580                    $type ||= 'display';
581    
582                    my $default_delimiter = {
583                            'display' => '&#182;<br/>',
584                            'index' => '\n',
585                    };
586    
587                    return sub {
588    
589                            my ($name,$join) = @_;
590    
591                            die "no data hash" unless ($data->{'data'} && ref($data->{'data'}) eq 'HASH');
592                            # Hm? Should we die here?
593                            return unless ($name);
594    
595                            my $item = $data->{'data'}->{$name} || return;
596    
597                            my $v = $item->{$type} || return;
598    
599                            if (ref($v) eq 'ARRAY') {
600                                    if ($#{$v} == 0) {
601                                            $v = $v->[0];
602                                    } else {
603                                            $join = $default_delimiter->{$type} unless defined($join);
604                                            $v = join($join, @{$v});
605                                    }
606                            } else {
607                                    warn("TT filter $type(): field $name values aren't ARRAY, ignoring");
608                            }
609    
610                            return $v;
611                    }
612            }
613    
614            $args->{'d'} = tt_filter_type($args, 'display');
615            $args->{'display'} = tt_filter_type($args, 'display');
616    
617    =head3 tt_filter_search
618    
619    filter to return links to search, usage in TT:
620    
621      [% search('FieldToDisplay','FieldToSearch','optional delimiter', 'optional_template.tt') %]
622    
623    =cut
624    
625            sub tt_filter_search {
626    
627                    my ($data) = @_;
628    
629                    die "no data?" unless ($data);
630                    
631                    return sub {
632    
633                            my ($display,$search,$delimiter,$template) = @_;
634                            
635                            # default delimiter
636                            $delimiter ||= '&#182;<br/>',
637    
638                            die "no data hash" unless ($data->{'data'} && ref($data->{'data'}) eq 'HASH');
639                            # Hm? Should we die here?
640                            return unless ($display);
641    
642                            my $item = $data->{'data'}->{$display} || return;
643    
644                            return unless($item->{'display'});
645                            if (! $item->{'search'}) {
646                                    warn "error in TT template: field $display didn't insert anything into search, use d('$display') and not search('$display'...)";
647                                    return;
648                            }
649    
650                            my @warn;
651                            foreach my $type (qw/display search/) {
652                                    push @warn, "field $display type $type values aren't ARRAY" unless (ref($item->{$type}) eq 'ARRAY');
653                            }
654    
655                            if (@warn) {
656                                    warn("TT filter search(): " . join(",", @warn) . ", skipping");
657                                    return;
658                            }
659                            my @html;
660    
661                            my $d_el = $#{ $item->{'display'} };
662                            my $s_el = $#{ $item->{'search'} };
663    
664                            # easy, both fields have same number of elements or there is just
665                            # one search and multiple display
666                            if ( $d_el == $s_el || $s_el == 0 ) {
667    
668                                    foreach my $i ( 0 .. $d_el ) {
669    
670                                            my $s;
671                                            if ($s_el > 0) {
672                                                    $s = $item->{'search'}->[$i] or warn "can't find value $i for type search in field $search";
673                                            } else {
674                                                    $s = $item->{'search'}->[0];
675                                            }
676                                            #$s =~ s/([^\w.-])/sprintf("%%%02X",ord($1))/eg;
677                                            $s = __quotemeta( $s );
678    
679                                            my $d = $item->{'display'}->[$i] or warn "can't find value $i for type display in field $display";
680    
681                                            my $template_arg = '';
682                                            $template_arg = qq{,'$template'} if ($template);
683    
684                                            push @html, qq{<a href="#" onclick="return search_via_link('$search','$s'${template_arg})">$d</a>};
685                                    }
686    
687                                    return join($delimiter, @html);
688                            } else {
689                                    my $html = qq{<div class="notice">WARNING: we should really support if there is $d_el display elements and $s_el search elements, but currently there is no nice way to do so, so we will just display values</div>};
690                                    my $v = $item->{'display'};
691    
692                                    if ($#{$v} == 0) {
693                                            $html .= $v->[0];
694                                    } else {
695                                            $html .= join($delimiter, @{$v});
696                                    }
697                                    return $html;
698                            }
699                    }
700            }
701    
702            $args->{'search'} = tt_filter_search($args);
703    
704    =head3 load_rec
705    
706    Used mostly for onClick events like this:
707    
708      <a href="#" onClick="[% load_rec( record_uri, 'template_name.tt') %]>foo</a>
709    
710    It will automatically do sanity checking and create correct JavaScript code.
711    
712    =cut
713    
714            $args->{'load_rec'} = sub {
715                    my @errors;
716    
717                    my $record_uri = shift or push @errors, "record_uri missing";
718                    my $template = shift or push @errors, "template missing";
719    
720                    if ($record_uri !~ m#^[^/]+/[^/]+/[^/]+$#) {
721                            push @errors, "invalid format of record_uri: $record_uri";
722                    }
723    
724                    if (@errors) {
725                            return "Logger.error('errors in load_rec: " . join(", ", @errors) . "'); return false;";
726                    } else {
727                            return "load_rec('$record_uri','$template'); return false;";
728                    }
729            };
730    
731    =head3 load_template
732    
733    Used to re-submit search request and load results in different template
734    
735      <a href="#" onClick="[% load_template( 'template_name.tt' ) %]">bar</a>
736    
737    =cut
738    
739            $args->{'load_template'} = sub {
740                    my $template = shift or return "Logger.error('load_template missing template name!'); return false;";
741                    return "load_template($template); return false;";
742            };
743    
744            my $out;
745    
746            $self->{'tt'}->process(
747                    $args->{'template'},
748                    $args,
749                    \$out
750            ) || $log->error( "apply can't process template: ", $self->{'tt'}->error() );
751    
752            return $out;
753    }
754    
755    
756    =head2 __quotemeta
757    
758    Helper to quote JavaScript-friendly characters
759    
760    =cut
761    
762    sub __quotemeta {
763            local $_ = shift;
764            $_ = decode('iso-8859-2', $_);
765    
766            s<([\x{0080}-\x{fffd}]+)>{sprintf '\u%0*v4X', '\u', $1}ge if ( Encode::is_utf8($_) );
767            {
768                    use bytes;  
769                    s<((?:[^ \x21-\x7E]|(?:\\(?!u)))+)>{sprintf '\x%0*v2X', '\x', $1}ge;
770            }
771    
772            s/\\x09/\\t/g;
773            s/\\x0A/\\n/g;
774            s/\\x0D/\\r/g;
775            s/"/\\"/g;
776            s/\\x5C/\\\\/g;
777    
778            return $_;
779    }
780    
781    
782    
783  =head1 AUTHOR  =head1 AUTHOR
784    
785  Dobrica Pavlinusic C<< <dpavlin@rot13.org> >>  Dobrica Pavlinusic C<< <dpavlin@rot13.org> >>
Legend:
Removed from v.378  
changed lines
  Added in v.405
  ViewVC Help
Powered by ViewVC 1.1.26