rkeck/Koha-Anpassungen
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Koha 25.11: ILSDI comment-Parameter fuer HoldTitle/HoldItem

Browse Source 
- comment als optionaler Parameter in ilsdi.pl
- notes => comment in Services.pm (HoldTitle + HoldItem)
- Fallback fuer alte VuFind 5.x Parameternamen
- Diff-Patches und komplette Dateien enthalten
This commit is contained in:
root 2026-03-04 09:26:21 +01:00
commit 7645c99c01
7 changed files with 2693 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md Normal file
View File

@ -0,0 +1,44 @@
# Koha-Anpassungen BIBB
Lokale Anpassungen an Koha fuer die BIBB-Bibliothek.
## Koha 25.11 - ILSDI Comment-Parameter
Erweiterung der ILSDI-Schnittstelle um einen comment-Parameter
fuer HoldTitle und HoldItem. Der Kommentar wird als reservenotes
in der Vormerkung gespeichert.
### Betroffene Dateien
| Datei | Pfad auf Server |
|-------|----------------|
| ilsdi.pl | /usr/share/koha/opac/cgi-bin/opac/ilsdi.pl |
| Services.pm | /usr/share/koha/lib/C4/ILSDI/Services.pm |
### Aenderungen
**ilsdi.pl:**
- comment als optionaler Parameter fuer HoldTitle und HoldItem
- needed_before_date und pickup_expiry_date als Kompatibilitaetsparameter
fuer VuFind 5.x
**Services.pm (HoldTitle und HoldItem):**
- $comment = $cgi->param('comment') auslesen
- notes => $comment an AddReserve uebergeben
- Fallback fuer alte Parameternamen:
start_date || needed_before_date
expiry_date || pickup_expiry_date
### Patches anwenden (nach Koha-Update)
cd /
patch -p0 < /home/rkeck/koha-anpassungen/patches/koha-25.11-ilsdi-comment.patch
patch -p0 < /home/rkeck/koha-anpassungen/patches/koha-25.11-services-comment.patch
sudo koha-plack --restart bibb
### Pruefen ob Patches noch aktiv sind
grep -n "RKE" /usr/share/koha/opac/cgi-bin/opac/ilsdi.pl
grep -n "RKE" /usr/share/koha/lib/C4/ILSDI/Services.pm
### Hinweis
Diese Anpassungen werden durch apt-get upgrade ueberschrieben.
Wird obsolet nach Migration von VuFind KohaILSDI auf KohaRest-Treiber.

1023
files/lib/C4/ILSDI/Services.pm Normal file
View File

File diff suppressed because it is too large Load Diff

1015
files/lib/C4/ILSDI/Services.pm.orig Normal file
View File

File diff suppressed because it is too large Load Diff

277
files/opac/cgi-bin/opac/ilsdi.pl Executable file
View File

