3 # Copyright 2009 SARL Biblibre
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::ILSDI::Services;
23 use C4::Auth qw( get_template_and_user );
24 use C4::Output qw( output_html_with_http_headers );
27 use List::MoreUtils qw( any );
28 use XML::Simple qw( XMLout );
32 =head1 DLF ILS-DI for Koha
34 This script is a basic implementation of ILS-DI protocol for Koha.
35 It acts like a dispatcher, that get the CGI request, check required and
36 optionals arguments, call a function from C4::ILS-DI, and finally
37 outputs the returned hashref as XML.
41 # Instanciate the CGI request
44 # List of available services, sorted by level
46 'Describe', # Not part of ILS-DI, online API doc
48 # Level 1: Basic Discovery Interfaces
49 # 'HarvestBibliographicRecords', # OAI-PMH
50 # 'HarvestExpandedRecords', # OAI-PMH
51 'GetAvailability', # FIXME Add bibliographic level
53 # 'GoToBibliographicRequestPage' # I don't understant this one
54 # Level 2: Elementary OPAC supplement
55 # 'HarvestAuthorityRecords', # OAI-PMH
56 # 'HarvestHoldingsRecords', # OAI-PMH
57 'GetRecords', # Note that we can use OAI-PMH for this too
61 'GetAuthorityRecords',
63 # 'OutputRewritablePage', # I don't understant this one
64 # 'OutputIntermediateFormat', # I don't understant this one
65 # Level 3: Elementary OPAC alternative
70 'GetServices', # FIXME Loans
72 'HoldTitle', # FIXME Add dates support
73 'HoldItem', # FIXME Add dates support
76 # 'RecallItem', # Not supported by Koha
77 # 'CancelRecall', # Not supported by Koha
78 # Level 4: Robust/domain specific discovery platforms
79 # 'SearchCourseReserves', # TODO
83 # List of required arguments
85 'Describe' => ['verb'],
86 'GetAvailability' => [ 'id', 'id_type' ],
87 'GetRecords' => ['id'],
88 'GetAuthorityRecords' => ['id'],
89 'LookupPatron' => ['id'],
90 'AuthenticatePatron' => [ 'username', 'password' ],
91 'GetPatronInfo' => ['patron_id'],
92 'GetPatronStatus' => ['patron_id'],
93 'GetServices' => [ 'patron_id', 'item_id' ],
94 'RenewLoan' => [ 'patron_id', 'item_id' ],
95 'HoldTitle' => [ 'patron_id', 'bib_id', 'request_location' ],
96 'HoldItem' => [ 'patron_id', 'bib_id', 'item_id' ],
97 'CancelHold' => [ 'patron_id', 'item_id' ],
100 # List of optional arguments
103 'GetAvailability' => [ 'return_type', 'return_fmt', 'language' ],
104 'GetRecords' => ['schema'],
105 'GetAuthorityRecords' => ['schema'],
106 'LookupPatron' => ['id_type'],
107 'AuthenticatePatron' => [],
108 'GetPatronInfo' => [ 'show_contact', 'show_fines', 'show_holds', 'show_loans', 'loans_per_page', 'loans_page', 'show_attributes' ],
109 'GetPatronStatus' => [],
111 'RenewLoan' => ['desired_due_date'],
112 'HoldTitle' => [ 'pickup_location', 'start_date', 'expiry_date' ],
113 'HoldItem' => [ 'pickup_location', 'start_date', 'expiry_date' ],
117 # If no service is requested, display the online documentation
118 unless ( $cgi->param('service') ) {
119 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
120 { template_name => "ilsdi.tt",
123 authnotrequired => 1,
126 output_html_with_http_headers $cgi, $cookie, $template->output;
131 C4::Context->_new_userenv( 'ILSDI_'.time() );
132 C4::Context->set_userenv(
133 undef, undef, undef, 'ILSDI', 'ILSDI',
134 undef, undef, undef, undef, undef,
136 C4::Context->interface('opac');
138 # If user requested a service description, then display it
139 if ( scalar $cgi->param('service') eq "Describe" and any { scalar $cgi->param('verb') eq $_ } @services ) {
140 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
141 { template_name => "ilsdi.tt",
144 authnotrequired => 1,
147 $template->param( scalar $cgi->param('verb') => 1 );
148 output_html_with_http_headers $cgi, $cookie, $template->output;
152 # any output after this point will be UTF-8 XML
153 binmode STDOUT, ':encoding(UTF-8)';
154 print CGI::header('-type'=>'text/xml', '-charset'=>'utf-8');
158 # If ILS-DI module is disabled in System->Preferences, redirect to 404
159 unless ( C4::Context->preference('ILS-DI') ) {
160 $out->{'code'} = "NotAllowed";
161 $out->{'message'} = "ILS-DI is disabled.";
164 # If the remote address is not allowed, redirect to 403
165 my @AuthorizedIPs = split( /,/, C4::Context->preference('ILS-DI:AuthorizedIPs') );
166 if (@AuthorizedIPs) { # If no filter set, allow access to everybody
168 foreach my $ip (@AuthorizedIPs) {
169 my $netmask = Net::Netmask->new2($ip);
170 if ( $netmask && $netmask->match( $ENV{REMOTE_ADDR} ) ) {
175 unless ($authorized) {
176 $out->{'code'} = "NotAllowed";
177 $out->{'message'} = "Unauthorized IP address: $ENV{REMOTE_ADDR}.";
181 my $service = $cgi->param('service') || "ilsdi";
183 # Check if the requested service is in the list
184 if ( $service and any { $service eq $_ } @services ) {
186 my @parmsrequired = @{ $required{$service} };
187 my @parmsoptional = @{ $optional{$service} };
188 my @parmsall = ( @parmsrequired, @parmsoptional );
189 my @names = $cgi->multi_param;
191 $paramhash{$_} = 1 for @names;
193 # check for missing parameters
194 for ( @parmsrequired ) {
195 unless ( exists $paramhash{$_} ) {
196 $out->{'code'} = "MissingParameter";
197 $out->{'message'} = "The required parameter ".$_." is missing.";
201 # check for illegal parameters
202 for my $name ( @names ) {
204 for my $name2 (@parmsall) {
205 if ( $name eq $name2 ) {
209 if ( $found == 0 && $name ne 'service' ) {
210 $out->{'code'} = "IllegalParameter";
211 $out->{'message'} = "The parameter ".$name." is illegal.";
215 # check for multiple parameters
217 my @values = $cgi->multi_param($_);
218 if ( $#values != 0 ) {
219 $out->{'code'} = "MultipleValuesNotAllowed";
220 $out->{'message'} = "Multiple values not allowed for the parameter ".$_.".";
224 if ( !$out->{'message'} ) {
226 # GetAvailability is a special case, as it cannot use XML::Simple
227 if ( $service eq "GetAvailability" ) {
228 print C4::ILSDI::Services::GetAvailability($cgi);
235 my $symbol = 'C4::ILSDI::Services::' . $service;
239 # Call the requested service, and get its return value
244 $out->{'message'} = "NotSupported";
247 # Output XML by passing the hashref to XMLOut
252 xmldecl => '<?xml version="1.0" encoding="UTF-8" ?>',
253 RootName => $service,