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);
46 C4::ILS-DI::Services - ILS-DI Services
50 Each function in this module represents an ILS-DI service.
51 They all takes a CGI instance as argument and most of them return a
52 hashref that will be printed by XML::Simple in opac/ilsdi.pl
56 use C4::ILSDI::Services;
62 $out = LookupPatron($cgi);
64 print CGI::header('text/xml');
69 xmldecl => '<?xml version="1.0" encoding="UTF-8" ?>',
70 RootName => 'LookupPatron',
77 =head2 GetAvailability
79 Given a set of biblionumbers or itemnumbers, returns a list with
80 availability of the items associated with the identifiers.
86 list of either biblionumbers or itemnumbers
88 =head3 id_type (Required)
90 defines the type of record identifier being used in the request,
96 =head3 return_type (Optional)
98 requests a particular level of detail in reporting availability,
104 =head3 return_fmt (Optional)
106 requests a particular format or set of formats in reporting
111 sub GetAvailability {
114 my $out = "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n";
115 $out .= "<dlf:collection\n";
116 $out .= " xmlns:dlf=\"http://diglib.org/ilsdi/1.1\"\n";
117 $out .= " xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n";
118 $out .= " xsi:schemaLocation=\"http://diglib.org/ilsdi/1.1\n";
119 $out .= " http://diglib.org/architectures/ilsdi/schemas/1.1/dlfexpanded.xsd\">\n";
121 foreach my $id ( split( / /, $cgi->param('id') ) ) {
122 if ( $cgi->param('id_type') eq "item" ) {
123 my ( $biblionumber, $status, $msg, $location ) = _availability($id);
125 $out .= " <dlf:record>\n";
126 $out .= " <dlf:bibliographic id=\"" . ( $biblionumber || $id ) . "\" />\n";
127 $out .= " <dlf:items>\n";
128 $out .= " <dlf:item id=\"" . $id . "\">\n";
129 $out .= " <dlf:simpleavailability>\n";
130 $out .= " <dlf:identifier>" . $id . "</dlf:identifier>\n";
131 $out .= " <dlf:availabilitystatus>" . $status . "</dlf:availabilitystatus>\n";
132 if ($msg) { $out .= " <dlf:availabilitymsg>" . $msg . "</dlf:availabilitymsg>\n"; }
133 if ($location) { $out .= " <dlf:location>" . $location . "</dlf:location>\n"; }
134 $out .= " </dlf:simpleavailability>\n";
135 $out .= " </dlf:item>\n";
136 $out .= " </dlf:items>\n";
137 $out .= " </dlf:record>\n";
141 my $items = GetItemnumbersForBiblio($id);
144 $out .= " <dlf:record>\n";
145 $out .= " <dlf:bibliographic id=\"" .$id. "\" />\n";
146 $out .= " <dlf:items>\n";
147 # We loop over the items to clean them
148 foreach my $itemnumber (@$items) {
149 my ( $biblionumber, $status, $msg, $location ) = _availability($itemnumber);
150 $out .= " <dlf:item id=\"" . $itemnumber . "\">\n";
151 $out .= " <dlf:simpleavailability>\n";
152 $out .= " <dlf:identifier>" . $itemnumber . "</dlf:identifier>\n";
153 $out .= " <dlf:availabilitystatus>" . $status . "</dlf:availabilitystatus>\n";
154 if ($msg) { $out .= " <dlf:availabilitymsg>" . $msg . "</dlf:availabilitymsg>\n"; }
155 if ($location) { $out .= " <dlf:location>" . $location . "</dlf:location>\n"; }
156 $out .= " </dlf:simpleavailability>\n";
157 $out .= " </dlf:item>\n";
160 $out .= " </dlf:items>\n";
161 $out .= " </dlf:record>\n";
164 $msg = "Error: could not retrieve availability for this ID";
168 $out .= "</dlf:collection>\n";
175 Given a list of biblionumbers, returns a list of record objects that
176 contain bibliographic information, as well as associated holdings and item
177 information. The caller may request a specific metadata schema for the
178 record objects to be returned.
180 This function behaves similarly to HarvestBibliographicRecords and
181 HarvestExpandedRecords in Data Aggregation, but allows quick, real time
182 lookup by bibliographic identifier.
184 You can use OAI-PMH ListRecords instead of this service.
189 list of system record identifiers
191 Defines the metadata schema in which the records are returned,
200 # Check if the schema is supported. For now, GetRecords only supports MARCXML
201 if ( $cgi->param('schema') and $cgi->param('schema') ne "MARCXML" ) {
202 return { code => 'UnsupportedSchema' };
207 # Loop over biblionumbers
208 foreach my $biblionumber ( split( / /, $cgi->param('id') ) ) {
210 # Get the biblioitem from the biblionumber
211 my $biblio = Koha::Biblios->find( $biblionumber );
212 my $biblioitem = $biblio->biblioitem;
214 $biblioitem = $biblioitem->unblessed;
216 $biblioitem->{code} = "RecordNotFound";
217 # FIXME We should not need to process something else; next?
221 my $record = GetMarcBiblio({
222 biblionumber => $biblionumber,
223 embed_items => $embed_items });
225 $biblioitem->{marcxml} = $record->as_xml_record();
228 # Get most of the needed data
229 my $biblioitemnumber = $biblioitem->{'biblioitemnumber'};
230 my $holds = $biblio->current_holds->unblessed;
231 my $issues = GetBiblioIssues($biblionumber);
232 my $items = GetItemsByBiblioitemnumber($biblioitemnumber);
234 # We loop over the items to clean them
235 foreach my $item (@$items) {
237 # This hides additionnal XML subfields, we don't need these info
238 delete $item->{'more_subfields_xml'};
240 # Display branch names instead of branch codes
241 my $home_library = Koha::Libraries->find( $item->{homebranch} );
242 my $holding_library = Koha::Libraries->find( $item->{holdingbranch} );
243 $item->{'homebranchname'} = $home_library ? $home_library->branchname : '';
244 $item->{'holdingbranchname'} = $holding_library ? $holding_library->branchname : '';
247 # Hashref building...
248 $biblioitem->{'items'}->{'item'} = $items;
249 $biblioitem->{'reserves'}->{'reserve'} = $holds;
250 $biblioitem->{'issues'}->{'issue'} = $issues;
252 push @records, $biblioitem;
255 return { record => \@records };
258 =head2 GetAuthorityRecords
260 Given a list of authority record identifiers, returns a list of record
261 objects that contain the authority records. The function user may request
262 a specific metadata schema for the record objects.
267 list of authority record identifiers
269 specifies the metadata schema of records to be returned, possible values:
274 sub GetAuthorityRecords {
277 # If the user asks for an unsupported schema, return an error code
278 if ( $cgi->param('schema') and $cgi->param('schema') ne "MARCXML" ) {
279 return { code => 'UnsupportedSchema' };
284 # Let's loop over the authority IDs
285 foreach my $authid ( split( / /, $cgi->param('id') ) ) {
287 # Get the record as XML string, or error code
288 push @records, GetAuthorityXML($authid) || { code => 'RecordNotFound' };
291 return { record => \@records };
296 Looks up a patron in the ILS by an identifier, and returns the borrowernumber.
301 an identifier used to look up the patron in Koha
303 the type of the identifier, possible values:
316 my $id = $cgi->param('id');
318 return { message => 'PatronNotFound' };
322 my $passed_id_type = $cgi->param('id_type');
323 if($passed_id_type) {
324 $patrons = Koha::Patrons->search( { $passed_id_type => $id } );
326 foreach my $id_type ('cardnumber', 'userid', 'email', 'borrowernumber',
327 'surname', 'firstname') {
328 $patrons = Koha::Patrons->search( { $id_type => $id } );
329 last if($patrons->count);
332 unless ( $patrons->count ) {
333 return { message => 'PatronNotFound' };
336 return { id => $patrons->next->borrowernumber };
339 =head2 AuthenticatePatron
341 Authenticates a user's login credentials and returns the identifier for
346 - username (Required)
347 user's login identifier (userid or cardnumber)
348 - password (Required)
353 sub AuthenticatePatron {
355 my $username = $cgi->param('username');
356 my $password = $cgi->param('password');
357 my ($status, $cardnumber, $userid) = C4::Auth::checkpw( C4::Context->dbh, $username, $password );
360 my $patron = Koha::Patrons->find( { userid => $userid } );
361 return { id => $patron->borrowernumber };
364 return { code => 'PatronNotFound' };
370 Returns specified information about the patron, based on options in the
371 request. This function can optionally return patron's contact information,
372 fine information, hold request information, and loan information.
376 - patron_id (Required)
378 - show_contact (Optional, default 1)
379 whether or not to return patron's contact information in the response
380 - show_fines (Optional, default 0)
381 whether or not to return fine information in the response
382 - show_holds (Optional, default 0)
383 whether or not to return hold request information in the response
384 - show_loans (Optional, default 0)
385 whether or not to return loan information request information in the response
393 my $borrowernumber = $cgi->param('patron_id');
394 my $patron = Koha::Patrons->find( $borrowernumber );
395 return { code => 'PatronNotFound' } unless $patron;
397 # Cleaning the borrower hashref
398 my $borrower = $patron->unblessed;
399 $borrower->{charges} = sprintf "%.02f", $patron->account->non_issues_charges; # FIXME Formatting should not be done here
400 my $library = Koha::Libraries->find( $borrower->{branchcode} );
401 $borrower->{'branchname'} = $library ? $library->branchname : '';
402 delete $borrower->{'userid'};
403 delete $borrower->{'password'};
405 # Contact fields management
406 if ( defined $cgi->param('show_contact') && $cgi->param('show_contact') eq "0" ) {
408 # Define contact fields
409 my @contactfields = (
410 'email', 'emailpro', 'fax', 'mobile', 'phone', 'phonepro',
411 'streetnumber', 'zipcode', 'city', 'streettype', 'B_address', 'B_city',
412 'B_email', 'B_phone', 'B_zipcode', 'address', 'address2', 'altcontactaddress1',
413 'altcontactaddress2', 'altcontactaddress3', 'altcontactfirstname', 'altcontactphone', 'altcontactsurname', 'altcontactzipcode'
417 foreach my $field (@contactfields) {
418 delete $borrower->{$field};
423 if ( $cgi->param('show_fines') && $cgi->param('show_fines') eq "1" ) {
425 for ( my $i = 1 ; my @charge = getcharges( $borrowernumber, undef, $i ) ; $i++ ) {
426 push( @charges, @charge );
428 $borrower->{'fines'}->{'fine'} = \@charges;
431 # Reserves management
432 if ( $cgi->param('show_holds') && $cgi->param('show_holds') eq "1" ) {
434 # Get borrower's reserves
435 my $holds = $patron->holds;
436 while ( my $hold = $holds->next ) {
438 my ( $item, $biblio, $biblioitem ) = ( {}, {}, {} );
439 # Get additional informations
440 if ( $hold->itemnumber ) { # item level holds
441 $item = Koha::Items->find( $hold->itemnumber );
442 $biblio = $item->biblio;
443 $biblioitem = $biblio->biblioitem;
445 # Remove unwanted fields
446 $item = $item->unblessed;
447 delete $item->{more_subfields_xml};
448 $biblio = $biblio->unblessed;
449 $biblioitem = $biblioitem->unblessed;
452 # Add additional fields
453 my $unblessed_hold = $hold->unblessed;
454 $unblessed_hold->{item} = { %$item, %$biblio, %$biblioitem };
455 my $library = Koha::Libraries->find( $hold->branchcode );
456 my $branchname = $library ? $library->branchname : '';
457 $unblessed_hold->{branchname} = $branchname;
458 $biblio = Koha::Biblios->find( $hold->biblionumber ); # Should be $hold->get_biblio
459 $unblessed_hold->{title} = $biblio ? $biblio->title : ''; # Just in case, but should not be needed
461 push @{ $borrower->{holds}{hold} }, $unblessed_hold;
467 if ( $cgi->param('show_loans') && $cgi->param('show_loans') eq "1" ) {
468 my $pending_checkouts = $patron->pending_checkouts;
470 while ( my $c = $pending_checkouts->next ) {
471 # FIXME We should only retrieve what is needed in the template
472 my $issue = $c->unblessed_all_relateds;
473 push @checkouts, $issue
475 $borrower->{'loans'}->{'loan'} = \@checkouts;
478 if ( $cgi->param('show_attributes') eq "1" ) {
479 my $attrs = GetBorrowerAttributes( $borrowernumber, 0, 1 );
480 $borrower->{'attributes'} = $attrs;
486 =head2 GetPatronStatus
488 Returns a patron's status information.
492 - patron_id (Required)
497 sub GetPatronStatus {
501 my $borrowernumber = $cgi->param('patron_id');
502 my $patron = Koha::Patrons->find( $borrowernumber );
503 return { code => 'PatronNotFound' } unless $patron;
507 type => $patron->categorycode,
509 expiry => $patron->dateexpiry,
515 Returns information about the services available on a particular item for
520 - patron_id (Required)
530 # Get the member, or return an error code if not found
531 my $borrowernumber = $cgi->param('patron_id');
532 my $patron = Koha::Patrons->find( $borrowernumber );
533 return { code => 'PatronNotFound' } unless $patron;
535 my $borrower = $patron->unblessed;
536 # Get the item, or return an error code if not found
537 my $itemnumber = $cgi->param('item_id');
538 my $item = GetItem( $itemnumber );
539 return { code => 'RecordNotFound' } unless $$item{itemnumber};
543 # Reserve level management
544 my $biblionumber = $item->{'biblionumber'};
545 my $canbookbereserved = CanBookBeReserved( $borrower, $biblionumber );
546 if ($canbookbereserved eq 'OK') {
547 push @availablefor, 'title level hold';
548 my $canitembereserved = IsAvailableForItemLevelRequest($item, $borrower);
549 if ($canitembereserved) {
550 push @availablefor, 'item level hold';
554 # Reserve cancellation management
555 my $holds = $patron->holds;
557 while ( my $hold = $holds->next ) { # FIXME This could be improved
558 push @reserveditems, $hold->itemnumber;
560 if ( grep { $itemnumber eq $_ } @reserveditems ) {
561 push @availablefor, 'hold cancellation';
565 my @renewal = CanBookBeRenewed( $borrowernumber, $itemnumber );
567 push @availablefor, 'loan renewal';
571 my $barcode = $item->{'barcode'} || '';
572 $barcode = barcodedecode($barcode) if ( $barcode && C4::Context->preference('itemBarcodeInputFilter') );
574 my ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $patron, $barcode );
576 # TODO push @availablefor, 'loan';
580 $out->{'AvailableFor'} = \@availablefor;
587 Extends the due date for a borrower's existing issue.
591 - patron_id (Required)
595 - desired_due_date (Required)
596 the date the patron would like the item returned by
603 # Get borrower infos or return an error code
604 my $borrowernumber = $cgi->param('patron_id');
605 my $patron = Koha::Patrons->find( $borrowernumber );
606 return { code => 'PatronNotFound' } unless $patron;
608 # Get the item, or return an error code
609 my $itemnumber = $cgi->param('item_id');
610 my $item = GetItem( $itemnumber );
611 return { code => 'RecordNotFound' } unless $$item{itemnumber};
613 # Add renewal if possible
614 my @renewal = CanBookBeRenewed( $borrowernumber, $itemnumber );
615 if ( $renewal[0] ) { AddRenewal( $borrowernumber, $itemnumber ); }
617 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return; # FIXME should be handled
621 $out->{'renewals'} = $issue->renewals;
622 $out->{date_due} = dt_from_string($issue->date_due)->strftime('%Y-%m-%d %H:%S');
623 $out->{'success'} = $renewal[0];
624 $out->{'error'} = $renewal[1];
631 Creates, for a borrower, a biblio-level hold reserve.
635 - patron_id (Required)
639 - request_location (Required)
640 IP address where the end user request is being placed
641 - pickup_location (Optional)
642 a branch code indicating the location to which to deliver the item for pickup
643 - needed_before_date (Optional)
644 date after which hold request is no longer needed
645 - pickup_expiry_date (Optional)
646 date after which item returned to shelf if item is not picked up
653 # Get the borrower or return an error code
654 my $borrowernumber = $cgi->param('patron_id');
655 my $patron = Koha::Patrons->find( $borrowernumber );
656 return { code => 'PatronNotFound' } unless $patron;
658 # Get the biblio record, or return an error code
659 my $biblionumber = $cgi->param('bib_id');
660 my $biblio = Koha::Biblios->find( $biblionumber );
661 return { code => 'RecordNotFound' } unless $biblio;
663 my $title = $biblio ? $biblio->title : '';
665 # Check if the biblio can be reserved
666 return { code => 'NotHoldable' } unless CanBookBeReserved( $borrowernumber, $biblionumber ) eq 'OK';
670 # Pickup branch management
671 if ( $cgi->param('pickup_location') ) {
672 $branch = $cgi->param('pickup_location');
673 return { code => 'LocationNotFound' } unless Koha::Libraries->find($branch);
674 } else { # if the request provide no branch, use the borrower's branch
675 $branch = $patron->branchcode;
679 # $branch, $borrowernumber, $biblionumber,
680 # $constraint, $bibitems, $priority, $resdate, $expdate, $notes,
681 # $title, $checkitem, $found
682 my $priority= C4::Reserves::CalculatePriority( $biblionumber );
683 AddReserve( $branch, $borrowernumber, $biblionumber, undef, $priority, undef, undef, undef, $title, undef, undef );
687 $out->{'title'} = $title;
688 my $library = Koha::Libraries->find( $branch );
689 $out->{'pickup_location'} = $library ? $library->branchname : '';
691 # TODO $out->{'date_available'} = '';
698 Creates, for a borrower, an item-level hold request on a specific item of
699 a bibliographic record in Koha.
703 - patron_id (Required)
709 - pickup_location (Optional)
710 a branch code indicating the location to which to deliver the item for pickup
711 - needed_before_date (Optional)
712 date after which hold request is no longer needed
713 - pickup_expiry_date (Optional)
714 date after which item returned to shelf if item is not picked up
721 # Get the borrower or return an error code
722 my $borrowernumber = $cgi->param('patron_id');
723 my $patron = Koha::Patrons->find( $borrowernumber );
724 return { code => 'PatronNotFound' } unless $patron;
726 # Get the biblio or return an error code
727 my $biblionumber = $cgi->param('bib_id');
728 my $biblio = Koha::Biblios->find( $biblionumber );
729 return { code => 'RecordNotFound' } unless $biblio;
731 my $title = $biblio ? $biblio->title : '';
733 # Get the item or return an error code
734 my $itemnumber = $cgi->param('item_id');
735 my $item = GetItem( $itemnumber );
736 return { code => 'RecordNotFound' } unless $$item{itemnumber};
738 # If the biblio does not match the item, return an error code
739 return { code => 'RecordNotFound' } if $$item{biblionumber} ne $biblio->biblionumber;
741 # Check for item disponibility
742 my $canitembereserved = C4::Reserves::CanItemBeReserved( $borrowernumber, $itemnumber );
743 my $canbookbereserved = C4::Reserves::CanBookBeReserved( $borrowernumber, $biblionumber );
744 return { code => 'NotHoldable' } unless $canbookbereserved eq 'OK' and $canitembereserved eq 'OK';
746 # Pickup branch management
748 if ( $cgi->param('pickup_location') ) {
749 $branch = $cgi->param('pickup_location');
750 return { code => 'LocationNotFound' } unless Koha::Libraries->find($branch);
751 } else { # if the request provide no branch, use the borrower's branch
752 $branch = $patron->branchcode;
756 # $branch, $borrowernumber, $biblionumber,
757 # $constraint, $bibitems, $priority, $resdate, $expdate, $notes,
758 # $title, $checkitem, $found
759 my $priority= C4::Reserves::CalculatePriority( $biblionumber );
760 AddReserve( $branch, $borrowernumber, $biblionumber, undef, $priority, undef, undef, undef, $title, $itemnumber, undef );
764 my $library = Koha::Libraries->find( $branch );
765 $out->{'pickup_location'} = $library ? $library->branchname : '';
767 # TODO $out->{'date_available'} = '';
774 Cancels an active reserve request for the borrower.
778 - patron_id (Required)
788 # Get the borrower or return an error code
789 my $borrowernumber = $cgi->param('patron_id');
790 my $patron = Koha::Patrons->find( $borrowernumber );
791 return { code => 'PatronNotFound' } unless $patron;
793 # Get the reserve or return an error code
794 my $reserve_id = $cgi->param('item_id');
795 my $hold = Koha::Holds->find( $reserve_id );
796 return { code => 'RecordNotFound' } unless $hold;
797 return { code => 'RecordNotFound' } unless ($hold->borrowernumber == $borrowernumber);
801 return { code => 'Canceled' };
806 Returns, for an itemnumber, an array containing availability information.
808 my ($biblionumber, $status, $msg, $location) = _availability($id);
813 my ($itemnumber) = @_;
814 my $item = GetItem( $itemnumber, undef, undef );
816 if ( not $item->{'itemnumber'} ) {
817 return ( undef, 'unknown', 'Error: could not retrieve availability for this ID', undef );
820 my $biblionumber = $item->{'biblioitemnumber'};
821 my $library = Koha::Libraries->find( $item->{holdingbranch} );
822 my $location = $library ? $library->branchname : '';
824 if ( $item->{'notforloan'} ) {
825 return ( $biblionumber, 'not available', 'Not for loan', $location );
826 } elsif ( $item->{'onloan'} ) {
827 return ( $biblionumber, 'not available', 'Checked out', $location );
828 } elsif ( $item->{'itemlost'} ) {
829 return ( $biblionumber, 'not available', 'Item lost', $location );
830 } elsif ( $item->{'withdrawn'} ) {
831 return ( $biblionumber, 'not available', 'Item withdrawn', $location );
832 } elsif ( $item->{'damaged'} ) {
833 return ( $biblionumber, 'not available', 'Item damaged', $location );
835 return ( $biblionumber, 'available', undef, $location );