| 3 |
use warnings; |
use warnings; |
| 4 |
use strict; |
use strict; |
| 5 |
|
|
| 6 |
|
use base qw/WebPAC::Common/; |
| 7 |
|
|
| 8 |
|
use HyperEstraier; |
| 9 |
|
use Text::Iconv; |
| 10 |
|
use Data::Dumper; |
| 11 |
|
use LWP; |
| 12 |
|
use URI::Escape; |
| 13 |
|
|
| 14 |
=head1 NAME |
=head1 NAME |
| 15 |
|
|
| 16 |
WebPAC::Output::Estraier - The great new WebPAC::Output::Estraier! |
WebPAC::Output::Estraier - Create Hyper Estraier full text index |
| 17 |
|
|
| 18 |
=head1 VERSION |
=head1 VERSION |
| 19 |
|
|
| 20 |
Version 0.01 |
Version 0.04 |
| 21 |
|
|
| 22 |
=cut |
=cut |
| 23 |
|
|
| 24 |
our $VERSION = '0.01'; |
our $VERSION = '0.04'; |
| 25 |
|
|
| 26 |
=head1 SYNOPSIS |
=head1 SYNOPSIS |
| 27 |
|
|
| 28 |
Quick summary of what the module does. |
Create full text index using Hyper Estraier index from data with |
| 29 |
|
type C<search>. |
| 30 |
|
|
| 31 |
|
=head1 FUNCTIONS |
| 32 |
|
|
| 33 |
Perhaps a little code snippet. |
=head2 new |
| 34 |
|
|
| 35 |
use WebPAC::Output::Estraier; |
Connect to Hyper Estraier index using HTTP |
| 36 |
|
|
| 37 |
my $foo = WebPAC::Output::Estraier->new(); |
my $est = new WebPAC::Output::Estraier( |
| 38 |
... |
masterurl => 'http://localhost:1978/', |
| 39 |
|
user => 'admin', |
| 40 |
|
passwd => 'admin', |
| 41 |
|
database => 'demo', |
| 42 |
|
encoding => 'iso-8859-2', |
| 43 |
|
); |
| 44 |
|
|
| 45 |
=head1 EXPORT |
Options are: |
| 46 |
|
|
| 47 |
A list of functions that can be exported. You can delete this section |
=over 4 |
|
if you don't export anything, such as for a purely object-oriented module. |
|
| 48 |
|
|
| 49 |
=head1 FUNCTIONS |
=item masterurl |
| 50 |
|
|
| 51 |
|
URI to C<estmaster> node |
| 52 |
|
|
| 53 |
|
=item user |
| 54 |
|
|
| 55 |
|
C<estmaster> user with sufficient rights |
| 56 |
|
|
| 57 |
|
=item passwd |
| 58 |
|
|
| 59 |
|
password for user |
| 60 |
|
|
| 61 |
|
=item database |
| 62 |
|
|
| 63 |
=head2 function1 |
name of database from which data comes |
| 64 |
|
|
| 65 |
|
=item encoding |
| 66 |
|
|
| 67 |
|
character encoding of C<data_structure> if it's differenet than C<ISO-8859-2> |
| 68 |
|
(and it probably is). This encoding will be converted to C<UTF-8> for |
| 69 |
|
Hyper Estraier. |
| 70 |
|
|
| 71 |
|
=back |
| 72 |
|
|
| 73 |
|
Name of database will be used to form URI of documents in index. |
| 74 |
|
|
| 75 |
=cut |
=cut |
| 76 |
|
|
| 77 |
sub function1 { |
sub new { |
| 78 |
|
my $class = shift; |
| 79 |
|
my $self = {@_}; |
| 80 |
|
bless($self, $class); |
| 81 |
|
|
| 82 |
|
my $log = $self->_get_logger; |
| 83 |
|
|
| 84 |
|
#$log->debug("self: ", sub { Dumper($self) }); |
| 85 |
|
|
| 86 |
|
foreach my $p (qw/masterurl user passwd database/) { |
| 87 |
|
$log->logdie("need $p") unless ($self->{$p}); |
| 88 |
|
} |
| 89 |
|
|
| 90 |
|
my $url = $self->{masterurl} . '/node/' . $self->{database}; |
| 91 |
|
$self->{url} = $url; |
| 92 |
|
|
| 93 |
|
$log->info("opening Hyper Estraier index $self->{url}"); |
| 94 |
|
|
| 95 |
|
my $nodes = $self->est_master( action => 'nodelist' ); |
| 96 |
|
|
| 97 |
|
$log->debug("nodes found: $nodes"); |
| 98 |
|
|
| 99 |
|
if ($nodes !~ m/^$self->{database}\t/sm) { |
| 100 |
|
$log->info("creating index $url"); |
| 101 |
|
$self->est_master( |
| 102 |
|
action => 'nodeadd', |
| 103 |
|
name => $self->{database}, |
| 104 |
|
label => "WebPAC $self->{database}", |
| 105 |
|
) || $log->logdie("can't create Hyper Estraier node $self->{database}"); |
| 106 |
|
} |
| 107 |
|
|
| 108 |
|
$self->{'db'} = HyperEstraier::Node->new($self->{url}); |
| 109 |
|
$self->{'db'}->set_auth($self->{'user'}, $self->{passwd}); |
| 110 |
|
|
| 111 |
|
my $encoding = $self->{'encoding'} || 'ISO-8859-2'; |
| 112 |
|
$log->info("using encoding $encoding"); |
| 113 |
|
|
| 114 |
|
$self->{'iconv'} = new Text::Iconv($encoding, 'UTF-8') or |
| 115 |
|
$log->logdie("can't create conversion from $encoding to UTF-8"); |
| 116 |
|
|
| 117 |
|
$self ? return $self : return undef; |
| 118 |
} |
} |
| 119 |
|
|
| 120 |
=head2 function2 |
|
| 121 |
|
=head2 add |
| 122 |
|
|
| 123 |
|
Adds one entry to database. |
| 124 |
|
|
| 125 |
|
$est->add( |
| 126 |
|
id => 42, |
| 127 |
|
ds => $ds, |
| 128 |
|
type => 'display', |
| 129 |
|
text => 'optional text from which snippet is created', |
| 130 |
|
); |
| 131 |
|
|
| 132 |
|
This function will create entries in index using following URI format: |
| 133 |
|
|
| 134 |
|
C<file:///type/database%20name/000> |
| 135 |
|
|
| 136 |
|
Each tag in C<data_structure> with specified C<type> will create one |
| 137 |
|
attribute and corresponding hidden text (used for search). |
| 138 |
|
|
| 139 |
=cut |
=cut |
| 140 |
|
|
| 141 |
sub function2 { |
sub add { |
| 142 |
|
my $self = shift; |
| 143 |
|
|
| 144 |
|
my $args = {@_}; |
| 145 |
|
|
| 146 |
|
my $log = $self->_get_logger; |
| 147 |
|
|
| 148 |
|
my $database = $self->{'database'} || $log->logconfess('no database in $self'); |
| 149 |
|
$log->logconfess('need db in object') unless ($self->{'db'}); |
| 150 |
|
|
| 151 |
|
foreach my $p (qw/id ds type/) { |
| 152 |
|
$log->logdie("need $p") unless ($args->{$p}); |
| 153 |
|
} |
| 154 |
|
|
| 155 |
|
my $type = $args->{'type'}; |
| 156 |
|
my $id = $args->{'id'}; |
| 157 |
|
|
| 158 |
|
my $uri = "file:///$type/$database/$id"; |
| 159 |
|
$log->debug("creating $uri"); |
| 160 |
|
|
| 161 |
|
my $doc = HyperEstraier::Document->new; |
| 162 |
|
$doc->add_attr('@uri', $self->{'iconv'}->convert($uri) ); |
| 163 |
|
|
| 164 |
|
$log->debug("ds = ", sub { Dumper($args->{'ds'}) } ); |
| 165 |
|
|
| 166 |
|
# filter all tags which have type defined |
| 167 |
|
my @tags = grep { |
| 168 |
|
ref($args->{'ds'}->{$_}) eq 'HASH' && defined( $args->{'ds'}->{$_}->{$type} ) |
| 169 |
|
} keys %{ $args->{'ds'} }; |
| 170 |
|
|
| 171 |
|
$log->debug("tags = ", join(",", @tags)); |
| 172 |
|
|
| 173 |
|
return unless (@tags); |
| 174 |
|
|
| 175 |
|
foreach my $tag (@tags) { |
| 176 |
|
|
| 177 |
|
my $vals = join(" ", @{ $args->{'ds'}->{$tag}->{$type} }); |
| 178 |
|
|
| 179 |
|
$log->logconfess("no values for $tag/$type") unless ($vals); |
| 180 |
|
|
| 181 |
|
$vals = $self->{'iconv'}->convert( $vals ) or |
| 182 |
|
$log->logdie("can't convert '$vals' to UTF-8"); |
| 183 |
|
|
| 184 |
|
$doc->add_attr( $tag, $vals ); |
| 185 |
|
$doc->add_hidden_text( $vals ); |
| 186 |
|
} |
| 187 |
|
|
| 188 |
|
my $text = $args->{'text'}; |
| 189 |
|
if ( $text ) { |
| 190 |
|
$text = $self->{'iconv'}->convert( $text ) or |
| 191 |
|
$log->logdie("can't convert '$text' to UTF-8"); |
| 192 |
|
$doc->add_text( $text ); |
| 193 |
|
} |
| 194 |
|
|
| 195 |
|
$log->debug("adding ", sub { $doc->dump_draft } ); |
| 196 |
|
$self->{'db'}->put_doc($doc) || $log->logdie("can't add document $uri to node " . $self->{url} . " status: " . $self->{db}->status()); |
| 197 |
|
|
| 198 |
|
return 1; |
| 199 |
} |
} |
| 200 |
|
|
| 201 |
=head1 AUTHOR |
=head2 est_master |
| 202 |
|
|
| 203 |
Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >> |
Issue administrative commands to C<estmaster> process and receive response |
| 204 |
|
as array of lines |
| 205 |
|
|
| 206 |
|
my $nodelist = $self->est_master( action => nodelist ); |
| 207 |
|
|
| 208 |
|
=cut |
| 209 |
|
|
| 210 |
|
my $estmaster_actions = { |
| 211 |
|
userdel => [ qw/name/ ], |
| 212 |
|
nodelist => [], |
| 213 |
|
nodeadd => [ qw/name label/ ], |
| 214 |
|
nodedel => [ qw/name/ ], |
| 215 |
|
}; |
| 216 |
|
|
| 217 |
|
=head2 est_ua |
| 218 |
|
|
| 219 |
|
Make C<LWP::UserAgent> object with Super User priviledges |
| 220 |
|
|
| 221 |
|
my $ua = $self->est_ua( user => 'admin', passwd => 'admin' ); |
| 222 |
|
|
| 223 |
=head1 BUGS |
=cut |
| 224 |
|
|
| 225 |
|
sub est_ua { |
| 226 |
|
my $self = shift; |
| 227 |
|
|
| 228 |
|
return $self->{_master_ua} if ($self->{_master_ua}); |
| 229 |
|
|
| 230 |
|
$self->{_master_ua} = LWP::UserAgent->new( ) || sub { |
| 231 |
|
my $log = $self->_get_logger; |
| 232 |
|
$log->logdie("can't create LWP::UserAgent: $!"); |
| 233 |
|
}; |
| 234 |
|
|
| 235 |
|
$self->{_master_ua}->credentials('localhost:1978','Super User', $self->{user} => $self->{passwd}); |
| 236 |
|
|
| 237 |
|
return $self->{_master_ua}; |
| 238 |
|
} |
| 239 |
|
|
| 240 |
|
sub est_master { |
| 241 |
|
my $self = shift; |
| 242 |
|
my $args = {@_}; |
| 243 |
|
my $log = $self->_get_logger; |
| 244 |
|
|
| 245 |
|
$log->debug(Dumper($args)); |
| 246 |
|
|
| 247 |
|
my $action = $args->{action} || $log->logconfess("no action specified"); |
| 248 |
|
|
| 249 |
Please report any bugs or feature requests to |
$log->logdie("action '$action' isn't supported") unless ($estmaster_actions->{$action}); |
|
C<bug-webpac-output-estraier@rt.cpan.org>, or through the web interface at |
|
|
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WebPAC>. |
|
|
I will be notified, and then you'll automatically be notified of progress on |
|
|
your bug as I make changes. |
|
| 250 |
|
|
| 251 |
=head1 ACKNOWLEDGEMENTS |
my $url = $self->{masterurl} . '/master?action=' . $action; |
| 252 |
|
|
| 253 |
|
foreach my $arg (@{ $estmaster_actions->{$action} }) { |
| 254 |
|
$log->logdie("missing parametar $arg for action $action") unless ($args->{$arg}); |
| 255 |
|
$url .= '&' . $arg . '=' . uri_escape( $args->{$arg} ); |
| 256 |
|
} |
| 257 |
|
|
| 258 |
|
$log->debug("calling $url"); |
| 259 |
|
|
| 260 |
|
my $res = $self->est_ua()->get($url); |
| 261 |
|
|
| 262 |
|
if ($res->is_success) { |
| 263 |
|
#$log->debug( $res->content ); |
| 264 |
|
return split(/\n/, $res->content) if wantarray; |
| 265 |
|
return $res->content; |
| 266 |
|
} else { |
| 267 |
|
$log->warn("unable to call $url: " . $res->status_line); |
| 268 |
|
return; |
| 269 |
|
} |
| 270 |
|
|
| 271 |
|
} |
| 272 |
|
|
| 273 |
|
=head1 AUTHOR |
| 274 |
|
|
| 275 |
|
Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >> |
| 276 |
|
|
| 277 |
=head1 COPYRIGHT & LICENSE |
=head1 COPYRIGHT & LICENSE |
| 278 |
|
|
Parent Directory
| 
Revision Log
| 
Patch