package Koha::Hold;
# Copyright ByWater Solutions 2014
+# Copyright 2017 Koha Development team
#
# This file is part of Koha.
#
-# Koha is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
#
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
#
-# You should have received a copy of the GNU General Public License along
-# with Koha; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
use Modern::Perl;
use Carp;
+use Data::Dumper qw(Dumper);
use C4::Context qw(preference);
+use C4::Log;
-use Koha::DateUtils qw(dt_from_string);
-use Koha::Borrowers;
+use Koha::DateUtils qw(dt_from_string output_pref);
+use Koha::Patrons;
use Koha::Biblios;
use Koha::Items;
use Koha::Libraries;
+use Koha::Old::Holds;
+use Koha::Calendar;
+
+use Koha::Exceptions::Hold;
use base qw(Koha::Object);
=cut
-=head3 waiting_expires_on
+=head3 age
+
+returns the number of days since a hold was placed, optionally
+using the calendar
-Returns a DateTime for the date a waiting holds expires on.
-Returns undef if the system peference ReservesMaxPickUpDelay is not set.
-Returns undef if the hold is not waiting ( found = 'W' ).
+my $age = $hold->age( $use_calendar );
=cut
-sub waiting_expires_on {
- my ($self) = @_;
+sub age {
+ my ( $self, $use_calendar ) = @_;
- my $found = $self->found;
- return unless $found && $found eq 'W';
+ my $today = dt_from_string;
+ my $age;
+
+ if ( $use_calendar ) {
+ my $calendar = Koha::Calendar->new( branchcode => $self->branchcode );
+ $age = $calendar->days_between( dt_from_string( $self->reservedate ), $today );
+ }
+ else {
+ $age = $today->delta_days( dt_from_string( $self->reservedate ) );
+ }
+
+ $age = $age->in_units( 'days' );
+
+ return $age;
+}
+
+=head3 suspend_hold
+
+my $hold = $hold->suspend_hold( $suspend_until_dt );
+
+=cut
+
+sub suspend_hold {
+ my ( $self, $dt ) = @_;
+
+ my $date = $dt ? $dt->clone()->truncate( to => 'day' )->datetime : undef;
+
+ if ( $self->is_found ) { # We can't suspend found holds
+ if ( $self->is_waiting ) {
+ Koha::Exceptions::Hold::CannotSuspendFound->throw( status => 'W' );
+ }
+ elsif ( $self->is_in_transit ) {
+ Koha::Exceptions::Hold::CannotSuspendFound->throw( status => 'T' );
+ }
+ else {
+ Koha::Exceptions::Hold::CannotSuspendFound->throw(
+ 'Unhandled data exception on found hold (id='
+ . $self->id
+ . ', found='
+ . $self->found
+ . ')' );
+ }
+ }
+
+ $self->suspend(1);
+ $self->suspend_until($date);
+ $self->store();
+
+ logaction( 'HOLDS', 'SUSPEND', $self->reserve_id, Dumper( $self->unblessed ) )
+ if C4::Context->preference('HoldsLog');
+
+ return $self;
+}
+
+=head3 resume
+
+my $hold = $hold->resume();
+
+=cut
+
+sub resume {
+ my ( $self ) = @_;
- my $ReservesMaxPickUpDelay = C4::Context->preference('ReservesMaxPickUpDelay');
- return unless $ReservesMaxPickUpDelay;
+ $self->suspend(0);
+ $self->suspend_until( undef );
- my $dt = dt_from_string( $self->waitingdate() );
+ $self->store();
- $dt->add( days => $ReservesMaxPickUpDelay );
+ logaction( 'HOLDS', 'RESUME', $self->reserve_id, Dumper($self->unblessed) )
+ if C4::Context->preference('HoldsLog');
- return $dt;
+ return $self;
+}
+
+=head3 delete
+
+$hold->delete();
+
+=cut
+
+sub delete {
+ my ( $self ) = @_;
+
+ my $deleted = $self->SUPER::delete($self);
+
+ logaction( 'HOLDS', 'DELETE', $self->reserve_id, Dumper($self->unblessed) )
+ if C4::Context->preference('HoldsLog');
+
+ return $deleted;
+}
+
+=head3 set_waiting
+
+=cut
+
+sub set_waiting {
+ my ( $self, $transferToDo ) = @_;
+
+ $self->priority(0);
+
+ if ($transferToDo) {
+ $self->found('T')->store();
+ return $self;
+ }
+
+ my $today = dt_from_string();
+ my $values = {
+ found => 'W',
+ waitingdate => $today->ymd,
+ };
+
+ my $requested_expiration;
+ if ($self->expirationdate) {
+ $requested_expiration = dt_from_string($self->expirationdate);
+ }
+
+ my $max_pickup_delay = C4::Context->preference("ReservesMaxPickUpDelay");
+ my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
+
+ my $expirationdate = $today->clone;
+ $expirationdate->add(days => $max_pickup_delay);
+
+ if ( C4::Context->preference("ExcludeHolidaysFromMaxPickUpDelay") ) {
+ my $itemtype = $self->item ? $self->item->effective_itemtype : $self->biblio->itemtype;
+ my $useDaysMode_value = Koha::CirculationRules->get_useDaysMode_effective_value(
+ {
+ categorycode => $self->borrower->categorycode,
+ itemtype => $itemtype,
+ branchcode => $self->branchcode,
+ }
+ );
+ my $calendar = Koha::Calendar->new( branchcode => $self->branchcode, days_mode => $useDaysMode_value );
+
+ $expirationdate = $calendar->days_forward( dt_from_string(), $max_pickup_delay );
+ }
+
+ # If patron's requested expiration date is prior to the
+ # calculated one, we keep the patron's one.
+ my $cmp = $requested_expiration ? DateTime->compare($requested_expiration, $expirationdate) : 0;
+ $values->{expirationdate} = $cmp == -1 ? $requested_expiration->ymd : $expirationdate->ymd;
+
+ $self->set($values)->store();
+
+ return $self;
}
=head3 is_found
return $self->found() eq 'T';
}
-=head3 is_cancelable
+=head3 is_cancelable_from_opac
Returns true if hold is a cancelable hold
-Holds may be canceled if they not found, or
-are found and waiting. A hold found but in
-transit cannot be canceled.
+Holds may be only canceled if they are not found.
+
+This is used from the OPAC.
=cut
-sub is_cancelable {
+sub is_cancelable_from_opac {
my ($self) = @_;
return 1 unless $self->is_found();
- return 0 if $self->is_in_transit();
- return 1 if $self->is_waiting();
- return 0;
+ return 0; # if ->is_in_transit or if ->is_waiting
}
=head3 is_at_destination
=head3 borrower
-Returns the related Koha::Borrower object for this Hold
+Returns the related Koha::Patron object for this Hold
=cut
+# FIXME Should be renamed with ->patron
sub borrower {
my ($self) = @_;
- $self->{_borrower} ||= Koha::Borrowers->find( $self->borrowernumber() );
+ $self->{_borrower} ||= Koha::Patrons->find( $self->borrowernumber() );
return $self->{_borrower};
}
-=head3 type
+=head3 is_suspended
+
+my $bool = $hold->is_suspended();
+
+=cut
+
+sub is_suspended {
+ my ( $self ) = @_;
+
+ return $self->suspend();
+}
+
+
+=head3 cancel
+
+my $cancel_hold = $hold->cancel();
+
+Cancel a hold:
+- The hold will be moved to the old_reserves table with a priority=0
+- The priority of other holds will be updated
+- The patron will be charge (see ExpireReservesMaxPickUpDelayCharge) if the charge_cancel_fee parameter is set
+- a CANCEL HOLDS log will be done if the pref HoldsLog is on
+
+=cut
+
+sub cancel {
+ my ( $self, $params ) = @_;
+ $self->_result->result_source->schema->txn_do(
+ sub {
+ $self->cancellationdate( dt_from_string->strftime( '%Y-%m-%d %H:%M:%S' ) );
+ $self->priority(0);
+ $self->_move_to_old;
+ $self->SUPER::delete(); # Do not add a DELETE log
+
+ # now fix the priority on the others....
+ C4::Reserves::_FixPriority({ biblionumber => $self->biblionumber });
+
+ # and, if desired, charge a cancel fee
+ my $charge = C4::Context->preference("ExpireReservesMaxPickUpDelayCharge");
+ if ( $charge && $params->{'charge_cancel_fee'} ) {
+ my $account =
+ Koha::Account->new( { patron_id => $self->borrowernumber } );
+ $account->add_debit(
+ {
+ amount => $charge,
+ user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
+ interface => C4::Context->interface,
+ library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
+ type => 'RESERVE_EXPIRED',
+ item_id => $self->itemnumber
+ }
+ );
+ }
+
+ C4::Log::logaction( 'HOLDS', 'CANCEL', $self->reserve_id, Dumper($self->unblessed) )
+ if C4::Context->preference('HoldsLog');
+ }
+ );
+ return $self;
+}
+
+=head3 _move_to_old
+
+my $is_moved = $hold->_move_to_old;
+
+Move a hold to the old_reserve table following the same pattern as Koha::Patron->move_to_deleted
+
+=cut
+
+sub _move_to_old {
+ my ($self) = @_;
+ my $hold_infos = $self->unblessed;
+ return Koha::Old::Hold->new( $hold_infos )->store;
+}
+
+=head3 to_api_mapping
+
+This method returns the mapping for representing a Koha::Hold object
+on the API.
+
+=cut
+
+sub to_api_mapping {
+ return {
+ reserve_id => 'hold_id',
+ borrowernumber => 'patron_id',
+ reservedate => 'hold_date',
+ biblionumber => 'biblio_id',
+ branchcode => 'pickup_library_id',
+ notificationdate => undef,
+ reminderdate => undef,
+ cancellationdate => 'cancellation_date',
+ reservenotes => 'notes',
+ found => 'status',
+ itemnumber => 'item_id',
+ waitingdate => 'waiting_date',
+ expirationdate => 'expiration_date',
+ lowestPriority => 'lowest_priority',
+ suspend => 'suspended',
+ suspend_until => 'suspended_until',
+ itemtype => 'item_type',
+ item_level_hold => 'item_level',
+ };
+}
+
+=head2 Internal methods
+
+=head3 _type
=cut
-sub type {
+sub _type {
return 'Reserve';
}
-=head1 AUTHOR
+=head1 AUTHORS
Kyle M Hall <kyle@bywatersolutions.com>
+Jonathan Druart <jonathan.druart@bugs.koha-community.org>
+Martin Renvoize <martin.renvoize@ptfs-europe.com>
=cut
projects / srvgit / blobdiff