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->unblessed;
235 # We loop over the items to clean them
236 foreach my $item (@$items) {
238 # This hides additionnal XML subfields, we don't need these info
239 delete $item->{'more_subfields_xml'};
241 # Display branch names instead of branch codes
242 my $home_library = Koha::Libraries->find( $item->{homebranch} );
243 my $holding_library = Koha::Libraries->find( $item->{holdingbranch} );
244 $item->{'homebranchname'} = $home_library ? $home_library->branchname : '';
245 $item->{'holdingbranchname'} = $holding_library ? $holding_library->branchname : '';
248 # Hashref building...
249 $biblioitem->{'items'}->{'item'} = $items;
250 $biblioitem->{'reserves'}->{'reserve'} = $holds;
251 $biblioitem->{'issues'}->{'issue'} = $issues;
253 push @records, $biblioitem;
256 return { record => \@records };
259 =head2 GetAuthorityRecords
261 Given a list of authority record identifiers, returns a list of record
262 objects that contain the authority records. The function user may request
263 a specific metadata schema for the record objects.
268 list of authority record identifiers
270 specifies the metadata schema of records to be returned, possible values:
275 sub GetAuthorityRecords {
278 # If the user asks for an unsupported schema, return an error code
279 if ( $cgi->param('schema') and $cgi->param('schema') ne "MARCXML" ) {
280 return { code => 'UnsupportedSchema' };
285 # Let's loop over the authority IDs
286 foreach my $authid ( split( / /, $cgi->param('id') ) ) {
288 # Get the record as XML string, or error code
289 push @records, GetAuthorityXML($authid) || { code => 'RecordNotFound' };
292 return { record => \@records };
297 Looks up a patron in the ILS by an identifier, and returns the borrowernumber.
302 an identifier used to look up the patron in Koha
304 the type of the identifier, possible values:
317 my $id = $cgi->param('id');
319 return { message => 'PatronNotFound' };
323 my $passed_id_type = $cgi->param('id_type');
324 if($passed_id_type) {
325 $patrons = Koha::Patrons->search( { $passed_id_type => $id } );
327 foreach my $id_type ('cardnumber', 'userid', 'email', 'borrowernumber',
328 'surname', 'firstname') {
329 $patrons = Koha::Patrons->search( { $id_type => $id } );
330 last if($patrons->count);
333 unless ( $patrons->count ) {
334 return { message => 'PatronNotFound' };
337 return { id => $patrons->next->borrowernumber };
340 =head2 AuthenticatePatron
342 Authenticates a user's login credentials and returns the identifier for
347 - username (Required)
348 user's login identifier (userid or cardnumber)
349 - password (Required)
354 sub AuthenticatePatron {
356 my $username = $cgi->param('username');
357 my $password = $cgi->param('password');
358 my ($status, $cardnumber, $userid) = C4::Auth::checkpw( C4::Context->dbh, $username, $password );
361 my $patron = Koha::Patrons->find( { userid => $userid } );
362 return { id => $patron->borrowernumber };
365 return { code => 'PatronNotFound' };
371 Returns specified information about the patron, based on options in the
372 request. This function can optionally return patron's contact information,
373 fine information, hold request information, and loan information.
377 - patron_id (Required)
379 - show_contact (Optional, default 1)
380 whether or not to return patron's contact information in the response
381 - show_fines (Optional, default 0)
382 whether or not to return fine information in the response
383 - show_holds (Optional, default 0)
384 whether or not to return hold request information in the response
385 - show_loans (Optional, default 0)
386 whether or not to return loan information request information in the response
387 - show_attributes (Optional, default 0)
388 whether or not to return additional patron attributes, when enabled the attributes
389 are limited to those marked as opac visible only.
397 my $borrowernumber = $cgi->param('patron_id');
398 my $patron = Koha::Patrons->find( $borrowernumber );
399 return { code => 'PatronNotFound' } unless $patron;
401 # Cleaning the borrower hashref
402 my $borrower = $patron->unblessed;
403 $borrower->{charges} = sprintf "%.02f", $patron->account->non_issues_charges; # FIXME Formatting should not be done here
404 my $library = Koha::Libraries->find( $borrower->{branchcode} );
405 $borrower->{'branchname'} = $library ? $library->branchname : '';
406 delete $borrower->{'userid'};
407 delete $borrower->{'password'};
409 # Contact fields management
410 if ( defined $cgi->param('show_contact') && $cgi->param('show_contact') eq "0" ) {
412 # Define contact fields
413 my @contactfields = (
414 'email', 'emailpro', 'fax', 'mobile', 'phone', 'phonepro',
415 'streetnumber', 'zipcode', 'city', 'streettype', 'B_address', 'B_city',
416 'B_email', 'B_phone', 'B_zipcode', 'address', 'address2', 'altcontactaddress1',
417 'altcontactaddress2', 'altcontactaddress3', 'altcontactfirstname', 'altcontactphone', 'altcontactsurname', 'altcontactzipcode'
421 foreach my $field (@contactfields) {
422 delete $borrower->{$field};
427 if ( $cgi->param('show_fines') && $cgi->param('show_fines') eq "1" ) {
428 $borrower->{fines}{fine} = $patron->account->lines->unblessed;
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, 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->{status} 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 my $code = CanBookBeReserved( $borrowernumber, $biblionumber )->{status};
667 return { code => $code } unless ( $code eq 'OK' );
671 # Pickup branch management
672 if ( $cgi->param('pickup_location') ) {
673 $branch = $cgi->param('pickup_location');
674 return { code => 'LocationNotFound' } unless Koha::Libraries->find($branch);
675 } else { # if the request provide no branch, use the borrower's branch
676 $branch = $patron->branchcode;
680 # $branch, $borrowernumber, $biblionumber,
681 # $constraint, $bibitems, $priority, $resdate, $expdate, $notes,
682 # $title, $checkitem, $found
683 my $priority= C4::Reserves::CalculatePriority( $biblionumber );
684 AddReserve( $branch, $borrowernumber, $biblionumber, undef, $priority, undef, undef, undef, $title, undef, undef );
688 $out->{'title'} = $title;
689 my $library = Koha::Libraries->find( $branch );
690 $out->{'pickup_location'} = $library ? $library->branchname : '';
692 # TODO $out->{'date_available'} = '';
699 Creates, for a borrower, an item-level hold request on a specific item of
700 a bibliographic record in Koha.
704 - patron_id (Required)
710 - pickup_location (Optional)
711 a branch code indicating the location to which to deliver the item for pickup
712 - needed_before_date (Optional)
713 date after which hold request is no longer needed
714 - pickup_expiry_date (Optional)
715 date after which item returned to shelf if item is not picked up
722 # Get the borrower or return an error code
723 my $borrowernumber = $cgi->param('patron_id');
724 my $patron = Koha::Patrons->find( $borrowernumber );
725 return { code => 'PatronNotFound' } unless $patron;
727 # Get the biblio or return an error code
728 my $biblionumber = $cgi->param('bib_id');
729 my $biblio = Koha::Biblios->find( $biblionumber );
730 return { code => 'RecordNotFound' } unless $biblio;
732 my $title = $biblio ? $biblio->title : '';
734 # Get the item or return an error code
735 my $itemnumber = $cgi->param('item_id');
736 my $item = GetItem( $itemnumber );
737 return { code => 'RecordNotFound' } unless $$item{itemnumber};
739 # If the biblio does not match the item, return an error code
740 return { code => 'RecordNotFound' } if $$item{biblionumber} ne $biblio->biblionumber;
742 # Check for item disponibility
743 my $canitembereserved = C4::Reserves::CanItemBeReserved( $borrowernumber, $itemnumber )->{status};
744 my $canbookbereserved = C4::Reserves::CanBookBeReserved( $borrowernumber, $biblionumber )->{status};
745 return { code => $canitembereserved } unless $canitembereserved eq 'OK';
746 return { code => $canbookbereserved } unless $canbookbereserved eq 'OK';
748 # Pickup branch management
750 if ( $cgi->param('pickup_location') ) {
751 $branch = $cgi->param('pickup_location');
752 return { code => 'LocationNotFound' } unless Koha::Libraries->find($branch);
753 } else { # if the request provide no branch, use the borrower's branch
754 $branch = $patron->branchcode;
758 # $branch, $borrowernumber, $biblionumber,
759 # $constraint, $bibitems, $priority, $resdate, $expdate, $notes,
760 # $title, $checkitem, $found
761 my $priority= C4::Reserves::CalculatePriority( $biblionumber );
762 AddReserve( $branch, $borrowernumber, $biblionumber, undef, $priority, undef, undef, undef, $title, $itemnumber, undef );
766 my $library = Koha::Libraries->find( $branch );
767 $out->{'pickup_location'} = $library ? $library->branchname : '';
769 # TODO $out->{'date_available'} = '';
776 Cancels an active reserve request for the borrower.
780 - patron_id (Required)
790 # Get the borrower or return an error code
791 my $borrowernumber = $cgi->param('patron_id');
792 my $patron = Koha::Patrons->find( $borrowernumber );
793 return { code => 'PatronNotFound' } unless $patron;
795 # Get the reserve or return an error code
796 my $reserve_id = $cgi->param('item_id');
797 my $hold = Koha::Holds->find( $reserve_id );
798 return { code => 'RecordNotFound' } unless $hold;
799 return { code => 'RecordNotFound' } unless ($hold->borrowernumber == $borrowernumber);
803 return { code => 'Canceled' };
808 Returns, for an itemnumber, an array containing availability information.
810 my ($biblionumber, $status, $msg, $location) = _availability($id);
815 my ($itemnumber) = @_;
816 my $item = GetItem( $itemnumber, undef, undef );
818 if ( not $item->{'itemnumber'} ) {
819 return ( undef, 'unknown', 'Error: could not retrieve availability for this ID', undef );
822 my $biblionumber = $item->{'biblioitemnumber'};
823 my $library = Koha::Libraries->find( $item->{holdingbranch} );
824 my $location = $library ? $library->branchname : '';
826 if ( $item->{'notforloan'} ) {
827 return ( $biblionumber, 'not available', 'Not for loan', $location );
828 } elsif ( $item->{'onloan'} ) {
829 return ( $biblionumber, 'not available', 'Checked out', $location );
830 } elsif ( $item->{'itemlost'} ) {
831 return ( $biblionumber, 'not available', 'Item lost', $location );
832 } elsif ( $item->{'withdrawn'} ) {
833 return ( $biblionumber, 'not available', 'Item withdrawn', $location );
834 } elsif ( $item->{'damaged'} ) {
835 return ( $biblionumber, 'not available', 'Item damaged', $location );
837 return ( $biblionumber, 'available', undef, $location );