3 # Copyright ByWater Solutions 2014
4 # Copyright 2017 Koha Development team
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use List::MoreUtils qw( any );
26 use C4::Letters qw( GetPreparedLetter EnqueueLetter );
27 use C4::Log qw( logaction );
29 use Koha::AuthorisedValues;
30 use Koha::DateUtils qw( dt_from_string );
39 use Koha::Exceptions::Hold;
41 use base qw(Koha::Object);
45 Koha::Hold - Koha Hold object class
55 returns the number of days since a hold was placed, optionally
58 my $age = $hold->age( $use_calendar );
63 my ( $self, $use_calendar ) = @_;
65 my $today = dt_from_string;
68 if ( $use_calendar ) {
69 my $calendar = Koha::Calendar->new( branchcode => $self->branchcode );
70 $age = $calendar->days_between( dt_from_string( $self->reservedate ), $today );
73 $age = $today->delta_days( dt_from_string( $self->reservedate ) );
76 $age = $age->in_units( 'days' );
83 my $hold = $hold->suspend_hold( $suspend_until_dt );
88 my ( $self, $dt ) = @_;
90 my $date = $dt ? $dt->clone()->truncate( to => 'day' )->datetime : undef;
92 if ( $self->is_found ) { # We can't suspend found holds
93 if ( $self->is_waiting ) {
94 Koha::Exceptions::Hold::CannotSuspendFound->throw( status => 'W' );
96 elsif ( $self->is_in_transit ) {
97 Koha::Exceptions::Hold::CannotSuspendFound->throw( status => 'T' );
99 elsif ( $self->is_in_processing ) {
100 Koha::Exceptions::Hold::CannotSuspendFound->throw( status => 'P' );
103 Koha::Exceptions::Hold::CannotSuspendFound->throw(
104 'Unhandled data exception on found hold (id='
113 $self->suspend_until($date);
120 payload => { hold => $self->get_from_storage }
124 logaction( 'HOLDS', 'SUSPEND', $self->reserve_id, $self )
125 if C4::Context->preference('HoldsLog');
132 my $hold = $hold->resume();
140 $self->suspend_until( undef );
148 payload => { hold => $self->get_from_storage }
152 logaction( 'HOLDS', 'RESUME', $self->reserve_id, $self )
153 if C4::Context->preference('HoldsLog');
167 my $deleted = $self->SUPER::delete($self);
169 logaction( 'HOLDS', 'DELETE', $self->reserve_id, $self )
170 if C4::Context->preference('HoldsLog');
194 my ( $self, $desk_id ) = @_;
198 my $today = dt_from_string();
202 ( !$self->waitingdate ? ( waitingdate => $today->ymd ) : () ),
206 my $max_pickup_delay = C4::Context->preference("ReservesMaxPickUpDelay");
207 my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
209 my $new_expiration_date = $today->clone->add(days => $max_pickup_delay);
211 if ( C4::Context->preference("ExcludeHolidaysFromMaxPickUpDelay") ) {
212 my $itemtype = $self->item ? $self->item->effective_itemtype : $self->biblio->itemtype;
213 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
215 categorycode => $self->borrower->categorycode,
216 itemtype => $itemtype,
217 branchcode => $self->branchcode,
220 my $calendar = Koha::Calendar->new( branchcode => $self->branchcode, days_mode => $daysmode );
222 $new_expiration_date = $calendar->days_forward( dt_from_string(), $max_pickup_delay );
225 # If patron's requested expiration date is prior to the
226 # calculated one, we keep the patron's one.
227 if ( $self->patron_expiration_date ) {
228 my $requested_expiration = dt_from_string( $self->patron_expiration_date );
231 $requested_expiration
232 ? DateTime->compare( $requested_expiration, $new_expiration_date )
235 $new_expiration_date =
236 $cmp == -1 ? $requested_expiration : $new_expiration_date;
239 $values->{expirationdate} = $new_expiration_date->ymd;
241 $self->set($values)->store();
246 =head3 is_pickup_location_valid
248 if ($hold->is_pickup_location_valid({ library_id => $library->id }) ) {
252 Returns a I<boolean> representing if the passed pickup location is valid for the hold.
253 It throws a I<Koha::Exceptions::_MissingParameter> if the library_id parameter is not
258 sub is_pickup_location_valid {
259 my ( $self, $params ) = @_;
261 Koha::Exceptions::MissingParameter->throw('The library_id parameter is mandatory')
262 unless $params->{library_id};
264 my $pickup_locations;
266 if ( $self->itemnumber ) { # item-level
267 $pickup_locations = $self->item->pickup_locations({ patron => $self->patron });
269 else { # biblio-level
270 $pickup_locations = $self->biblio->pickup_locations({ patron => $self->patron });
273 return any { $_->branchcode eq $params->{library_id} } $pickup_locations->as_list;
276 =head3 set_pickup_location
278 $hold->set_pickup_location(
280 library_id => $library->id,
285 Updates the hold pickup location. It throws a I<Koha::Exceptions::Hold::InvalidPickupLocation> if
286 the passed pickup location is not valid.
288 Note: It is up to the caller to verify if I<AllowHoldPolicyOverride> is set when setting the
293 sub set_pickup_location {
294 my ( $self, $params ) = @_;
296 Koha::Exceptions::MissingParameter->throw('The library_id parameter is mandatory')
297 unless $params->{library_id};
301 || $self->is_pickup_location_valid(
302 { library_id => $params->{library_id} }
306 # all good, set the new pickup location
307 $self->branchcode( $params->{library_id} )->store;
310 Koha::Exceptions::Hold::InvalidPickupLocation->throw;
316 =head3 set_processing
318 $hold->set_processing;
320 Mark the hold as in processing.
336 Returns true if hold is waiting, in transit or in processing
343 return 0 unless $self->found();
344 return 1 if $self->found() eq 'W';
345 return 1 if $self->found() eq 'T';
346 return 1 if $self->found() eq 'P';
351 Returns true if hold is a waiting hold
358 my $found = $self->found;
359 return $found && $found eq 'W';
364 Returns true if hold is a in_transit hold
371 return 0 unless $self->found();
372 return $self->found() eq 'T';
375 =head3 is_in_processing
377 Returns true if hold is a in_processing hold
381 sub is_in_processing {
384 return 0 unless $self->found();
385 return $self->found() eq 'P';
388 =head3 is_cancelable_from_opac
390 Returns true if hold is a cancelable hold
392 Holds may be only canceled if they are not found.
394 This is used from the OPAC.
398 sub is_cancelable_from_opac {
401 return 1 unless $self->is_found();
402 return 0; # if ->is_in_transit or if ->is_waiting or ->is_in_processing
405 =head3 is_at_destination
407 Returns true if hold is waiting
408 and the hold's pickup branch matches
409 the hold item's holding branch
413 sub is_at_destination {
416 return $self->is_waiting() && ( $self->branchcode() eq $self->item()->holdingbranch() );
421 Returns the related Koha::Biblio object for this hold
428 $self->{_biblio} ||= Koha::Biblios->find( $self->biblionumber() );
430 return $self->{_biblio};
435 Returns the related Koha::Patron object for this hold
442 my $patron_rs = $self->_result->patron;
443 return Koha::Patron->_new_from_dbic($patron_rs);
448 Returns the related Koha::Item object for this Hold
455 $self->{_item} ||= Koha::Items->find( $self->itemnumber() );
457 return $self->{_item};
462 Returns the related Koha::Library object for this Hold
469 $self->{_branch} ||= Koha::Libraries->find( $self->branchcode() );
471 return $self->{_branch};
476 Returns the related Koha::Desk object for this Hold
482 my $desk_rs = $self->_result->desk;
483 return unless $desk_rs;
484 return Koha::Desk->_new_from_dbic($desk_rs);
489 Returns the related Koha::Patron object for this Hold
493 # FIXME Should be renamed with ->patron
497 $self->{_borrower} ||= Koha::Patrons->find( $self->borrowernumber() );
499 return $self->{_borrower};
504 my $bool = $hold->is_suspended();
511 return $self->suspend();
517 my $cancel_hold = $hold->cancel(
519 [ charge_cancel_fee => 1||0, ]
520 [ cancellation_reason => $cancellation_reason, ]
525 - The hold will be moved to the old_reserves table with a priority=0
526 - The priority of other holds will be updated
527 - The patron will be charge (see ExpireReservesMaxPickUpDelayCharge) if the charge_cancel_fee parameter is set
528 - The canceled hold will have the cancellation reason added to old_reserves.cancellation_reason if one is passed in
529 - a CANCEL HOLDS log will be done if the pref HoldsLog is on
534 my ( $self, $params ) = @_;
535 $self->_result->result_source->schema->txn_do(
537 my $patron = $self->patron;
539 $self->cancellationdate( dt_from_string->strftime( '%Y-%m-%d %H:%M:%S' ) );
541 $self->cancellation_reason( $params->{cancellation_reason} );
544 if ( $params->{cancellation_reason} ) {
545 my $letter = C4::Letters::GetPreparedLetter(
546 module => 'reserves',
547 letter_code => 'HOLD_CANCELLATION',
548 message_transport_type => 'email',
549 branchcode => $self->borrower->branchcode,
550 lang => $self->borrower->lang,
552 branches => $self->borrower->branchcode,
553 borrowers => $self->borrowernumber,
554 items => $self->itemnumber,
555 biblio => $self->biblionumber,
556 biblioitems => $self->biblionumber,
557 reserves => $self->unblessed,
562 C4::Letters::EnqueueLetter(
565 borrowernumber => $self->borrowernumber,
566 message_transport_type => 'email',
572 my $old_me = $self->_move_to_old;
578 payload => { hold => $old_me->get_from_storage }
582 # anonymize if required
584 if $patron->privacy == 2;
586 $self->SUPER::delete(); # Do not add a DELETE log
588 # now fix the priority on the others....
589 C4::Reserves::_FixPriority({ biblionumber => $self->biblionumber });
591 # and, if desired, charge a cancel fee
592 my $charge = C4::Context->preference("ExpireReservesMaxPickUpDelayCharge");
593 if ( $charge && $params->{'charge_cancel_fee'} ) {
595 Koha::Account->new( { patron_id => $self->borrowernumber } );
599 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
600 interface => C4::Context->interface,
601 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
602 type => 'RESERVE_EXPIRED',
603 item_id => $self->itemnumber
608 C4::Log::logaction( 'HOLDS', 'CANCEL', $self->reserve_id, $self )
609 if C4::Context->preference('HoldsLog');
619 This method marks the hold as filled. It effectively moves it to old_reserves.
625 $self->_result->result_source->schema->txn_do(
627 my $patron = $self->patron;
636 my $old_me = $self->_move_to_old;
642 payload => { hold => $old_me->get_from_storage }
646 # anonymize if required
648 if $patron->privacy == 2;
650 $self->SUPER::delete(); # Do not add a DELETE log
652 # now fix the priority on the others....
653 C4::Reserves::_FixPriority({ biblionumber => $self->biblionumber });
655 if ( C4::Context->preference('HoldFeeMode') eq 'any_time_is_collected' ) {
656 my $fee = $patron->category->reservefee // 0;
658 $patron->account->add_debit(
661 description => $self->biblio->title,
662 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
663 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
664 interface => C4::Context->interface,
666 item_id => $self->itemnumber
672 C4::Log::logaction( 'HOLDS', 'FILL', $self->id, $self )
673 if C4::Context->preference('HoldsLog');
681 Override base store method to set default
682 expirationdate for holds.
689 if ( !$self->in_storage ) {
690 if ( ! $self->expirationdate && $self->patron_expiration_date ) {
691 $self->expirationdate($self->patron_expiration_date);
695 C4::Context->preference('DefaultHoldExpirationdate')
696 && !$self->expirationdate
699 $self->_set_default_expirationdate;
704 my %updated_columns = $self->_result->get_dirty_columns;
705 return $self->SUPER::store unless %updated_columns;
707 if ( exists $updated_columns{reservedate} ) {
709 C4::Context->preference('DefaultHoldExpirationdate')
710 && ! exists $updated_columns{expirationdate}
713 $self->_set_default_expirationdate;
718 $self = $self->SUPER::store;
721 sub _set_default_expirationdate {
724 my $period = C4::Context->preference('DefaultHoldExpirationdatePeriod') || 0;
726 C4::Context->preference('DefaultHoldExpirationdateUnitOfTime') || 'days';
728 $self->expirationdate(
729 dt_from_string( $self->reservedate )->add( $timeunit => $period ) );
734 my $is_moved = $hold->_move_to_old;
736 Move a hold to the old_reserve table following the same pattern as Koha::Patron->move_to_deleted
742 my $hold_infos = $self->unblessed;
743 return Koha::Old::Hold->new( $hold_infos )->store;
746 =head3 to_api_mapping
748 This method returns the mapping for representing a Koha::Hold object
755 reserve_id => 'hold_id',
756 borrowernumber => 'patron_id',
757 reservedate => 'hold_date',
758 biblionumber => 'biblio_id',
759 branchcode => 'pickup_library_id',
760 notificationdate => undef,
761 reminderdate => undef,
762 cancellationdate => 'cancellation_date',
763 reservenotes => 'notes',
765 itemnumber => 'item_id',
766 waitingdate => 'waiting_date',
767 expirationdate => 'expiration_date',
768 patron_expiration_date => undef,
769 lowestPriority => 'lowest_priority',
770 suspend => 'suspended',
771 suspend_until => 'suspended_until',
772 itemtype => 'item_type',
773 item_level_hold => 'item_level',
777 =head2 Internal methods
789 Kyle M Hall <kyle@bywatersolutions.com>
790 Jonathan Druart <jonathan.druart@bugs.koha-community.org>
791 Martin Renvoize <martin.renvoize@ptfs-europe.com>