@ -0,0 +1,277 @@
#!/usr/bin/perl
# Copyright 2009 SARL Biblibre
#
# 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 3 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, see <https://www.gnu.org/licenses>.
use Modern::Perl;
use C4::ILSDI::Services;
use C4::Auth qw( get_template_and_user );
use C4::Output qw( output_html_with_http_headers );
use C4::Context;
use List::MoreUtils qw( any );
use XML::Simple qw( XMLout );
use CGI qw ( -utf8 );
use Net::Netmask;
=head1 DLF ILS-DI for Koha
This script is a basic implementation of ILS-DI protocol for Koha.
It acts like a dispatcher, that get the CGI request, check required and
optionals arguments, call a function from C4::ILS-DI, and finally
outputs the returned hashref as XML.
=cut
# Instantiate the CGI request
my $cgi = CGI->new;
# List of available services, sorted by level
my @services = (
'Describe', # Not part of ILS-DI, online API doc
# Level 1: Basic Discovery Interfaces
# 'HarvestBibliographicRecords', # OAI-PMH
# 'HarvestExpandedRecords', # OAI-PMH
'GetAvailability', # FIXME Add bibliographic level
# 'GoToBibliographicRequestPage' # I don't understant this one
# Level 2: Elementary OPAC supplement
# 'HarvestAuthorityRecords', # OAI-PMH
# 'HarvestHoldingsRecords', # OAI-PMH
'GetRecords', # Note that we can use OAI-PMH for this too
# 'Search', # TODO
# 'Scan', # TODO
'GetAuthorityRecords',
# 'OutputRewritablePage', # I don't understant this one
# 'OutputIntermediateFormat', # I don't understant this one
# Level 3: Elementary OPAC alternative
'LookupPatron',
'AuthenticatePatron',
'GetPatronInfo',
'GetPatronStatus',
'GetServices', # FIXME Loans
'RenewLoan',
'HoldTitle', # FIXME Add dates support
'HoldItem', # FIXME Add dates support
'CancelHold',
# 'RecallItem', # Not supported by Koha
# 'CancelRecall', # Not supported by Koha
# Level 4: Robust/domain specific discovery platforms
# 'SearchCourseReserves', # TODO
# 'Explain' # TODO
);
# List of required arguments
my %required = (
'Describe' => ['verb'],
'GetAvailability' => [ 'id', 'id_type' ],
'GetRecords' => ['id'],
'GetAuthorityRecords' => ['id'],
'LookupPatron' => ['id'],
'AuthenticatePatron' => [ 'username', 'password' ],
'GetPatronInfo' => ['patron_id'],
'GetPatronStatus' => ['patron_id'],
'GetServices' => [ 'patron_id', 'item_id' ],
'RenewLoan' => [ 'patron_id', 'item_id' ],
'HoldTitle' => [ 'patron_id', 'bib_id', 'request_location' ],
'HoldItem' => [ 'patron_id', 'bib_id', 'item_id' ],
'CancelHold' => [ 'patron_id', 'item_id' ],
);
# List of optional arguments
my %optional = (
'Describe' => [],
'GetAvailability' => [ 'return_type', 'return_fmt', 'language' ],
'GetRecords' => ['schema'],
'GetAuthorityRecords' => ['schema'],
'LookupPatron' => ['id_type'],
'AuthenticatePatron' => [],
'GetPatronInfo' =>
[ 'show_contact', 'show_fines', 'show_holds', 'show_loans', 'loans_per_page', 'loans_page', 'show_attributes' ],
'GetPatronStatus' => [],
'GetServices' => [],
'RenewLoan' => ['desired_due_date'],
# RKE: 'comment' added as additional parameter for 'HoldTitle' and 'HoldItem'
# RKE: 'comment' added, old param names kept for VuFind 5.x compatibility
'HoldTitle' => [ 'pickup_location', 'start_date', 'expiry_date', 'needed_before_date', 'pickup_expiry_date', 'comment' ],
'HoldItem' => [ 'pickup_location', 'start_date', 'expiry_date', 'needed_before_date', 'pickup_expiry_date', 'comment' ],
'CancelHold' => [],
);
# If no service is requested, display the online documentation
unless ( $cgi->param('service') ) {
my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
{
template_name => "ilsdi.tt",
query => $cgi,
type => "opac",
authnotrequired => 1,
}
);
output_html_with_http_headers $cgi, $cookie, $template->output;
exit 0;
}
# Set the userenv
C4::Context->set_userenv(
undef, undef, undef, 'ILSDI', 'ILSDI',
undef, undef, undef, undef, undef,
);
C4::Context->interface('opac');
# If user requested a service description, then display it
if ( scalar $cgi->param('service') eq "Describe" and any { scalar $cgi->param('verb') eq $_ } @services ) {
my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
{
template_name => "ilsdi.tt",
query => $cgi,
type => "opac",
authnotrequired => 1,
}
);
$template->param( scalar $cgi->param('verb') => 1 );
output_html_with_http_headers $cgi, $cookie, $template->output;
exit 0;
}
# any output after this point will be UTF-8 XML
binmode STDOUT, ':encoding(UTF-8)';
print CGI::header( '-type' => 'text/xml', '-charset' => 'utf-8' );
my $out;
# If ILS-DI module is disabled in System->Preferences, redirect to 404
unless ( C4::Context->preference('ILS-DI') ) {
$out->{'code'} = "NotAllowed";
$out->{'message'} = "ILS-DI is disabled.";
} else {
# If the remote address is not allowed, redirect to 403
my @AuthorizedIPs = split( /,/, C4::Context->preference('ILS-DI:AuthorizedIPs') );
if (@AuthorizedIPs) { # If no filter set, allow access to everybody
my $authorized = 0;
foreach my $ip (@AuthorizedIPs) {
my $netmask = Net::Netmask->new2($ip);
if ( $netmask && $netmask->match( $ENV{REMOTE_ADDR} ) ) {
$authorized = 1;
last;
}
}
unless ($authorized) {
$out->{'code'} = "NotAllowed";
$out->{'message'} = "Unauthorized IP address: $ENV{REMOTE_ADDR}.";
}
} else {
$out->{'code'} = "NotAllowed";
$out->{'message'} = "Unauthorized IP address: $ENV{REMOTE_ADDR}.";
print XMLout(
$out,
noattr => 1,
nosort => 1,
xmldecl => '<?xml version="1.0" encoding="UTF-8" ?>',
RootName => "ilsdi",
SuppressEmpty => 1
);
exit 0;
}
}
my $service = $cgi->param('service') || "ilsdi";
# Check if the requested service is in the list
if ( $service and any { $service eq $_ } @services ) {
my @parmsrequired = @{ $required{$service} };
my @parmsoptional = @{ $optional{$service} };
my @parmsall = ( @parmsrequired, @parmsoptional );
my @names = $cgi->multi_param;
my %paramhash;
$paramhash{$_} = 1 for @names;
# check for missing parameters
for (@parmsrequired) {
unless ( exists $paramhash{$_} ) {
$out->{'code'} = "MissingParameter";
$out->{'message'} = "The required parameter " . $_ . " is missing.";
}
}
# check for illegal parameters
for my $name (@names) {
my $found = 0;
for my $name2 (@parmsall) {
if ( $name eq $name2 ) {
$found = 1;
}
}
if ( $found == 0 && $name ne 'service' ) {
$out->{'code'} = "IllegalParameter";
$out->{'message'} = "The parameter " . $name . " is illegal.";
}
}
# check for multiple parameters
for (@names) {
my @values = $cgi->multi_param($_);
if ( $#values != 0 ) {
$out->{'code'} = "MultipleValuesNotAllowed";
$out->{'message'} = "Multiple values not allowed for the parameter " . $_ . ".";
}
}
if ( !$out->{'message'} ) {
# GetAvailability is a special case, as it cannot use XML::Simple
if ( $service eq "GetAvailability" ) {
print C4::ILSDI::Services::GetAvailability($cgi);
exit 0;
} else {
# Variable functions
my $sub = do {
# no strict 'refs';
my $symbol = 'C4::ILSDI::Services::' . $service;
\&{"$symbol"};
};
# Call the requested service, and get its return value
$out = &$sub($cgi);
}
}
} else {
$out->{'message'} = "NotSupported";
}
# Output XML by passing the hashref to XMLOut
print XMLout(
$out,
noattr => 1,
nosort => 1,
xmldecl => '<?xml version="1.0" encoding="UTF-8" ?>',
RootName => $service,
SuppressEmpty => 1
);
exit 0;

