1 package C4::ILSDI::Services;
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>.
28 use C4::Reserves qw(AddReserve CanBookBeReserved CanItemBeReserved IsAvailableForItemLevelRequest);
30 use C4::AuthoritiesMarc;
36 use C4::Members::Attributes qw(GetBorrowerAttributes);
47 C4::ILS-DI::Services - ILS-DI Services
51 Each function in this module represents an ILS-DI service.
52 They all takes a CGI instance as argument and most of them return a
53 hashref that will be printed by XML::Simple in opac/ilsdi.pl
57 use C4::ILSDI::Services;
63 $out = LookupPatron($cgi);
65 print CGI::header('text/xml');
70 xmldecl => '<?xml version="1.0" encoding="UTF-8" ?>',
71 RootName => 'LookupPatron',
78 =head2 GetAvailability
80 Given a set of biblionumbers or itemnumbers, returns a list with
81 availability of the items associated with the identifiers.
87 list of either biblionumbers or itemnumbers
89 =head3 id_type (Required)
91 defines the type of record identifier being used in the request,
97 =head3 return_type (Optional)
99 requests a particular level of detail in reporting availability,
105 =head3 return_fmt (Optional)
107 requests a particular format or set of formats in reporting
112 sub GetAvailability {
115 my $out = "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n";
116 $out .= "<dlf:collection\n";
117 $out .= " xmlns:dlf=\"http://diglib.org/ilsdi/1.1\"\n";
118 $out .= " xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n";
119 $out .= " xsi:schemaLocation=\"http://diglib.org/ilsdi/1.1\n";
120 $out .= " http://diglib.org/architectures/ilsdi/schemas/1.1/dlfexpanded.xsd\">\n";
122 foreach my $id ( split( / /, $cgi->param('id') ) ) {
123 if ( $cgi->param('id_type') eq "item" ) {
124 my ( $biblionumber, $status, $msg, $location ) = _availability($id);
126 $out .= " <dlf:record>\n";
127 $out .= " <dlf:bibliographic id=\"" . ( $biblionumber || $id ) . "\" />\n";
128 $out .= " <dlf:items>\n";
129 $out .= " <dlf:item id=\"" . $id . "\">\n";
130 $out .= " <dlf:simpleavailability>\n";
131 $out .= " <dlf:identifier>" . $id . "</dlf:identifier>\n";
132 $out .= " <dlf:availabilitystatus>" . $status . "</dlf:availabilitystatus>\n";
133 if ($msg) { $out .= " <dlf:availabilitymsg>" . $msg . "</dlf:availabilitymsg>\n"; }
134 if ($location) { $out .= " <dlf:location>" . $location . "</dlf:location>\n"; }
135 $out .= " </dlf:simpleavailability>\n";
136 $out .= " </dlf:item>\n";
137 $out .= " </dlf:items>\n";
138 $out .= " </dlf:record>\n";
142 my $items = Koha::Items->search({ biblionumber => $id });
145 $out .= " <dlf:record>\n";
146 $out .= " <dlf:bibliographic id=\"" .$id. "\" />\n";
147 $out .= " <dlf:items>\n";
148 # We loop over the items to clean them
149 while ( my $item = $items->next ) {
150 my $itemnumber = $item->itemnumber;
151 my ( $biblionumber, $status, $msg, $location ) = _availability($itemnumber);
152 $out .= " <dlf:item id=\"" . $itemnumber . "\">\n";
153 $out .= " <dlf:simpleavailability>\n";
154 $out .= " <dlf:identifier>" . $itemnumber . "</dlf:identifier>\n";
155 $out .= " <dlf:availabilitystatus>" . $status . "</dlf:availabilitystatus>\n";
156 if ($msg) { $out .= " <dlf:availabilitymsg>" . $msg . "</dlf:availabilitymsg>\n"; }
157 if ($location) { $out .= " <dlf:location>" . $location . "</dlf:location>\n"; }
158 $out .= " </dlf:simpleavailability>\n";
159 $out .= " </dlf:item>\n";
162 $out .= " </dlf:items>\n";
163 $out .= " </dlf:record>\n";
166 $msg = "Error: could not retrieve availability for this ID";
170 $out .= "</dlf:collection>\n";
177 Given a list of biblionumbers, returns a list of record objects that
178 contain bibliographic information, as well as associated holdings and item
179 information. The caller may request a specific metadata schema for the
180 record objects to be returned.
182 This function behaves similarly to HarvestBibliographicRecords and
183 HarvestExpandedRecords in Data Aggregation, but allows quick, real time
184 lookup by bibliographic identifier.
186 You can use OAI-PMH ListRecords instead of this service.
191 list of system record identifiers
193 Defines the metadata schema in which the records are returned,
202 # Check if the schema is supported. For now, GetRecords only supports MARCXML
203 if ( $cgi->param('schema') and $cgi->param('schema') ne "MARCXML" ) {
204 return { code => 'UnsupportedSchema' };
209 # Loop over biblionumbers
210 foreach my $biblionumber ( split( / /, $cgi->param('id') ) ) {
212 # Get the biblioitem from the biblionumber
213 my $biblio = Koha::Biblios->find( $biblionumber );
215 push @records, { code => "RecordNotFound" };
219 my $biblioitem = $biblio->biblioitem->unblessed;
222 my $record = GetMarcBiblio({
223 biblionumber => $biblionumber,
224 embed_items => $embed_items });
226 $biblioitem->{marcxml} = $record->as_xml_record();
229 # Get most of the needed data
230 my $biblioitemnumber = $biblioitem->{'biblioitemnumber'};
231 my $holds = $biblio->current_holds->unblessed;
232 my $issues = GetBiblioIssues($biblionumber);
233 my @items = $biblio->items;
235 $biblioitem->{items}->{item} = [];
237 # We loop over the items to clean them
238 foreach my $item (@items) {
239 my %item = %{ $item->unblessed };
241 # This hides additionnal XML subfields, we don't need these info
242 delete $item{'more_subfields_xml'};
244 # Display branch names instead of branch codes
245 my $home_library = $item->home_branch;
246 my $holding_library = $item->holding_branch;
247 $item{'homebranchname'} = $home_library ? $home_library->branchname : '';
248 $item{'holdingbranchname'} = $holding_library ? $holding_library->branchname : '';
250 my $transfer = $item->get_transfer;
253 datesent => $transfer->datesent,
254 frombranch => $transfer->frombranch,
255 tobranch => $transfer->tobranch,
259 push @{ $biblioitem->{items}->{item} }, \%item;
262 # Hashref building...
263 $biblioitem->{'reserves'}->{'reserve'} = $holds;
264 $biblioitem->{'issues'}->{'issue'} = $issues;
266 push @records, $biblioitem;
269 return { record => \@records };
272 =head2 GetAuthorityRecords
274 Given a list of authority record identifiers, returns a list of record
275 objects that contain the authority records. The function user may request
276 a specific metadata schema for the record objects.
281 list of authority record identifiers
283 specifies the metadata schema of records to be returned, possible values:
288 sub GetAuthorityRecords {
291 # If the user asks for an unsupported schema, return an error code
292 if ( $cgi->param('schema') and $cgi->param('schema') ne "MARCXML" ) {
293 return { code => 'UnsupportedSchema' };
298 # Let's loop over the authority IDs
299 foreach my $authid ( split( / /, $cgi->param('id') ) ) {
301 # Get the record as XML string, or error code
302 push @records, GetAuthorityXML($authid) || { code => 'RecordNotFound' };
305 return { record => \@records };
310 Looks up a patron in the ILS by an identifier, and returns the borrowernumber.
315 an identifier used to look up the patron in Koha
317 the type of the identifier, possible values:
330 my $id = $cgi->param('id');
332 return { message => 'PatronNotFound' };
336 my $passed_id_type = $cgi->param('id_type');
337 if($passed_id_type) {
338 $patrons = Koha::Patrons->search( { $passed_id_type => $id } );
340 foreach my $id_type ('cardnumber', 'userid', 'email', 'borrowernumber',
341 'surname', 'firstname') {
342 $patrons = Koha::Patrons->search( { $id_type => $id } );
343 last if($patrons->count);
346 unless ( $patrons->count ) {
347 return { message => 'PatronNotFound' };
350 return { id => $patrons->next->borrowernumber };
353 =head2 AuthenticatePatron
355 Authenticates a user's login credentials and returns the identifier for
360 - username (Required)
361 user's login identifier (userid or cardnumber)
362 - password (Required)
367 sub AuthenticatePatron {
369 my $username = $cgi->param('username');
370 my $password = $cgi->param('password');
371 my ($status, $cardnumber, $userid) = C4::Auth::checkpw( C4::Context->dbh, $username, $password );
374 my $patron = Koha::Patrons->find( { userid => $userid } );
375 return { id => $patron->borrowernumber };
378 return { code => 'PatronNotFound' };
384 Returns specified information about the patron, based on options in the
385 request. This function can optionally return patron's contact information,
386 fine information, hold request information, and loan information.
390 - patron_id (Required)
392 - show_contact (Optional, default 1)
393 whether or not to return patron's contact information in the response
394 - show_fines (Optional, default 0)
395 whether or not to return fine information in the response
396 - show_holds (Optional, default 0)
397 whether or not to return hold request information in the response
398 - show_loans (Optional, default 0)
399 whether or not to return loan information request information in the response
400 - show_attributes (Optional, default 0)
401 whether or not to return additional patron attributes, when enabled the attributes
402 are limited to those marked as opac visible only.
410 my $borrowernumber = $cgi->param('patron_id');
411 my $patron = Koha::Patrons->find( $borrowernumber );
412 return { code => 'PatronNotFound' } unless $patron;
414 # Cleaning the borrower hashref
415 my $borrower = $patron->unblessed;
416 $borrower->{charges} = sprintf "%.02f", $patron->account->non_issues_charges; # FIXME Formatting should not be done here
417 my $library = Koha::Libraries->find( $borrower->{branchcode} );
418 $borrower->{'branchname'} = $library ? $library->branchname : '';
419 delete $borrower->{'userid'};
420 delete $borrower->{'password'};
422 # Contact fields management
423 if ( defined $cgi->param('show_contact') && $cgi->param('show_contact') eq "0" ) {
425 # Define contact fields
426 my @contactfields = (
427 'email', 'emailpro', 'fax', 'mobile', 'phone', 'phonepro',
428 'streetnumber', 'zipcode', 'city', 'streettype', 'B_address', 'B_city',
429 'B_email', 'B_phone', 'B_zipcode', 'address', 'address2', 'altcontactaddress1',
430 'altcontactaddress2', 'altcontactaddress3', 'altcontactfirstname', 'altcontactphone', 'altcontactsurname', 'altcontactzipcode'
434 foreach my $field (@contactfields) {
435 delete $borrower->{$field};
440 if ( $cgi->param('show_fines') && $cgi->param('show_fines') eq "1" ) {
441 $borrower->{fines}{fine} = $patron->account->lines->unblessed;
444 # Reserves management
445 if ( $cgi->param('show_holds') && $cgi->param('show_holds') eq "1" ) {
447 # Get borrower's reserves
448 my $holds = $patron->holds;
449 while ( my $hold = $holds->next ) {
451 my ( $item, $biblio, $biblioitem ) = ( {}, {}, {} );
452 # Get additional informations
453 if ( $hold->itemnumber ) { # item level holds
454 $item = Koha::Items->find( $hold->itemnumber );
455 $biblio = $item->biblio;
456 $biblioitem = $biblio->biblioitem;
458 # Remove unwanted fields
459 $item = $item->unblessed;
460 delete $item->{more_subfields_xml};
461 $biblio = $biblio->unblessed;
462 $biblioitem = $biblioitem->unblessed;
465 # Add additional fields
466 my $unblessed_hold = $hold->unblessed;
467 $unblessed_hold->{item} = { %$item, %$biblio, %$biblioitem };
468 my $library = Koha::Libraries->find( $hold->branchcode );
469 my $branchname = $library ? $library->branchname : '';
470 $unblessed_hold->{branchname} = $branchname;
471 $biblio = Koha::Biblios->find( $hold->biblionumber ); # Should be $hold->get_biblio
472 $unblessed_hold->{title} = $biblio ? $biblio->title : ''; # Just in case, but should not be needed
474 push @{ $borrower->{holds}{hold} }, $unblessed_hold;
480 if ( $cgi->param('show_loans') && $cgi->param('show_loans') eq "1" ) {
481 my $pending_checkouts = $patron->pending_checkouts;
483 while ( my $c = $pending_checkouts->next ) {
484 # FIXME We should only retrieve what is needed in the template
485 my $issue = $c->unblessed_all_relateds;
486 push @checkouts, $issue
488 $borrower->{'loans'}->{'loan'} = \@checkouts;
491 if ( $cgi->param('show_attributes') eq "1" ) {
492 my $attrs = GetBorrowerAttributes( $borrowernumber, 1 );
493 $borrower->{'attributes'} = $attrs;
496 # Add is expired information
497 $borrower->{'is_expired'} = $patron->is_expired ? 1 : 0;
502 =head2 GetPatronStatus
504 Returns a patron's status information.
508 - patron_id (Required)
513 sub GetPatronStatus {
517 my $borrowernumber = $cgi->param('patron_id');
518 my $patron = Koha::Patrons->find( $borrowernumber );
519 return { code => 'PatronNotFound' } unless $patron;
523 type => $patron->categorycode,
525 expiry => $patron->dateexpiry,
531 Returns information about the services available on a particular item for
536 - patron_id (Required)
546 # Get the member, or return an error code if not found
547 my $borrowernumber = $cgi->param('patron_id');
548 my $patron = Koha::Patrons->find( $borrowernumber );
549 return { code => 'PatronNotFound' } unless $patron;
551 my $borrower = $patron->unblessed;
552 # Get the item, or return an error code if not found
553 my $itemnumber = $cgi->param('item_id');
554 my $item = Koha::Items->find($itemnumber);
555 return { code => 'RecordNotFound' } unless $item;
559 # Reserve level management
560 my $biblionumber = $item->biblionumber;
561 my $canbookbereserved = CanBookBeReserved( $borrower, $biblionumber );
562 if ($canbookbereserved->{status} eq 'OK') {
563 push @availablefor, 'title level hold';
564 my $canitembereserved = IsAvailableForItemLevelRequest($item->unblessed, $borrower);
565 if ($canitembereserved) {
566 push @availablefor, 'item level hold';
570 # Reserve cancellation management
571 my $holds = $patron->holds;
573 while ( my $hold = $holds->next ) { # FIXME This could be improved
574 push @reserveditems, $hold->itemnumber;
576 if ( grep { $itemnumber eq $_ } @reserveditems ) {
577 push @availablefor, 'hold cancellation';
581 my @renewal = CanBookBeRenewed( $borrowernumber, $itemnumber );
583 push @availablefor, 'loan renewal';
587 my $barcode = $item->barcode || '';
588 $barcode = barcodedecode($barcode) if ( $barcode && C4::Context->preference('itemBarcodeInputFilter') );
590 my ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $patron, $barcode );
592 # TODO push @availablefor, 'loan';
596 $out->{'AvailableFor'} = \@availablefor;
603 Extends the due date for a borrower's existing issue.
607 - patron_id (Required)
611 - desired_due_date (Required)
612 the date the patron would like the item returned by
619 # Get borrower infos or return an error code
620 my $borrowernumber = $cgi->param('patron_id');
621 my $patron = Koha::Patrons->find( $borrowernumber );
622 return { code => 'PatronNotFound' } unless $patron;
624 # Get the item, or return an error code
625 my $itemnumber = $cgi->param('item_id');
626 my $item = Koha::Items->find($itemnumber);
627 return { code => 'RecordNotFound' } unless $item;
629 # Add renewal if possible
630 my @renewal = CanBookBeRenewed( $borrowernumber, $itemnumber );
631 if ( $renewal[0] ) { AddRenewal( $borrowernumber, $itemnumber ); }
633 return unless $item; # FIXME should be handled
635 my $issue = $item->checkout;
636 return $issue; # FIXME should be handled
640 $out->{'renewals'} = $issue->renewals;
641 $out->{date_due} = dt_from_string($issue->date_due)->strftime('%Y-%m-%d %H:%S');
642 $out->{'success'} = $renewal[0];
643 $out->{'error'} = $renewal[1];
650 Creates, for a borrower, a biblio-level hold reserve.
654 - patron_id (Required)
658 - request_location (Required)
659 IP address where the end user request is being placed
660 - pickup_location (Optional)
661 a branch code indicating the location to which to deliver the item for pickup
662 - needed_before_date (Optional)
663 date after which hold request is no longer needed
664 - pickup_expiry_date (Optional)
665 date after which item returned to shelf if item is not picked up
672 # Get the borrower or return an error code
673 my $borrowernumber = $cgi->param('patron_id');
674 my $patron = Koha::Patrons->find( $borrowernumber );
675 return { code => 'PatronNotFound' } unless $patron;
677 # Get the biblio record, or return an error code
678 my $biblionumber = $cgi->param('bib_id');
679 my $biblio = Koha::Biblios->find( $biblionumber );
680 return { code => 'RecordNotFound' } unless $biblio;
682 my @hostitems = get_hostitemnumbers_of($biblionumber);
685 push(@itemnumbers, @hostitems);
688 my $items = Koha::Items->search({ -or => { biblionumber => $biblionumber, itemnumber => { in => \@itemnumbers } } });
690 unless ( $items->count ) {
691 return { code => 'NoItems' };
694 my $title = $biblio ? $biblio->title : '';
696 # Check if the biblio can be reserved
697 my $code = CanBookBeReserved( $borrowernumber, $biblionumber )->{status};
698 return { code => $code } unless ( $code eq 'OK' );
702 # Pickup branch management
703 if ( $cgi->param('pickup_location') ) {
704 $branch = $cgi->param('pickup_location');
705 return { code => 'LocationNotFound' } unless Koha::Libraries->find($branch);
706 } else { # if the request provide no branch, use the borrower's branch
707 $branch = $patron->branchcode;
710 my $destination = Koha::Libraries->find($branch);
711 return { code => 'libraryNotPickupLocation' } unless $destination->pickup_location;
712 return { code => 'cannotBeTransferred' } unless $biblio->can_be_transferred({ to => $destination });
715 # $branch, $borrowernumber, $biblionumber,
716 # $constraint, $bibitems, $priority, $resdate, $expdate, $notes,
717 # $title, $checkitem, $found
718 my $priority= C4::Reserves::CalculatePriority( $biblionumber );
719 AddReserve( $branch, $borrowernumber, $biblionumber, undef, $priority, undef, undef, undef, $title, undef, undef );
723 $out->{'title'} = $title;
724 my $library = Koha::Libraries->find( $branch );
725 $out->{'pickup_location'} = $library ? $library->branchname : '';
727 # TODO $out->{'date_available'} = '';
734 Creates, for a borrower, an item-level hold request on a specific item of
735 a bibliographic record in Koha.
739 - patron_id (Required)
745 - pickup_location (Optional)
746 a branch code indicating the location to which to deliver the item for pickup
747 - needed_before_date (Optional)
748 date after which hold request is no longer needed
749 - pickup_expiry_date (Optional)
750 date after which item returned to shelf if item is not picked up
757 # Get the borrower or return an error code
758 my $borrowernumber = $cgi->param('patron_id');
759 my $patron = Koha::Patrons->find( $borrowernumber );
760 return { code => 'PatronNotFound' } unless $patron;
762 # Get the biblio or return an error code
763 my $biblionumber = $cgi->param('bib_id');
764 my $biblio = Koha::Biblios->find( $biblionumber );
765 return { code => 'RecordNotFound' } unless $biblio;
767 my $title = $biblio ? $biblio->title : '';
769 # Get the item or return an error code
770 my $itemnumber = $cgi->param('item_id');
771 my $item = Koha::Items->find($itemnumber);
772 return { code => 'RecordNotFound' } unless $item;
774 # If the biblio does not match the item, return an error code
775 return { code => 'RecordNotFound' } if $item->biblionumber ne $biblio->biblionumber;
777 # Pickup branch management
779 if ( $cgi->param('pickup_location') ) {
780 $branch = $cgi->param('pickup_location');
781 return { code => 'LocationNotFound' } unless Koha::Libraries->find($branch);
782 } else { # if the request provide no branch, use the borrower's branch
783 $branch = $patron->branchcode;
786 # Check for item disponibility
787 my $canitembereserved = C4::Reserves::CanItemBeReserved( $borrowernumber, $itemnumber, $branch )->{status};
788 return { code => $canitembereserved } unless $canitembereserved eq 'OK';
791 # $branch, $borrowernumber, $biblionumber,
792 # $constraint, $bibitems, $priority, $resdate, $expdate, $notes,
793 # $title, $checkitem, $found
794 my $priority= C4::Reserves::CalculatePriority( $biblionumber );
795 AddReserve( $branch, $borrowernumber, $biblionumber, undef, $priority, undef, undef, undef, $title, $itemnumber, undef );
799 my $library = Koha::Libraries->find( $branch );
800 $out->{'pickup_location'} = $library ? $library->branchname : '';
802 # TODO $out->{'date_available'} = '';
809 Cancels an active reserve request for the borrower.
813 - patron_id (Required)
823 # Get the borrower or return an error code
824 my $borrowernumber = $cgi->param('patron_id');
825 my $patron = Koha::Patrons->find( $borrowernumber );
826 return { code => 'PatronNotFound' } unless $patron;
828 # Get the reserve or return an error code
829 my $reserve_id = $cgi->param('item_id');
830 my $hold = Koha::Holds->find( $reserve_id );
831 return { code => 'RecordNotFound' } unless $hold;
832 return { code => 'RecordNotFound' } unless ($hold->borrowernumber == $borrowernumber);
836 return { code => 'Canceled' };
841 Returns, for an itemnumber, an array containing availability information.
843 my ($biblionumber, $status, $msg, $location) = _availability($id);
848 my ($itemnumber) = @_;
849 my $item = Koha::Items->find($itemnumber);
852 return ( undef, 'unknown', 'Error: could not retrieve availability for this ID', undef );
855 my $biblionumber = $item->biblioitemnumber;
856 my $library = Koha::Libraries->find( $item->holdingbranch );
857 my $location = $library ? $library->branchname : '';
859 if ( $item->notforloan ) {
860 return ( $biblionumber, 'not available', 'Not for loan', $location );
861 } elsif ( $item->onloan ) {
862 return ( $biblionumber, 'not available', 'Checked out', $location );
863 } elsif ( $item->itemlost ) {
864 return ( $biblionumber, 'not available', 'Item lost', $location );
865 } elsif ( $item->withdrawn ) {
866 return ( $biblionumber, 'not available', 'Item withdrawn', $location );
867 } elsif ( $item->damaged ) {
868 return ( $biblionumber, 'not available', 'Item damaged', $location );
870 return ( $biblionumber, 'available', undef, $location );