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>.
29 use C4::Reserves qw(AddReserve GetReservesFromBiblionumber GetReservesFromBorrowernumber CanBookBeReserved CanItemBeReserved IsAvailableForItemLevelRequest);
31 use C4::AuthoritiesMarc;
37 use C4::Members::Attributes qw(GetBorrowerAttributes);
41 C4::ILS-DI::Services - ILS-DI Services
45 Each function in this module represents an ILS-DI service.
46 They all takes a CGI instance as argument and most of them return a
47 hashref that will be printed by XML::Simple in opac/ilsdi.pl
51 use C4::ILSDI::Services;
57 $out = LookupPatron($cgi);
59 print CGI::header('text/xml');
64 xmldecl => '<?xml version="1.0" encoding="UTF-8" ?>',
65 RootName => 'LookupPatron',
72 =head2 GetAvailability
74 Given a set of biblionumbers or itemnumbers, returns a list with
75 availability of the items associated with the identifiers.
81 list of either biblionumbers or itemnumbers
83 =head3 id_type (Required)
85 defines the type of record identifier being used in the request,
91 =head3 return_type (Optional)
93 requests a particular level of detail in reporting availability,
99 =head3 return_fmt (Optional)
101 requests a particular format or set of formats in reporting
106 sub GetAvailability {
109 my $out = "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n";
110 $out .= "<dlf:collection\n";
111 $out .= " xmlns:dlf=\"http://diglib.org/ilsdi/1.1\"\n";
112 $out .= " xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n";
113 $out .= " xsi:schemaLocation=\"http://diglib.org/ilsdi/1.1\n";
114 $out .= " http://diglib.org/architectures/ilsdi/schemas/1.1/dlfexpanded.xsd\">\n";
116 foreach my $id ( split( / /, $cgi->param('id') ) ) {
117 if ( $cgi->param('id_type') eq "item" ) {
118 my ( $biblionumber, $status, $msg, $location ) = _availability($id);
120 $out .= " <dlf:record>\n";
121 $out .= " <dlf:bibliographic id=\"" . ( $biblionumber || $id ) . "\" />\n";
122 $out .= " <dlf:items>\n";
123 $out .= " <dlf:item id=\"" . $id . "\">\n";
124 $out .= " <dlf:simpleavailability>\n";
125 $out .= " <dlf:identifier>" . $id . "</dlf:identifier>\n";
126 $out .= " <dlf:availabilitystatus>" . $status . "</dlf:availabilitystatus>\n";
127 if ($msg) { $out .= " <dlf:availabilitymsg>" . $msg . "</dlf:availabilitymsg>\n"; }
128 if ($location) { $out .= " <dlf:location>" . $location . "</dlf:location>\n"; }
129 $out .= " </dlf:simpleavailability>\n";
130 $out .= " </dlf:item>\n";
131 $out .= " </dlf:items>\n";
132 $out .= " </dlf:record>\n";
136 my $biblioitem = ( GetBiblioItemByBiblioNumber( $id, undef ) )[0];
141 $msg = "Error: could not retrieve availability for this ID";
143 $out .= " <dlf:record>\n";
144 $out .= " <dlf:bibliographic id=\"" . $id . "\" />\n";
145 $out .= " <dlf:simpleavailability>\n";
146 $out .= " <dlf:identifier>" . $id . "</dlf:identifier>\n";
147 $out .= " <dlf:availabilitystatus>" . $status . "</dlf:availabilitystatus>\n";
148 $out .= " <dlf:availabilitymsg>" . $msg . "</dlf:availabilitymsg>\n";
149 $out .= " </dlf:simpleavailability>\n";
150 $out .= " </dlf:record>\n";
153 $out .= "</dlf:collection>\n";
160 Given a list of biblionumbers, returns a list of record objects that
161 contain bibliographic information, as well as associated holdings and item
162 information. The caller may request a specific metadata schema for the
163 record objects to be returned.
165 This function behaves similarly to HarvestBibliographicRecords and
166 HarvestExpandedRecords in Data Aggregation, but allows quick, real time
167 lookup by bibliographic identifier.
169 You can use OAI-PMH ListRecords instead of this service.
174 list of system record identifiers
176 Defines the metadata schema in which the records are returned,
185 # Check if the schema is supported. For now, GetRecords only supports MARCXML
186 if ( $cgi->param('schema') and $cgi->param('schema') ne "MARCXML" ) {
187 return { code => 'UnsupportedSchema' };
192 # Loop over biblionumbers
193 foreach my $biblionumber ( split( / /, $cgi->param('id') ) ) {
195 # Get the biblioitem from the biblionumber
196 my $biblioitem = ( GetBiblioItemByBiblioNumber( $biblionumber, undef ) )[0];
197 if ( not $biblioitem->{'biblionumber'} ) {
198 $biblioitem->{code} = "RecordNotFound";
202 my $record = GetMarcBiblio($biblionumber, $embed_items);
204 $biblioitem->{marcxml} = $record->as_xml_record();
207 # We don't want MARC to be displayed
208 delete $biblioitem->{'marc'};
210 # Get most of the needed data
211 my $biblioitemnumber = $biblioitem->{'biblioitemnumber'};
212 my $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber });
213 my $issues = GetBiblioIssues($biblionumber);
214 my $items = GetItemsByBiblioitemnumber($biblioitemnumber);
216 # We loop over the items to clean them
217 foreach my $item (@$items) {
219 # This hides additionnal XML subfields, we don't need these info
220 delete $item->{'more_subfields_xml'};
222 # Display branch names instead of branch codes
223 $item->{'homebranchname'} = GetBranchName( $item->{'homebranch'} );
224 $item->{'holdingbranchname'} = GetBranchName( $item->{'holdingbranch'} );
227 # Hashref building...
228 $biblioitem->{'items'}->{'item'} = $items;
229 $biblioitem->{'reserves'}->{'reserve'} = $reserves;
230 $biblioitem->{'issues'}->{'issue'} = $issues;
232 push @records, $biblioitem;
235 return { record => \@records };
238 =head2 GetAuthorityRecords
240 Given a list of authority record identifiers, returns a list of record
241 objects that contain the authority records. The function user may request
242 a specific metadata schema for the record objects.
247 list of authority record identifiers
249 specifies the metadata schema of records to be returned, possible values:
254 sub GetAuthorityRecords {
257 # If the user asks for an unsupported schema, return an error code
258 if ( $cgi->param('schema') and $cgi->param('schema') ne "MARCXML" ) {
259 return { code => 'UnsupportedSchema' };
264 # Let's loop over the authority IDs
265 foreach my $authid ( split( / /, $cgi->param('id') ) ) {
267 # Get the record as XML string, or error code
268 push @records, GetAuthorityXML($authid) || { code => 'RecordNotFound' };
271 return { record => \@records };
276 Looks up a patron in the ILS by an identifier, and returns the borrowernumber.
281 an identifier used to look up the patron in Koha
283 the type of the identifier, possible values:
294 # Get the borrower...
295 my $borrower = GetMember($cgi->param('id_type') => $cgi->param('id'));
296 if ( not $borrower->{'borrowernumber'} ) {
297 return { message => 'PatronNotFound' };
301 my $patron->{'id'} = $borrower->{'borrowernumber'};
302 return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
304 # ...and return his ID
308 =head2 AuthenticatePatron
310 Authenticates a user's login credentials and returns the identifier for
315 - username (Required)
316 user's login identifier (userid or cardnumber)
317 - password (Required)
322 sub AuthenticatePatron {
324 my $username = $cgi->param('username');
325 my $password = $cgi->param('password');
326 my ($status, $cardnumber, $userid) = C4::Auth::checkpw( C4::Context->dbh, $username, $password );
329 my $borrower = GetMember( cardnumber => $cardnumber );
330 my $patron->{'id'} = $borrower->{'borrowernumber'};
334 return { code => 'PatronNotFound' };
340 Returns specified information about the patron, based on options in the
341 request. This function can optionally return patron's contact information,
342 fine information, hold request information, and loan information.
346 - patron_id (Required)
348 - show_contact (Optional, default 1)
349 whether or not to return patron's contact information in the response
350 - show_fines (Optional, default 0)
351 whether or not to return fine information in the response
352 - show_holds (Optional, default 0)
353 whether or not to return hold request information in the response
354 - show_loans (Optional, default 0)
355 whether or not to return loan information request information in the response
363 my $borrowernumber = $cgi->param('patron_id');
364 my $borrower = GetMemberDetails( $borrowernumber );
365 return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
367 # Cleaning the borrower hashref
368 $borrower->{'charges'} = $borrower->{'flags'}->{'CHARGES'}->{'amount'};
369 $borrower->{'branchname'} = GetBranchName( $borrower->{'branchcode'} );
370 delete $borrower->{'flags'};
371 delete $borrower->{'userid'};
372 delete $borrower->{'password'};
374 # Contact fields management
375 if ( defined $cgi->param('show_contact') && $cgi->param('show_contact') eq "0" ) {
377 # Define contact fields
378 my @contactfields = (
379 'email', 'emailpro', 'fax', 'mobile', 'phone', 'phonepro',
380 'streetnumber', 'zipcode', 'city', 'streettype', 'B_address', 'B_city',
381 'B_email', 'B_phone', 'B_zipcode', 'address', 'address2', 'altcontactaddress1',
382 'altcontactaddress2', 'altcontactaddress3', 'altcontactfirstname', 'altcontactphone', 'altcontactsurname', 'altcontactzipcode'
386 foreach my $field (@contactfields) {
387 delete $borrower->{$field};
392 if ( $cgi->param('show_fines') && $cgi->param('show_fines') eq "1" ) {
394 for ( my $i = 1 ; my @charge = getcharges( $borrowernumber, undef, $i ) ; $i++ ) {
395 push( @charges, @charge );
397 $borrower->{'fines'}->{'fine'} = \@charges;
400 # Reserves management
401 if ( $cgi->param('show_holds') && $cgi->param('show_holds') eq "1" ) {
403 # Get borrower's reserves
404 my @reserves = GetReservesFromBorrowernumber( $borrowernumber, undef );
405 foreach my $reserve (@reserves) {
407 # Get additional informations
408 my $item = GetBiblioFromItemNumber( $reserve->{'itemnumber'}, undef );
409 my $branchname = GetBranchName( $reserve->{'branchcode'} );
411 # Remove unwanted fields
412 delete $item->{'marc'};
413 delete $item->{'marcxml'};
414 delete $item->{'more_subfields_xml'};
416 # Add additional fields
417 $reserve->{'item'} = $item;
418 $reserve->{'branchname'} = $branchname;
419 $reserve->{'title'} = GetBiblio( $reserve->{'biblionumber'} )->{'title'};
421 $borrower->{'holds'}->{'hold'} = \@reserves;
425 if ( $cgi->param('show_loans') && $cgi->param('show_loans') eq "1" ) {
426 my $issues = GetPendingIssues($borrowernumber);
427 foreach my $issue ( @$issues ){
428 $issue->{'issuedate'} = $issue->{'issuedate'}->strftime('%Y-%m-%d %H:%M');
429 $issue->{'date_due'} = $issue->{'date_due'}->strftime('%Y-%m-%d %H:%M');
431 $borrower->{'loans'}->{'loan'} = $issues;
434 if ( $cgi->param('show_attributes') eq "1" ) {
435 my $attrs = GetBorrowerAttributes( $borrowernumber, 0, 1 );
436 $borrower->{'attributes'} = $attrs;
442 =head2 GetPatronStatus
444 Returns a patron's status information.
448 - patron_id (Required)
453 sub GetPatronStatus {
457 my $borrowernumber = $cgi->param('patron_id');
458 my $borrower = GetMemberDetails( $borrowernumber );
459 return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
463 type => $$borrower{categorycode},
465 expiry => $$borrower{dateexpiry},
471 Returns information about the services available on a particular item for
476 - patron_id (Required)
485 # Get the member, or return an error code if not found
486 my $borrowernumber = $cgi->param('patron_id');
487 my $borrower = GetMemberDetails( $borrowernumber );
488 return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
490 # Get the item, or return an error code if not found
491 my $itemnumber = $cgi->param('item_id');
492 my $item = GetItem( $itemnumber );
493 return { code => 'RecordNotFound' } unless $$item{itemnumber};
497 # Reserve level management
498 my $biblionumber = $item->{'biblionumber'};
499 my $canbookbereserved = CanBookBeReserved( $borrower, $biblionumber );
500 if ($canbookbereserved eq 'OK') {
501 push @availablefor, 'title level hold';
502 my $canitembereserved = IsAvailableForItemLevelRequest($item, $borrower);
503 if ($canitembereserved) {
504 push @availablefor, 'item level hold';
508 # Reserve cancellation management
509 my @reserves = GetReservesFromBorrowernumber( $borrowernumber, undef );
511 foreach my $reserve (@reserves) {
512 push @reserveditems, $reserve->{'itemnumber'};
514 if ( grep { $itemnumber eq $_ } @reserveditems ) {
515 push @availablefor, 'hold cancellation';
519 my @renewal = CanBookBeRenewed( $borrowernumber, $itemnumber );
521 push @availablefor, 'loan renewal';
525 my $barcode = $item->{'barcode'} || '';
526 $barcode = barcodedecode($barcode) if ( $barcode && C4::Context->preference('itemBarcodeInputFilter') );
528 my ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower, $barcode );
530 # TODO push @availablefor, 'loan';
534 $out->{'AvailableFor'} = \@availablefor;
541 Extends the due date for a borrower's existing issue.
545 - patron_id (Required)
549 - desired_due_date (Required)
550 the date the patron would like the item returned by
557 # Get borrower infos or return an error code
558 my $borrowernumber = $cgi->param('patron_id');
559 my $borrower = GetMemberDetails( $borrowernumber );
560 return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
562 # Get the item, or return an error code
563 my $itemnumber = $cgi->param('item_id');
564 my $item = GetItem( $itemnumber );
565 return { code => 'RecordNotFound' } unless $$item{itemnumber};
567 # Add renewal if possible
568 my @renewal = CanBookBeRenewed( $borrowernumber, $itemnumber );
569 if ( $renewal[0] ) { AddRenewal( $borrowernumber, $itemnumber ); }
571 my $issue = GetItemIssue($itemnumber);
575 $out->{'renewals'} = $issue->{'renewals'};
576 $out->{date_due} = $issue->{date_due}->strftime('%Y-%m-%d %H:%S');
577 $out->{'success'} = $renewal[0];
578 $out->{'error'} = $renewal[1];
585 Creates, for a borrower, a biblio-level hold reserve.
589 - patron_id (Required)
593 - request_location (Required)
594 IP address where the end user request is being placed
595 - pickup_location (Optional)
596 a branch code indicating the location to which to deliver the item for pickup
597 - needed_before_date (Optional)
598 date after which hold request is no longer needed
599 - pickup_expiry_date (Optional)
600 date after which item returned to shelf if item is not picked up
607 # Get the borrower or return an error code
608 my $borrowernumber = $cgi->param('patron_id');
609 my $borrower = GetMemberDetails( $borrowernumber );
610 return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
612 # Get the biblio record, or return an error code
613 my $biblionumber = $cgi->param('bib_id');
614 my $biblio = GetBiblio( $biblionumber );
615 return { code => 'RecordNotFound' } unless $$biblio{biblionumber};
617 my $title = $$biblio{title};
619 # Check if the biblio can be reserved
620 return { code => 'NotHoldable' } unless CanBookBeReserved( $borrowernumber, $biblionumber ) eq 'OK';
624 # Pickup branch management
625 if ( $cgi->param('pickup_location') ) {
626 $branch = $cgi->param('pickup_location');
627 my $branches = GetBranches;
628 return { code => 'LocationNotFound' } unless $$branches{$branch};
629 } else { # if the request provide no branch, use the borrower's branch
630 $branch = $$borrower{branchcode};
634 # $branch, $borrowernumber, $biblionumber,
635 # $constraint, $bibitems, $priority, $resdate, $expdate, $notes,
636 # $title, $checkitem, $found
637 my $priority= C4::Reserves::CalculatePriority( $biblionumber );
638 AddReserve( $branch, $borrowernumber, $biblionumber, undef, $priority, undef, undef, undef, $title, undef, undef );
642 $out->{'title'} = $title;
643 $out->{'pickup_location'} = GetBranchName($branch);
645 # TODO $out->{'date_available'} = '';
652 Creates, for a borrower, an item-level hold request on a specific item of
653 a bibliographic record in Koha.
657 - patron_id (Required)
663 - pickup_location (Optional)
664 a branch code indicating the location to which to deliver the item for pickup
665 - needed_before_date (Optional)
666 date after which hold request is no longer needed
667 - pickup_expiry_date (Optional)
668 date after which item returned to shelf if item is not picked up
675 # Get the borrower or return an error code
676 my $borrowernumber = $cgi->param('patron_id');
677 my $borrower = GetMemberDetails( $borrowernumber );
678 return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
680 # Get the biblio or return an error code
681 my $biblionumber = $cgi->param('bib_id');
682 my $biblio = GetBiblio($biblionumber);
683 return { code => 'RecordNotFound' } unless $$biblio{biblionumber};
685 my $title = $$biblio{title};
687 # Get the item or return an error code
688 my $itemnumber = $cgi->param('item_id');
689 my $item = GetItem( $itemnumber );
690 return { code => 'RecordNotFound' } unless $$item{itemnumber};
692 # If the biblio does not match the item, return an error code
693 return { code => 'RecordNotFound' } if $$item{biblionumber} ne $$biblio{biblionumber};
695 # Check for item disponibility
696 my $canitembereserved = C4::Reserves::CanItemBeReserved( $borrowernumber, $itemnumber );
697 my $canbookbereserved = C4::Reserves::CanBookBeReserved( $borrowernumber, $biblionumber );
698 return { code => 'NotHoldable' } unless $canbookbereserved eq 'OK' and $canitembereserved eq 'OK';
700 # Pickup branch management
702 if ( $cgi->param('pickup_location') ) {
703 $branch = $cgi->param('pickup_location');
704 my $branches = GetBranches();
705 return { code => 'LocationNotFound' } unless $$branches{$branch};
706 } else { # if the request provide no branch, use the borrower's branch
707 $branch = $$borrower{branchcode};
711 # $branch, $borrowernumber, $biblionumber,
712 # $constraint, $bibitems, $priority, $resdate, $expdate, $notes,
713 # $title, $checkitem, $found
714 my $priority= C4::Reserves::CalculatePriority( $biblionumber );
715 AddReserve( $branch, $borrowernumber, $biblionumber, undef, $priority, undef, undef, undef, $title, $itemnumber, undef );
719 $out->{'pickup_location'} = GetBranchName($branch);
721 # TODO $out->{'date_available'} = '';
728 Cancels an active reserve request for the borrower.
732 - patron_id (Required)
742 # Get the borrower or return an error code
743 my $borrowernumber = $cgi->param('patron_id');
744 my $borrower = GetMemberDetails( $borrowernumber );
745 return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
747 # Get the reserve or return an error code
748 my $reserve_id = $cgi->param('item_id');
749 my $reserve = C4::Reserves::GetReserve($reserve_id);
750 return { code => 'RecordNotFound' } unless $reserve;
751 return { code => 'RecordNotFound' } unless ($reserve->{borrowernumber} == $borrowernumber);
753 C4::Reserves::CancelReserve({reserve_id => $reserve_id});
755 return { code => 'Canceled' };
760 Returns, for an itemnumber, an array containing availability information.
762 my ($biblionumber, $status, $msg, $location) = _availability($id);
767 my ($itemnumber) = @_;
768 my $item = GetItem( $itemnumber, undef, undef );
770 if ( not $item->{'itemnumber'} ) {
771 return ( undef, 'unknown', 'Error: could not retrieve availability for this ID', undef );
774 my $biblionumber = $item->{'biblioitemnumber'};
775 my $location = GetBranchName( $item->{'holdingbranch'} );
777 if ( $item->{'notforloan'} ) {
778 return ( $biblionumber, 'not available', 'Not for loan', $location );
779 } elsif ( $item->{'onloan'} ) {
780 return ( $biblionumber, 'not available', 'Checked out', $location );
781 } elsif ( $item->{'itemlost'} ) {
782 return ( $biblionumber, 'not available', 'Item lost', $location );
783 } elsif ( $item->{'withdrawn'} ) {
784 return ( $biblionumber, 'not available', 'Item withdrawn', $location );
785 } elsif ( $item->{'damaged'} ) {
786 return ( $biblionumber, 'not available', 'Item damaged', $location );
788 return ( $biblionumber, 'available', undef, $location );