275
files/opac/cgi-bin/opac/ilsdi.pl.orig Executable file
View File

@ -0,0 +1,275 @@
#!/usr/bin/perl
# Copyright 2009 SARL Biblibre
#
# 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 3 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, see <https://www.gnu.org/licenses>.
use Modern::Perl;
use C4::ILSDI::Services;
use C4::Auth qw( get_template_and_user );
use C4::Output qw( output_html_with_http_headers );
use C4::Context;
use List::MoreUtils qw( any );
use XML::Simple qw( XMLout );
use CGI qw ( -utf8 );
use Net::Netmask;
=head1 DLF ILS-DI for Koha
This script is a basic implementation of ILS-DI protocol for Koha.
It acts like a dispatcher, that get the CGI request, check required and
optionals arguments, call a function from C4::ILS-DI, and finally
outputs the returned hashref as XML.
=cut
# Instantiate the CGI request
my $cgi = CGI->new;
# List of available services, sorted by level
my @services = (
'Describe', # Not part of ILS-DI, online API doc
# Level 1: Basic Discovery Interfaces
# 'HarvestBibliographicRecords', # OAI-PMH
# 'HarvestExpandedRecords', # OAI-PMH
'GetAvailability', # FIXME Add bibliographic level
# 'GoToBibliographicRequestPage' # I don't understant this one
# Level 2: Elementary OPAC supplement
# 'HarvestAuthorityRecords', # OAI-PMH
# 'HarvestHoldingsRecords', # OAI-PMH
'GetRecords', # Note that we can use OAI-PMH for this too
# 'Search', # TODO
# 'Scan', # TODO
'GetAuthorityRecords',
# 'OutputRewritablePage', # I don't understant this one
# 'OutputIntermediateFormat', # I don't understant this one
# Level 3: Elementary OPAC alternative
'LookupPatron',
'AuthenticatePatron',
'GetPatronInfo',
'GetPatronStatus',
'GetServices', # FIXME Loans
'RenewLoan',
'HoldTitle', # FIXME Add dates support
'HoldItem', # FIXME Add dates support
'CancelHold',
# 'RecallItem', # Not supported by Koha
# 'CancelRecall', # Not supported by Koha
# Level 4: Robust/domain specific discovery platforms
# 'SearchCourseReserves', # TODO
# 'Explain' # TODO
);
# List of required arguments
my %required = (
'Describe' => ['verb'],
'GetAvailability' => [ 'id', 'id_type' ],
'GetRecords' => ['id'],
'GetAuthorityRecords' => ['id'],
'LookupPatron' => ['id'],
'AuthenticatePatron' => [ 'username', 'password' ],
'GetPatronInfo' => ['patron_id'],
'GetPatronStatus' => ['patron_id'],
'GetServices' => [ 'patron_id', 'item_id' ],
'RenewLoan' => [ 'patron_id', 'item_id' ],
'HoldTitle' => [ 'patron_id', 'bib_id', 'request_location' ],
'HoldItem' => [ 'patron_id', 'bib_id', 'item_id' ],
'CancelHold' => [ 'patron_id', 'item_id' ],
);
# List of optional arguments
my %optional = (
'Describe' => [],
'GetAvailability' => [ 'return_type', 'return_fmt', 'language' ],
'GetRecords' => ['schema'],
'GetAuthorityRecords' => ['schema'],
'LookupPatron' => ['id_type'],
'AuthenticatePatron' => [],
'GetPatronInfo' =>
[ 'show_contact', 'show_fines', 'show_holds', 'show_loans', 'loans_per_page', 'loans_page', 'show_attributes' ],
'GetPatronStatus' => [],
'GetServices' => [],
'RenewLoan' => ['desired_due_date'],
'HoldTitle' => [ 'pickup_location', 'start_date', 'expiry_date' ],
'HoldItem' => [ 'pickup_location', 'start_date', 'expiry_date' ],
'CancelHold' => [],
);
# If no service is requested, display the online documentation
unless ( $cgi->param('service') ) {
my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
{
template_name => "ilsdi.tt",
query => $cgi,
type => "opac",
authnotrequired => 1,
}
);
output_html_with_http_headers $cgi, $cookie, $template->output;
exit 0;
}
# Set the userenv
C4::Context->set_userenv(
undef, undef, undef, 'ILSDI', 'ILSDI',
undef, undef, undef, undef, undef,
);
C4::Context->interface('opac');
# If user requested a service description, then display it
if ( scalar $cgi->param('service') eq "Describe" and any { scalar $cgi->param('verb') eq $_ } @services ) {
my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
{
template_name => "ilsdi.tt",
query => $cgi,
type => "opac",
authnotrequired => 1,
}
);
$template->param( scalar $cgi->param('verb') => 1 );
output_html_with_http_headers $cgi, $cookie, $template->output;
exit 0;
}
# any output after this point will be UTF-8 XML
binmode STDOUT, ':encoding(UTF-8)';
print CGI::header( '-type' => 'text/xml', '-charset' => 'utf-8' );
my $out;
# If ILS-DI module is disabled in System->Preferences, redirect to 404
unless ( C4::Context->preference('ILS-DI') ) {
$out->{'code'} = "NotAllowed";
$out->{'message'} = "ILS-DI is disabled.";
} else {
# If the remote address is not allowed, redirect to 403
my @AuthorizedIPs = split( /,/, C4::Context->preference('ILS-DI:AuthorizedIPs') );
if (@AuthorizedIPs) { # If no filter set, allow access to everybody
my $authorized = 0;
foreach my $ip (@AuthorizedIPs) {
my $netmask = Net::Netmask->new2($ip);
if ( $netmask && $netmask->match( $ENV{REMOTE_ADDR} ) ) {
$authorized = 1;
last;
}
}
unless ($authorized) {
$out->{'code'} = "NotAllowed";
$out->{'message'} = "Unauthorized IP address: $ENV{REMOTE_ADDR}.";
}
} else {
$out->{'code'} = "NotAllowed";
$out->{'message'} = "Unauthorized IP address: $ENV{REMOTE_ADDR}.";
print XMLout(
$out,
noattr => 1,
nosort => 1,
xmldecl => '<?xml version="1.0" encoding="UTF-8" ?>',
RootName => "ilsdi",
SuppressEmpty => 1
);
exit 0;
}
}
my $service = $cgi->param('service') || "ilsdi";
# Check if the requested service is in the list
if ( $service and any { $service eq $_ } @services ) {
my @parmsrequired = @{ $required{$service} };
my @parmsoptional = @{ $optional{$service} };
my @parmsall = ( @parmsrequired, @parmsoptional );
my @names = $cgi->multi_param;
my %paramhash;
$paramhash{$_} = 1 for @names;
# check for missing parameters
for (@parmsrequired) {
unless ( exists $paramhash{$_} ) {
$out->{'code'} = "MissingParameter";
$out->{'message'} = "The required parameter " . $_ . " is missing.";
}
}
# check for illegal parameters
for my $name (@names) {
my $found = 0;
for my $name2 (@parmsall) {
if ( $name eq $name2 ) {
$found = 1;
}
}
if ( $found == 0 && $name ne 'service' ) {
$out->{'code'} = "IllegalParameter";
$out->{'message'} = "The parameter " . $name . " is illegal.";
}
}
# check for multiple parameters
for (@names) {
my @values = $cgi->multi_param($_);
if ( $#values != 0 ) {
$out->{'code'} = "MultipleValuesNotAllowed";
$out->{'message'} = "Multiple values not allowed for the parameter " . $_ . ".";
}
}
if ( !$out->{'message'} ) {
# GetAvailability is a special case, as it cannot use XML::Simple
if ( $service eq "GetAvailability" ) {
print C4::ILSDI::Services::GetAvailability($cgi);
exit 0;
} else {
# Variable functions
my $sub = do {
# no strict 'refs';
my $symbol = 'C4::ILSDI::Services::' . $service;
\&{"$symbol"};
};
# Call the requested service, and get its return value
$out = &$sub($cgi);
}
}
} else {
$out->{'message'} = "NotSupported";
}
# Output XML by passing the hashref to XMLOut
print XMLout(
$out,
noattr => 1,
nosort => 1,
xmldecl => '<?xml version="1.0" encoding="UTF-8" ?>',
RootName => $service,
SuppressEmpty => 1
);
exit 0;

