use C4::Circulation;
use C4::Accounts;
use C4::Biblio;
-use C4::Reserves qw(AddReserve GetReservesFromBiblionumber GetReservesFromBorrowernumber CanBookBeReserved CanItemBeReserved IsAvailableForItemLevelRequest);
+use C4::Reserves qw(AddReserve CanBookBeReserved CanItemBeReserved IsAvailableForItemLevelRequest);
use C4::Context;
use C4::AuthoritiesMarc;
use XML::Simple;
use DateTime;
use C4::Auth;
use C4::Members::Attributes qw(GetBorrowerAttributes);
+use Koha::DateUtils;
+use Koha::Biblios;
+use Koha::Checkouts;
use Koha::Libraries;
+use Koha::Patrons;
=head1 NAME
=head1 DESCRIPTION
Each function in this module represents an ILS-DI service.
-They all takes a CGI instance as argument and most of them return a
+They all takes a CGI instance as argument and most of them return a
hashref that will be printed by XML::Simple in opac/ilsdi.pl
=head1 SYNOPSIS
- use C4::ILSDI::Services;
- use XML::Simple;
- use CGI qw ( -utf8 );
+ use C4::ILSDI::Services;
+ use XML::Simple;
+ use CGI qw ( -utf8 );
- my $cgi = new CGI;
+ my $cgi = new CGI;
- $out = LookupPatron($cgi);
+ $out = LookupPatron($cgi);
- print CGI::header('text/xml');
- print XMLout($out,
- noattr => 1,
- noescape => 1,
- nosort => 1,
+ print CGI::header('text/xml');
+ print XMLout($out,
+ noattr => 1,
+ noescape => 1,
+ nosort => 1,
xmldecl => '<?xml version="1.0" encoding="UTF-8" ?>',
- RootName => 'LookupPatron',
- SuppressEmpty => 1);
+ RootName => 'LookupPatron',
+ SuppressEmpty => 1);
=cut
=head2 GetAvailability
-Given a set of biblionumbers or itemnumbers, returns a list with
+Given a set of biblionumbers or itemnumbers, returns a list with
availability of the items associated with the identifiers.
Parameters:
=head3 id_type (Required)
-defines the type of record identifier being used in the request,
+defines the type of record identifier being used in the request,
possible values:
- bib
=head3 return_type (Optional)
-requests a particular level of detail in reporting availability,
+requests a particular level of detail in reporting availability,
possible values:
- bib
=head3 return_fmt (Optional)
-requests a particular format or set of formats in reporting
-availability
+requests a particular format or set of formats in reporting
+availability
=cut
=head2 GetRecords
-Given a list of biblionumbers, returns a list of record objects that
+Given a list of biblionumbers, returns a list of record objects that
contain bibliographic information, as well as associated holdings and item
-information. The caller may request a specific metadata schema for the
+information. The caller may request a specific metadata schema for the
record objects to be returned.
-This function behaves similarly to HarvestBibliographicRecords and
-HarvestExpandedRecords in Data Aggregation, but allows quick, real time
+This function behaves similarly to HarvestBibliographicRecords and
+HarvestExpandedRecords in Data Aggregation, but allows quick, real time
lookup by bibliographic identifier.
You can use OAI-PMH ListRecords instead of this service.
Parameters:
- id (Required)
- list of system record identifiers
+ list of system record identifiers
- id_type (Optional)
- Defines the metadata schema in which the records are returned,
- possible values:
- - MARCXML
+ Defines the metadata schema in which the records are returned,
+ possible values:
+ - MARCXML
=cut
}
my $embed_items = 1;
- my $record = GetMarcBiblio($biblionumber, $embed_items);
+ my $record = GetMarcBiblio({
+ biblionumber => $biblionumber,
+ embed_items => $embed_items });
if ($record) {
$biblioitem->{marcxml} = $record->as_xml_record();
}
# Get most of the needed data
my $biblioitemnumber = $biblioitem->{'biblioitemnumber'};
- my $reserves = GetReservesFromBiblionumber({ biblionumber => $biblionumber });
+ my $biblio = Koha::Biblios->find( $biblionumber );
+ my $holds = $biblio->current_holds->unblessed;
my $issues = GetBiblioIssues($biblionumber);
my $items = GetItemsByBiblioitemnumber($biblioitemnumber);
# Hashref building...
$biblioitem->{'items'}->{'item'} = $items;
- $biblioitem->{'reserves'}->{'reserve'} = $reserves;
+ $biblioitem->{'reserves'}->{'reserve'} = $holds;
$biblioitem->{'issues'}->{'issue'} = $issues;
push @records, $biblioitem;
=head2 GetAuthorityRecords
-Given a list of authority record identifiers, returns a list of record
-objects that contain the authority records. The function user may request
+Given a list of authority record identifiers, returns a list of record
+objects that contain the authority records. The function user may request
a specific metadata schema for the record objects.
Parameters:
Parameters:
- id (Required)
- an identifier used to look up the patron in Koha
+ an identifier used to look up the patron in Koha
- id_type (Optional)
- the type of the identifier, possible values:
- - cardnumber
- - firstname
- - userid
- - borrowernumber
+ the type of the identifier, possible values:
+ - cardnumber
+ - userid
+ - email
+ - borrowernumber
+ - firstname
+ - surname
=cut
sub LookupPatron {
my ($cgi) = @_;
- # Get the borrower...
- my $borrower = GetMember($cgi->param('id_type') => $cgi->param('id'));
- if ( not $borrower->{'borrowernumber'} ) {
+ my $id = $cgi->param('id');
+ if(!$id) {
return { message => 'PatronNotFound' };
}
- # Build the hashref
- my $patron->{'id'} = $borrower->{'borrowernumber'};
- return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
+ my $patrons;
+ my $passed_id_type = $cgi->param('id_type');
+ if($passed_id_type) {
+ $patrons = Koha::Patrons->search( { $passed_id_type => $id } );
+ } else {
+ foreach my $id_type ('cardnumber', 'userid', 'email', 'borrowernumber',
+ 'surname', 'firstname') {
+ $patrons = Koha::Patrons->search( { $id_type => $id } );
+ last if($patrons->count);
+ }
+ }
+ unless ( $patrons->count ) {
+ return { message => 'PatronNotFound' };
+ }
- # ...and return his ID
- return $patron;
+ return { id => $patrons->next->borrowernumber };
}
=head2 AuthenticatePatron
-Authenticates a user's login credentials and returns the identifier for
+Authenticates a user's login credentials and returns the identifier for
the patron.
Parameters:
my ($status, $cardnumber, $userid) = C4::Auth::checkpw( C4::Context->dbh, $username, $password );
if ( $status ) {
# Get the borrower
- my $borrower = GetMember( cardnumber => $cardnumber );
- my $patron->{'id'} = $borrower->{'borrowernumber'};
- return $patron;
+ my $patron = Koha::Patrons->find( { cardnumber => $cardnumber } );
+ return { id => $patron->borrowernumber };
}
else {
return { code => 'PatronNotFound' };
=head2 GetPatronInfo
-Returns specified information about the patron, based on options in the
-request. This function can optionally return patron's contact information,
+Returns specified information about the patron, based on options in the
+request. This function can optionally return patron's contact information,
fine information, hold request information, and loan information.
Parameters:
- patron_id (Required)
- the borrowernumber
+ the borrowernumber
- show_contact (Optional, default 1)
- whether or not to return patron's contact information in the response
+ whether or not to return patron's contact information in the response
- show_fines (Optional, default 0)
- whether or not to return fine information in the response
+ whether or not to return fine information in the response
- show_holds (Optional, default 0)
- whether or not to return hold request information in the response
+ whether or not to return hold request information in the response
- show_loans (Optional, default 0)
- whether or not to return loan information request information in the response
+ whether or not to return loan information request information in the response
=cut
# Get Member details
my $borrowernumber = $cgi->param('patron_id');
- my $borrower = GetMember( borrowernumber => $borrowernumber );
- return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
+ my $patron = Koha::Patrons->find( $borrowernumber );
+ return { code => 'PatronNotFound' } unless $patron;
# Cleaning the borrower hashref
- my $flags = C4::Members::patronflags( $borrower );
- $borrower->{'charges'} = $flags>{'CHARGES'}->{'amount'};
+ my $borrower = $patron->unblessed;
+ $borrower->{charges} = sprintf "%.02f", $patron->account->non_issues_charges; # FIXME Formatting should not be done here
my $library = Koha::Libraries->find( $borrower->{branchcode} );
$borrower->{'branchname'} = $library ? $library->branchname : '';
delete $borrower->{'userid'};
if ( $cgi->param('show_holds') && $cgi->param('show_holds') eq "1" ) {
# Get borrower's reserves
- my @reserves = GetReservesFromBorrowernumber( $borrowernumber, undef );
- foreach my $reserve (@reserves) {
+ my $holds = $patron->holds;
+ while ( my $hold = $holds->next ) {
+ my ( $item, $biblio, $biblioitem ) = ( {}, {}, {} );
# Get additional informations
- my $item = GetBiblioFromItemNumber( $reserve->{'itemnumber'}, undef );
- my $library = Koha::Libraries->find( $reserve->{branchcode} );
+ if ( $hold->itemnumber ) { # item level holds
+ $item = Koha::Items->find( $hold->itemnumber );
+ $biblio = $item->biblio;
+ $biblioitem = $biblio->biblioitem;
+
+ # Remove unwanted fields
+ $item = $item->unblessed;
+ delete $item->{more_subfields_xml};
+ $biblio = $biblio->unblessed;
+ $biblioitem = $biblioitem->unblessed;
+ }
+
+ # Add additional fields
+ my $unblessed_hold = $hold->unblessed;
+ $unblessed_hold->{item} = { %$item, %$biblio, %$biblioitem };
+ my $library = Koha::Libraries->find( $hold->branchcode );
my $branchname = $library ? $library->branchname : '';
+ $unblessed_hold->{branchname} = $branchname;
+ $biblio = Koha::Biblios->find( $hold->biblionumber ); # Should be $hold->get_biblio
+ $unblessed_hold->{title} = $biblio ? $biblio->title : ''; # Just in case, but should not be needed
- # Remove unwanted fields
- delete $item->{'more_subfields_xml'};
+ push @{ $borrower->{holds}{hold} }, $unblessed_hold;
- # Add additional fields
- $reserve->{'item'} = $item;
- $reserve->{'branchname'} = $branchname;
- $reserve->{'title'} = GetBiblio( $reserve->{'biblionumber'} )->{'title'};
}
- $borrower->{'holds'}->{'hold'} = \@reserves;
}
# Issues management
Parameters:
- patron_id (Required)
- the borrower ID
+ the borrower ID
=cut
# Get Member details
my $borrowernumber = $cgi->param('patron_id');
- my $borrower = GetMember( borrowernumber => $borrowernumber );
- return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
+ my $patron = Koha::Patrons->find( $borrowernumber );
+ return { code => 'PatronNotFound' } unless $patron;
# Return the results
return {
- type => $$borrower{categorycode},
+ type => $patron->categorycode,
status => 0, # TODO
- expiry => $$borrower{dateexpiry},
+ expiry => $patron->dateexpiry,
};
}
=head2 GetServices
-Returns information about the services available on a particular item for
+Returns information about the services available on a particular item for
a particular patron.
Parameters:
- patron_id (Required)
- a borrowernumber
+ a borrowernumber
- item_id (Required)
- an itemnumber
+ an itemnumber
=cut
# Get the member, or return an error code if not found
my $borrowernumber = $cgi->param('patron_id');
- my $borrower = GetMember( borrowernumber => $borrowernumber );
- return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
+ my $patron = Koha::Patrons->find( $borrowernumber );
+ return { code => 'PatronNotFound' } unless $patron;
+ my $borrower = $patron->unblessed;
# Get the item, or return an error code if not found
my $itemnumber = $cgi->param('item_id');
my $item = GetItem( $itemnumber );
}
# Reserve cancellation management
- my @reserves = GetReservesFromBorrowernumber( $borrowernumber, undef );
+ my $holds = $patron->holds;
my @reserveditems;
- foreach my $reserve (@reserves) {
- push @reserveditems, $reserve->{'itemnumber'};
+ while ( my $hold = $holds->next ) { # FIXME This could be improved
+ push @reserveditems, $hold->itemnumber;
}
if ( grep { $itemnumber eq $_ } @reserveditems ) {
push @availablefor, 'hold cancellation';
my $barcode = $item->{'barcode'} || '';
$barcode = barcodedecode($barcode) if ( $barcode && C4::Context->preference('itemBarcodeInputFilter') );
if ($barcode) {
- my ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower, $barcode );
+ my ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $patron, $barcode );
# TODO push @availablefor, 'loan';
}
Parameters:
- patron_id (Required)
- a borrowernumber
+ a borrowernumber
- item_id (Required)
- an itemnumber
+ an itemnumber
- desired_due_date (Required)
- the date the patron would like the item returned by
+ the date the patron would like the item returned by
=cut
# Get borrower infos or return an error code
my $borrowernumber = $cgi->param('patron_id');
- my $borrower = GetMember( borrowernumber => $borrowernumber );
- return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
+ my $patron = Koha::Patrons->find( $borrowernumber );
+ return { code => 'PatronNotFound' } unless $patron;
# Get the item, or return an error code
my $itemnumber = $cgi->param('item_id');
my @renewal = CanBookBeRenewed( $borrowernumber, $itemnumber );
if ( $renewal[0] ) { AddRenewal( $borrowernumber, $itemnumber ); }
- my $issue = GetItemIssue($itemnumber);
+ my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return; # FIXME should be handled
# Hashref building
my $out;
- $out->{'renewals'} = $issue->{'renewals'};
- $out->{date_due} = $issue->{date_due}->strftime('%Y-%m-%d %H:%S');
+ $out->{'renewals'} = $issue->renewals;
+ $out->{date_due} = dt_from_string($issue->date_due)->strftime('%Y-%m-%d %H:%S');
$out->{'success'} = $renewal[0];
$out->{'error'} = $renewal[1];
Parameters:
- patron_id (Required)
- a borrowernumber
+ a borrowernumber
- bib_id (Required)
- a biblionumber
+ a biblionumber
- request_location (Required)
- IP address where the end user request is being placed
+ IP address where the end user request is being placed
- pickup_location (Optional)
- a branch code indicating the location to which to deliver the item for pickup
+ a branch code indicating the location to which to deliver the item for pickup
- needed_before_date (Optional)
- date after which hold request is no longer needed
+ date after which hold request is no longer needed
- pickup_expiry_date (Optional)
- date after which item returned to shelf if item is not picked up
+ date after which item returned to shelf if item is not picked up
=cut
# Get the borrower or return an error code
my $borrowernumber = $cgi->param('patron_id');
- my $borrower = GetMember( borrowernumber => $borrowernumber );
- return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
+ my $patron = Koha::Patrons->find( $borrowernumber );
+ return { code => 'PatronNotFound' } unless $patron;
# Get the biblio record, or return an error code
my $biblionumber = $cgi->param('bib_id');
- my $biblio = GetBiblio( $biblionumber );
- return { code => 'RecordNotFound' } unless $$biblio{biblionumber};
-
- my $title = $$biblio{title};
+ my $biblio = Koha::Biblios->find( $biblionumber );
+ return { code => 'RecordNotFound' } unless $biblio;
+
+ my $title = $biblio ? $biblio->title : '';
# Check if the biblio can be reserved
return { code => 'NotHoldable' } unless CanBookBeReserved( $borrowernumber, $biblionumber ) eq 'OK';
$branch = $cgi->param('pickup_location');
return { code => 'LocationNotFound' } unless Koha::Libraries->find($branch);
} else { # if the request provide no branch, use the borrower's branch
- $branch = $$borrower{branchcode};
+ $branch = $patron->branchcode;
}
# Add the reserve
=head2 HoldItem
-Creates, for a borrower, an item-level hold request on a specific item of
+Creates, for a borrower, an item-level hold request on a specific item of
a bibliographic record in Koha.
Parameters:
- patron_id (Required)
- a borrowernumber
+ a borrowernumber
- bib_id (Required)
- a biblionumber
+ a biblionumber
- item_id (Required)
- an itemnumber
+ an itemnumber
- pickup_location (Optional)
- a branch code indicating the location to which to deliver the item for pickup
+ a branch code indicating the location to which to deliver the item for pickup
- needed_before_date (Optional)
- date after which hold request is no longer needed
+ date after which hold request is no longer needed
- pickup_expiry_date (Optional)
- date after which item returned to shelf if item is not picked up
+ date after which item returned to shelf if item is not picked up
=cut
# Get the borrower or return an error code
my $borrowernumber = $cgi->param('patron_id');
- my $borrower = GetMember( borrowernumber => $borrowernumber );
- return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
+ my $patron = Koha::Patrons->find( $borrowernumber );
+ return { code => 'PatronNotFound' } unless $patron;
# Get the biblio or return an error code
my $biblionumber = $cgi->param('bib_id');
- my $biblio = GetBiblio($biblionumber);
- return { code => 'RecordNotFound' } unless $$biblio{biblionumber};
+ my $biblio = Koha::Biblios->find( $biblionumber );
+ return { code => 'RecordNotFound' } unless $biblio;
- my $title = $$biblio{title};
+ my $title = $biblio ? $biblio->title : '';
# Get the item or return an error code
my $itemnumber = $cgi->param('item_id');
return { code => 'RecordNotFound' } unless $$item{itemnumber};
# If the biblio does not match the item, return an error code
- return { code => 'RecordNotFound' } if $$item{biblionumber} ne $$biblio{biblionumber};
+ return { code => 'RecordNotFound' } if $$item{biblionumber} ne $biblio->biblionumber;
# Check for item disponibility
my $canitembereserved = C4::Reserves::CanItemBeReserved( $borrowernumber, $itemnumber );
$branch = $cgi->param('pickup_location');
return { code => 'LocationNotFound' } unless Koha::Libraries->find($branch);
} else { # if the request provide no branch, use the borrower's branch
- $branch = $$borrower{branchcode};
+ $branch = $patron->branchcode;
}
# Add the reserve
# Get the borrower or return an error code
my $borrowernumber = $cgi->param('patron_id');
- my $borrower = GetMember( borrowernumber => $borrowernumber );
- return { code => 'PatronNotFound' } unless $$borrower{borrowernumber};
+ my $patron = Koha::Patrons->find( $borrowernumber );
+ return { code => 'PatronNotFound' } unless $patron;
# Get the reserve or return an error code
my $reserve_id = $cgi->param('item_id');
- my $reserve = C4::Reserves::GetReserve($reserve_id);
- return { code => 'RecordNotFound' } unless $reserve;
- return { code => 'RecordNotFound' } unless ($reserve->{borrowernumber} == $borrowernumber);
+ my $hold = Koha::Holds->find( $reserve_id );
+ return { code => 'RecordNotFound' } unless $hold;
+ return { code => 'RecordNotFound' } unless ($hold->borrowernumber == $borrowernumber);
- C4::Reserves::CancelReserve({reserve_id => $reserve_id});
+ $hold->cancel;
return { code => 'Canceled' };
}
projects / koha-ffzg.git / blobdiff