3 package Koha::Z3950Responder;
5 # Copyright ByWater Solutions 2016
7 # This file is part of Koha.
9 # Koha is free software; you can redistribute it and/or modify it under the
10 # terms of the GNU General Public License as published by the Free Software
11 # Foundation; either version 3 of the License, or (at your option) any later
14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
16 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License along
19 # with Koha; if not, write to the Free Software Foundation, Inc.,
20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 use C4::Biblio qw( GetMarcFromKohaField );
25 use C4::Koha qw( GetAuthorisedValues );
27 use Net::Z3950::SimpleServer;
31 Koha::Z3950Responder - Main class for interfacing with Net::Z3950::SimpleServer
35 use Koha::Z3950Responder;
37 my $z = Koha::Z3950Responder->new( {
38 add_item_status_subfield => 1,
39 add_status_multi_subfield => 1,
41 num_to_prefetch => 20,
42 config_dir => '/home/koha/etc',
50 A daemon class that interfaces with Net::Z3950::SimpleServer to provider Z39.50/SRU
51 service. Uses a Session class for the actual functionality.
55 =head2 INSTANCE METHODS
60 add_item_status_subfield => 1
66 my ( $class, $config ) = @_;
68 my ($item_tag, $itemnumber_subfield) = GetMarcFromKohaField( "items.itemnumber" );
70 # We hardcode the strings for English so SOMETHING will work if the authorized value doesn't exist.
71 my $status_strings = {
72 AVAILABLE => 'Available',
73 CHECKED_OUT => 'Checked Out',
75 NOT_FOR_LOAN => 'Not for Loan',
77 WITHDRAWN => 'Withdrawn',
78 IN_TRANSIT => 'In Transit',
82 foreach my $val ( @{ GetAuthorisedValues( 'Z3950_STATUS' ) } ) {
83 $status_strings->{ $val->{authorised_value} } = $val->{lib};
88 item_tag => $item_tag,
89 itemnumber_subfield => $itemnumber_subfield,
90 status_strings => $status_strings,
93 # If requested, turn on debugging.
94 if ( $self->{debug} ) {
95 # Turn on single-process mode.
96 unshift @{ $self->{yaz_options} }, '-S';
98 # Turn off Yaz's built-in logging apart from fatal errors (can be turned back on if desired).
99 unshift @{ $self->{yaz_options} }, '-v', 'none,fatal';
102 # Set main config for SRU support
103 unshift @{ $self->{yaz_options} }, '-f', $self->{config_dir} . 'config.xml' if $self->{config_dir};
105 # Set num to prefetch if not passed
106 $self->{num_to_prefetch} //= 20;
108 $self->{server} = Net::Z3950::SimpleServer->new(
109 INIT => sub { $self->init_handler(@_) },
110 SEARCH => sub { $self->search_handler(@_) },
111 FETCH => sub { $self->fetch_handler(@_) },
112 CLOSE => sub { $self->close_handler(@_) },
115 return bless( $self, $class );
122 Start the daemon and begin serving requests. Does not return unless initialization fails or a
130 $self->{server}->launch_server( 'Koha::Z3950Responder', @{ $self->{yaz_options} } )
135 These methods are SimpleServer callbacks bound to this Z3950Responder object.
136 It's worth noting that these callbacks don't return anything; they both
137 receive and return data in the $args hashref.
141 Callback that is called when a new connection is initialized
146 # Called when the client first connects.
147 my ( $self, $args ) = @_;
149 # This holds all of the per-connection state.
151 if (C4::Context->preference('SearchEngine') eq 'Zebra') {
152 use Koha::Z3950Responder::ZebraSession;
153 $session = Koha::Z3950Responder::ZebraSession->new({
155 peer => $args->{PEER_NAME},
158 use Koha::Z3950Responder::GenericSession;
159 $session = Koha::Z3950Responder::GenericSession->new({
161 peer => $args->{PEER_NAME}
165 $args->{HANDLE} = $session;
167 $args->{IMP_NAME} = "Koha";
168 $args->{IMP_VER} = Koha::version;
171 =head3 search_handler
173 Callback that is called when a new search is performed
178 my ( $self, $args ) = @_;
180 $args->{HANDLE}->search_handler($args);
185 Callback that is called when records are requested
190 my ( $self, $args ) = @_;
192 $args->{HANDLE}->fetch_handler( $args );
197 Callback that is called when a session is terminated
202 my ( $self, $args ) = @_;
204 $args->{HANDLE}->close_handler( $args );