15
patches/koha-25.11-ilsdi-comment.patch Normal file
View File

@ -0,0 +1,15 @@
--- /usr/share/koha/opac/cgi-bin/opac/ilsdi.pl.bak.20260303 2026-03-03 12:45:20.698269416 +0100
+++ /usr/share/koha/opac/cgi-bin/opac/ilsdi.pl 2026-03-04 07:33:55.010753628 +0100
@@ -110,8 +110,10 @@
'GetPatronStatus' => [],
'GetServices' => [],
'RenewLoan' => ['desired_due_date'],
- 'HoldTitle' => [ 'pickup_location', 'start_date', 'expiry_date' ],
- 'HoldItem' => [ 'pickup_location', 'start_date', 'expiry_date' ],
+ # RKE: 'comment' added as additional parameter for 'HoldTitle' and 'HoldItem'
+ # RKE: 'comment' added, old param names kept for VuFind 5.x compatibility
+ 'HoldTitle' => [ 'pickup_location', 'start_date', 'expiry_date', 'needed_before_date', 'pickup_expiry_date', 'comment' ],
+ 'HoldItem' => [ 'pickup_location', 'start_date', 'expiry_date', 'needed_before_date', 'pickup_expiry_date', 'comment' ],
'CancelHold' => [],
);

44
patches/koha-25.11-services-comment.patch Normal file
View File

