1 package Koha::Z3950Responder;
3 # Copyright ByWater Solutions 2016
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
22 use C4::Biblio qw( GetMarcFromKohaField );
23 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 and working directory
103 if ( $self->{config_dir} ) {
104 unshift @{ $self->{yaz_options} }, '-f', $self->{config_dir} . 'config.xml';
105 unshift @{ $self->{yaz_options} }, '-w', $self->{config_dir};
108 # Set num to prefetch if not passed
109 $self->{num_to_prefetch} //= 20;
111 $self->{server} = Net::Z3950::SimpleServer->new(
112 INIT => sub { $self->init_handler(@_) },
113 SEARCH => sub { $self->search_handler(@_) },
114 FETCH => sub { $self->fetch_handler(@_) },
115 CLOSE => sub { $self->close_handler(@_) },
118 return bless( $self, $class );
125 Start the daemon and begin serving requests. Does not return unless initialization fails or a
133 $self->{server}->launch_server( 'Koha::Z3950Responder', @{ $self->{yaz_options} } )
138 These methods are SimpleServer callbacks bound to this Z3950Responder object.
139 It's worth noting that these callbacks don't return anything; they both
140 receive and return data in the $args hashref.
144 Callback that is called when a new connection is initialized
149 # Called when the client first connects.
150 my ( $self, $args ) = @_;
152 # This holds all of the per-connection state.
154 if (C4::Context->preference('SearchEngine') eq 'Zebra') {
155 use Koha::Z3950Responder::ZebraSession;
156 $session = Koha::Z3950Responder::ZebraSession->new({
158 peer => $args->{PEER_NAME},
161 use Koha::Z3950Responder::GenericSession;
162 $session = Koha::Z3950Responder::GenericSession->new({
164 peer => $args->{PEER_NAME}
168 $args->{HANDLE} = $session;
170 $args->{IMP_NAME} = "Koha";
171 $args->{IMP_VER} = Koha::version;
174 =head3 search_handler
176 Callback that is called when a new search is performed
181 my ( $self, $args ) = @_;
183 my $SearchEngine = C4::Context->preference('SearchEngine');
184 # Flushing L1 to make sure the search will be processed using the correct data
185 Koha::Caches->flush_L1_caches();
186 $self->init_handler($args)
187 if $SearchEngine ne C4::Context->preference('SearchEngine');
189 $args->{HANDLE}->search_handler($args);
194 Callback that is called when records are requested
199 my ( $self, $args ) = @_;
201 $args->{HANDLE}->fetch_handler( $args );
206 Callback that is called when a session is terminated
211 my ( $self, $args ) = @_;
213 $args->{HANDLE}->close_handler( $args );