Koha/C4/Search/PazPar2.pm
Galen Charlton d92eb0373e experiment: use PazPar2 to group related works
The approach is to use PazPar2 to search just one
target, the biblio Zebra database.  The results
of each set are merged by PazPar2 to generate a
hitlist that combines related bibs together; as an
example, if a library has the first Harry Potter
book in three languages and an audiobook format,
the hitlist should ideally return one result
for the work that includes links to the individual
bibs.

The new module C4::Search::PazPar2 implements a
simple client for PazPar2's XML-over-HTTP API.  It is
designed to be generic, and thus may end up getting
moved out of Koha to become a stand-alone CPAN module.

Signed-off-by: Chris Cormack <crc@liblime.com>
Signed-off-by: Joshua Ferraro <jmf@liblime.com>
2008-02-08 06:01:39 -06:00

168 lines
4 KiB
Perl

package C4::Search::PazPar2;
# Copyright (C) 2007 LibLime
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation; either version 2 of the License, or (at your option) any later
# version.
#
# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
# Suite 330, Boston, MA 02111-1307 USA
use strict;
use LWP::UserAgent;
use URI;
use URI::QueryParam;
use XML::Simple;
=head1 NAME
C4::Search::PazPar2 - implement client for PazPar2
[Note: may rename to Net::PazPar2 or somesuch if decide to put on CPAN separate
from Koha]
=head1 SYNOPSIS
=head1 DESCRIPTION
=cut
sub new {
my $class = shift;
my $endpoint = shift;
my $self = {};
$self->{'endpoint'} = $endpoint;
$self->{'session'} = '';
$self->{'ua'} = LWP::UserAgent->new;
bless $self, $class;
return $self;
}
sub init {
my $self = shift;
my $uri = URI->new($self->{'endpoint'});
$uri->query_param(command => 'init');
my $response = $self->{'ua'}->get($uri);
if ($response->is_success) {
my $message = XMLin($response->content);
if ($message->{'status'} eq 'OK') {
$self->{'session'} = $message->{'session'};
}
} else {
warn $response->status_line;
}
}
sub search {
my $self = shift;
my $query = shift;
my $uri = URI->new($self->{'endpoint'});
$uri->query_param(command => 'search');
$uri->query_param(session => $self->{'session'});
$uri->query_param(query => $query);
my $response = $self->{'ua'}->get($uri);
if ($response->is_success) {
#print $response->content, "\n";
} else {
warn $response->status_line;
}
}
sub stat {
my $self = shift;
my $uri = URI->new($self->{'endpoint'});
$uri->query_param(command => 'stat');
$uri->query_param(session => $self->{'session'});
my $response = $self->{'ua'}->get($uri);
if ($response->is_success) {
return $response->content;
} else {
warn $response->status_line;
return;
}
}
sub show {
my $self = shift;
my $start = shift;
my $count = shift;
my $uri = URI->new($self->{'endpoint'});
$uri->query_param(command => 'show');
$uri->query_param(start => $start);
$uri->query_param(num => $count);
$uri->query_param(block => 1);
$uri->query_param(session => $self->{'session'});
my $response = $self->{'ua'}->get($uri);
if ($response->is_success) {
return $response->content;
} else {
warn $response->status_line;
return;
}
}
sub record {
my $self = shift;
my $id = shift;
my $offset = shift;
my $uri = URI->new($self->{'endpoint'});
$uri->query_param(command => 'record');
$uri->query_param(id => $id);
$uri->query_param(offset => $offset);
$uri->query_param(binary => 1);
$uri->query_param(session => $self->{'session'});
my $response = $self->{'ua'}->get($uri);
if ($response->is_success) {
return $response->content;
} else {
warn $response->status_line;
return;
}
}
sub termlist {
my $self = shift;
my $name = shift;
my $uri = URI->new($self->{'endpoint'});
$uri->query_param(command => 'termlist');
$uri->query_param(name => $name);
$uri->query_param(session => $self->{'session'});
my $response = $self->{'ua'}->get($uri);
if ($response->is_success) {
return $response->content;
} else {
warn $response->status_line;
return;
}
}
1;
=head1 AUTHOR
Koha Development Team <info@koha.org>
Galen Charlton <galen.charlton@liblime.com>
=cut