@ -0,0 +1,44 @@
--- /usr/share/koha/lib/C4/ILSDI/Services.pm.bak.20260303 2026-03-03 12:43:18.320523619 +0100
+++ /usr/share/koha/lib/C4/ILSDI/Services.pm 2026-03-04 07:39:10.327445880 +0100
@@ -813,8 +813,11 @@
return { code => 'libraryNotPickupLocation' } unless $destination->pickup_location;
return { code => 'cannotBeTransferred' } unless $biblio->can_be_transferred( { to => $destination } );
- my $resdate = $cgi->param('start_date');
- my $expdate = $cgi->param('expiry_date');
+ my $resdate = $cgi->param('start_date') || $cgi->param('needed_before_date');
+ my $expdate = $cgi->param('expiry_date') || $cgi->param('pickup_expiry_date');
+ #RKE comment for reserves
+ my $comment = $cgi->param('comment');
+ #RKE End
# Add the reserve
# $branch, $borrowernumber, $biblionumber,
@@ -830,6 +833,7 @@
reservation_date => $resdate,
expiration_date => $expdate,
title => $title,
+ notes => $comment,
}
);
@@ -911,7 +915,10 @@
my $resdate = $cgi->param('start_date');
my $expdate = $cgi->param('expiry_date');
-
+ # RKE comment fpr reserves
+ my $comment = $cgi->param('comment');
+ # RKE End
+
# Add the reserve
my $priority = C4::Reserves::CalculatePriority($biblionumber);
AddReserve(
@@ -924,6 +931,7 @@
expiration_date => $expdate,
title => $title,
itemnumber => $itemnumber,
+ notes => $comment,
}
);