opac/ilsdi.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2009 SARL Biblibre
   4 #
   5 # This file is part of Koha.
   6 #
   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.
  11 #
  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.
  16 #
  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>.
  19
  20 use Modern::Perl;
  21
  22 use C4::ILSDI::Services;
  23 use C4::Auth;
  24 use C4::Output;
  25 use C4::Context;
  26
  27 use List::MoreUtils qw(any);
  28 use XML::Simple;
  29 use CGI qw ( -utf8 );
  30
  31 =head1 DLF ILS-DI for Koha
  32
  33 This script is a basic implementation of ILS-DI protocol for Koha.
  34 It acts like a dispatcher, that get the CGI request, check required and
  35 optionals arguments, call a function from C4::ILS-DI, and finaly
  36 outputs the returned hashref as XML.
  37
  38 =cut
  39
  40 # Instanciate the CGI request
  41 my $cgi = new CGI;
  42
  43 # List of available services, sorted by level
  44 my @services = (
  45     'Describe',    # Not part of ILS-DI, online API doc
  46
  47     #   Level 1: Basic Discovery Interfaces
  48     #   'HarvestBibliographicRecords',       # OAI-PMH
  49     #   'HarvestExpandedRecords',            # OAI-PMH
  50     'GetAvailability',    # FIXME Add bibliographic level
  51
  52     #   'GoToBibliographicRequestPage'       # I don't understant this one
  53     #   Level 2: Elementary OPAC supplement
  54     #   'HarvestAuthorityRecords',           # OAI-PMH
  55     #   'HarvestHoldingsRecords',            # OAI-PMH
  56     'GetRecords',         # Note that we can use OAI-PMH for this too
  57
  58     #   'Search',                            # TODO
  59     #   'Scan',                              # TODO
  60     'GetAuthorityRecords',
  61
  62     #   'OutputRewritablePage',              # I don't understant this one
  63     #   'OutputIntermediateFormat',          # I don't understant this one
  64     #   Level 3: Elementary OPAC alternative
  65     'LookupPatron',
  66     'AuthenticatePatron',
  67     'GetPatronInfo',
  68     'GetPatronStatus',
  69     'GetServices',    # FIXME Loans
  70     'RenewLoan',
  71     'HoldTitle',      # FIXME Add dates support
  72     'HoldItem',       # FIXME Add dates support
  73     'CancelHold',
  74
  75     #   'RecallItem',                        # Not supported by Koha
  76     #   'CancelRecall',                      # Not supported by Koha
  77     #   Level 4: Robust/domain specific discovery platforms
  78     #   'SearchCourseReserves',              # TODO
  79     #   'Explain'                            # TODO
  80 );
  81
  82 # List of required arguments
  83 my %required = (
  84     'Describe'            => ['verb'],
  85     'GetAvailability'     => [ 'id', 'id_type' ],
  86     'GetRecords'          => ['id'],
  87     'GetAuthorityRecords' => ['id'],
  88     'LookupPatron'        => ['id'],
  89     'AuthenticatePatron'  => [ 'username', 'password' ],
  90     'GetPatronInfo'       => ['patron_id'],
  91     'GetPatronStatus'     => ['patron_id'],
  92     'GetServices'         => [ 'patron_id', 'item_id' ],
  93     'RenewLoan'           => [ 'patron_id', 'item_id' ],
  94     'HoldTitle'           => [ 'patron_id', 'bib_id', 'request_location' ],
  95     'HoldItem'            => [ 'patron_id', 'bib_id', 'item_id' ],
  96     'CancelHold' => [ 'patron_id', 'item_id' ],
  97 );
  98
  99 # List of optional arguments
 100 my %optional = (
 101     'Describe'            => [],
 102     'GetAvailability'     => [ 'return_type', 'return_fmt' ],
 103     'GetRecords'          => ['schema'],
 104     'GetAuthorityRecords' => ['schema'],
 105     'LookupPatron'        => ['id_type'],
 106     'AuthenticatePatron'  => [],
 107     'GetPatronInfo'       => [ 'show_contact', 'show_fines', 'show_holds', 'show_loans', 'show_attributes' ],
 108     'GetPatronStatus'     => [],
 109     'GetServices'         => [],
 110     'RenewLoan'           => ['desired_due_date'],
 111     'HoldTitle'  => [ 'pickup_location', 'needed_before_date', 'pickup_expiry_date' ],
 112     'HoldItem'   => [ 'pickup_location', 'needed_before_date', 'pickup_expiry_date' ],
 113     'CancelHold' => [],
 114 );
 115
 116 # If no service is requested, display the online documentation
 117 unless ( $cgi->param('service') ) {
 118     my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
 119         {   template_name   => "ilsdi.tt",
 120             query           => $cgi,
 121             type            => "opac",
 122             authnotrequired => 1,
 123             debug           => 1,
 124         }
 125     );
 126     output_html_with_http_headers $cgi, $cookie, $template->output;
 127     exit 0;
 128 }
 129
 130 # If user requested a service description, then display it
 131 if ( scalar $cgi->param('service') eq "Describe" and any { scalar $cgi->param('verb') eq $_ } @services ) {
 132     my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
 133         {   template_name   => "ilsdi.tt",
 134             query           => $cgi,
 135             type            => "opac",
 136             authnotrequired => 1,
 137             debug           => 1,
 138         }
 139     );
 140     $template->param( scalar $cgi->param('verb') => 1 );
 141     output_html_with_http_headers $cgi, $cookie, $template->output;
 142     exit 0;
 143 }
 144
 145 # any output after this point will be UTF-8 XML
 146 binmode STDOUT, ':encoding(UTF-8)';
 147 print CGI::header('-type'=>'text/xml', '-charset'=>'utf-8');
 148
 149 my $out;
 150
 151 # If ILS-DI module is disabled in System->Preferences, redirect to 404
 152 unless ( C4::Context->preference('ILS-DI') ) {
 153     $out->{'code'} = "NotAllowed";
 154     $out->{'message'} = "ILS-DI is disabled.";
 155 }
 156
 157 # If the remote address is not allowed, redirect to 403
 158 my @AuthorizedIPs = split(/,/, C4::Context->preference('ILS-DI:AuthorizedIPs'));
 159 if ( @AuthorizedIPs # If no filter set, allow access to everybody
 160     and not any { $ENV{'REMOTE_ADDR'} eq $_ } @AuthorizedIPs # IP Check
 161     ) {
 162     $out->{'code'} = "NotAllowed";
 163     $out->{'message'} = "Unauthorized IP address: ".$ENV{'REMOTE_ADDR'}.".";
 164 }
 165
 166 my $service = $cgi->param('service') || "ilsdi";
 167
 168 # Check if the requested service is in the list
 169 if ( $service and any { $service eq $_ } @services ) {
 170
 171     my @parmsrequired = @{ $required{$service} };
 172     my @parmsoptional = @{ $optional{$service} };
 173     my @parmsall      = ( @parmsrequired, @parmsoptional );
 174     my @names         = $cgi->multi_param;
 175     my %paramhash;
 176     $paramhash{$_} = 1 for @names;
 177
 178     # check for missing parameters
 179     for ( @parmsrequired ) {
 180         unless ( exists $paramhash{$_} ) {
 181             $out->{'code'} = "MissingParameter";
 182             $out->{'message'} = "The required parameter ".$_." is missing.";
 183         }
 184     }
 185
 186     # check for illegal parameters
 187     for my $name ( @names ) {
 188         my $found = 0;
 189         for my $name2 (@parmsall) {
 190             if ( $name eq $name2 ) {
 191                 $found = 1;
 192             }
 193         }
 194         if ( $found == 0 && $name ne 'service' ) {
 195             $out->{'code'} = "IllegalParameter";
 196             $out->{'message'} = "The parameter ".$name." is illegal.";
 197         }
 198     }
 199
 200     # check for multiple parameters
 201     for ( @names ) {
 202         my @values = $cgi->multi_param($_);
 203         if ( $#values != 0 ) {
 204             $out->{'code'} = "MultipleValuesNotAllowed";
 205             $out->{'message'} = "Multiple values not allowed for the parameter ".$_.".";
 206         }
 207     }
 208
 209     if ( !$out->{'message'} ) {
 210
 211         # GetAvailability is a special case, as it cannot use XML::Simple
 212         if ( $service eq "GetAvailability" ) {
 213             print C4::ILSDI::Services::GetAvailability($cgi);
 214             exit 0;
 215         } else {
 216
 217             # Variable functions
 218             my $sub = do {
 219 #                no strict 'refs';
 220                 my $symbol = 'C4::ILSDI::Services::' . $service;
 221                 \&{"$symbol"};
 222             };
 223
 224             # Call the requested service, and get its return value
 225             $out = &$sub($cgi);
 226         }
 227     }
 228 } else {
 229     $out->{'message'} = "NotSupported";
 230 }
 231
 232 # Output XML by passing the hashref to XMLOut
 233 print XMLout(
 234     $out,
 235     noattr        => 1,
 236     nosort        => 1,
 237     xmldecl       => '<?xml version="1.0" encoding="UTF-8" ?>',
 238     RootName      => $service,
 239     SuppressEmpty => 1
 240 );
 241 exit 0;
 242