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 );
38 use Koha::Exceptions::Hold;
40 use base qw(Koha::Object);
44 Koha::Hold - Koha Hold object class
54 returns the number of days since a hold was placed, optionally
57 my $age = $hold->age( $use_calendar );
62 my ( $self, $use_calendar ) = @_;
64 my $today = dt_from_string;
67 if ( $use_calendar ) {
68 my $calendar = Koha::Calendar->new( branchcode => $self->branchcode );
69 $age = $calendar->days_between( dt_from_string( $self->reservedate ), $today );
72 $age = $today->delta_days( dt_from_string( $self->reservedate ) );
75 $age = $age->in_units( 'days' );
82 my $hold = $hold->suspend_hold( $suspend_until_dt );
87 my ( $self, $dt ) = @_;
89 my $date = $dt ? $dt->clone()->truncate( to => 'day' )->datetime : undef;
91 if ( $self->is_found ) { # We can't suspend found holds
92 if ( $self->is_waiting ) {
93 Koha::Exceptions::Hold::CannotSuspendFound->throw( status => 'W' );
95 elsif ( $self->is_in_transit ) {
96 Koha::Exceptions::Hold::CannotSuspendFound->throw( status => 'T' );
98 elsif ( $self->is_in_processing ) {
99 Koha::Exceptions::Hold::CannotSuspendFound->throw( status => 'P' );
102 Koha::Exceptions::Hold::CannotSuspendFound->throw(
103 'Unhandled data exception on found hold (id='
112 $self->suspend_until($date);
115 logaction( 'HOLDS', 'SUSPEND', $self->reserve_id, $self )
116 if C4::Context->preference('HoldsLog');
123 my $hold = $hold->resume();
131 $self->suspend_until( undef );
135 logaction( 'HOLDS', 'RESUME', $self->reserve_id, $self )
136 if C4::Context->preference('HoldsLog');
150 my $deleted = $self->SUPER::delete($self);
152 logaction( 'HOLDS', 'DELETE', $self->reserve_id, $self )
153 if C4::Context->preference('HoldsLog');
177 my ( $self, $desk_id ) = @_;
181 my $today = dt_from_string();
185 ( !$self->waitingdate ? ( waitingdate => $today->ymd ) : () ),
189 my $max_pickup_delay = C4::Context->preference("ReservesMaxPickUpDelay");
190 my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
192 my $new_expiration_date = $today->clone->add(days => $max_pickup_delay);
194 if ( C4::Context->preference("ExcludeHolidaysFromMaxPickUpDelay") ) {
195 my $itemtype = $self->item ? $self->item->effective_itemtype : $self->biblio->itemtype;
196 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
198 categorycode => $self->borrower->categorycode,
199 itemtype => $itemtype,
200 branchcode => $self->branchcode,
203 my $calendar = Koha::Calendar->new( branchcode => $self->branchcode, days_mode => $daysmode );
205 $new_expiration_date = $calendar->days_forward( dt_from_string(), $max_pickup_delay );
208 # If patron's requested expiration date is prior to the
209 # calculated one, we keep the patron's one.
210 if ( $self->patron_expiration_date ) {
211 my $requested_expiration = dt_from_string( $self->patron_expiration_date );
214 $requested_expiration
215 ? DateTime->compare( $requested_expiration, $new_expiration_date )
218 $new_expiration_date =
219 $cmp == -1 ? $requested_expiration : $new_expiration_date;
222 $values->{expirationdate} = $new_expiration_date->ymd;
224 $self->set($values)->store();
229 =head3 is_pickup_location_valid
231 if ($hold->is_pickup_location_valid({ library_id => $library->id }) ) {
235 Returns a I<boolean> representing if the passed pickup location is valid for the hold.
236 It throws a I<Koha::Exceptions::_MissingParameter> if the library_id parameter is not
241 sub is_pickup_location_valid {
242 my ( $self, $params ) = @_;
244 Koha::Exceptions::MissingParameter->throw('The library_id parameter is mandatory')
245 unless $params->{library_id};
247 my $pickup_locations;
249 if ( $self->itemnumber ) { # item-level
250 $pickup_locations = $self->item->pickup_locations({ patron => $self->patron });
252 else { # biblio-level
253 $pickup_locations = $self->biblio->pickup_locations({ patron => $self->patron });
256 return any { $_->branchcode eq $params->{library_id} } $pickup_locations->as_list;
259 =head3 set_pickup_location
261 $hold->set_pickup_location(
263 library_id => $library->id,
268 Updates the hold pickup location. It throws a I<Koha::Exceptions::Hold::InvalidPickupLocation> if
269 the passed pickup location is not valid.
271 Note: It is up to the caller to verify if I<AllowHoldPolicyOverride> is set when setting the
276 sub set_pickup_location {
277 my ( $self, $params ) = @_;
279 Koha::Exceptions::MissingParameter->throw('The library_id parameter is mandatory')
280 unless $params->{library_id};
284 || $self->is_pickup_location_valid(
285 { library_id => $params->{library_id} }
289 # all good, set the new pickup location
290 $self->branchcode( $params->{library_id} )->store;
293 Koha::Exceptions::Hold::InvalidPickupLocation->throw;
299 =head3 set_processing
301 $hold->set_processing;
303 Mark the hold as in processing.
319 Returns true if hold is waiting, in transit or in processing
326 return 0 unless $self->found();
327 return 1 if $self->found() eq 'W';
328 return 1 if $self->found() eq 'T';
329 return 1 if $self->found() eq 'P';
334 Returns true if hold is a waiting hold
341 my $found = $self->found;
342 return $found && $found eq 'W';
347 Returns true if hold is a in_transit hold
354 return 0 unless $self->found();
355 return $self->found() eq 'T';
358 =head3 is_in_processing
360 Returns true if hold is a in_processing hold
364 sub is_in_processing {
367 return 0 unless $self->found();
368 return $self->found() eq 'P';
371 =head3 is_cancelable_from_opac
373 Returns true if hold is a cancelable hold
375 Holds may be only canceled if they are not found.
377 This is used from the OPAC.
381 sub is_cancelable_from_opac {
384 return 1 unless $self->is_found();
385 return 0; # if ->is_in_transit or if ->is_waiting or ->is_in_processing
388 =head3 is_at_destination
390 Returns true if hold is waiting
391 and the hold's pickup branch matches
392 the hold item's holding branch
396 sub is_at_destination {
399 return $self->is_waiting() && ( $self->branchcode() eq $self->item()->holdingbranch() );
404 Returns the related Koha::Biblio object for this hold
411 $self->{_biblio} ||= Koha::Biblios->find( $self->biblionumber() );
413 return $self->{_biblio};
418 Returns the related Koha::Patron object for this hold
425 my $patron_rs = $self->_result->patron;
426 return Koha::Patron->_new_from_dbic($patron_rs);
431 Returns the related Koha::Item object for this Hold
438 $self->{_item} ||= Koha::Items->find( $self->itemnumber() );
440 return $self->{_item};
445 Returns the related Koha::Library object for this Hold
452 $self->{_branch} ||= Koha::Libraries->find( $self->branchcode() );
454 return $self->{_branch};
459 Returns the related Koha::Desk object for this Hold
465 my $desk_rs = $self->_result->desk;
466 return unless $desk_rs;
467 return Koha::Desk->_new_from_dbic($desk_rs);
472 Returns the related Koha::Patron object for this Hold
476 # FIXME Should be renamed with ->patron
480 $self->{_borrower} ||= Koha::Patrons->find( $self->borrowernumber() );
482 return $self->{_borrower};
487 my $bool = $hold->is_suspended();
494 return $self->suspend();
500 my $cancel_hold = $hold->cancel(
502 [ charge_cancel_fee => 1||0, ]
503 [ cancellation_reason => $cancellation_reason, ]
508 - The hold will be moved to the old_reserves table with a priority=0
509 - The priority of other holds will be updated
510 - The patron will be charge (see ExpireReservesMaxPickUpDelayCharge) if the charge_cancel_fee parameter is set
511 - The canceled hold will have the cancellation reason added to old_reserves.cancellation_reason if one is passed in
512 - a CANCEL HOLDS log will be done if the pref HoldsLog is on
517 my ( $self, $params ) = @_;
518 $self->_result->result_source->schema->txn_do(
520 my $patron = $self->patron;
522 $self->cancellationdate( dt_from_string->strftime( '%Y-%m-%d %H:%M:%S' ) );
524 $self->cancellation_reason( $params->{cancellation_reason} );
527 if ( $params->{cancellation_reason} ) {
528 my $letter = C4::Letters::GetPreparedLetter(
529 module => 'reserves',
530 letter_code => 'HOLD_CANCELLATION',
531 message_transport_type => 'email',
532 branchcode => $self->borrower->branchcode,
533 lang => $self->borrower->lang,
535 branches => $self->borrower->branchcode,
536 borrowers => $self->borrowernumber,
537 items => $self->itemnumber,
538 biblio => $self->biblionumber,
539 biblioitems => $self->biblionumber,
540 reserves => $self->unblessed,
545 C4::Letters::EnqueueLetter(
548 borrowernumber => $self->borrowernumber,
549 message_transport_type => 'email',
555 my $old_me = $self->_move_to_old;
556 # anonymize if required
558 if $patron->privacy == 2;
560 $self->SUPER::delete(); # Do not add a DELETE log
562 # now fix the priority on the others....
563 C4::Reserves::_FixPriority({ biblionumber => $self->biblionumber });
565 # and, if desired, charge a cancel fee
566 my $charge = C4::Context->preference("ExpireReservesMaxPickUpDelayCharge");
567 if ( $charge && $params->{'charge_cancel_fee'} ) {
569 Koha::Account->new( { patron_id => $self->borrowernumber } );
573 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
574 interface => C4::Context->interface,
575 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
576 type => 'RESERVE_EXPIRED',
577 item_id => $self->itemnumber
582 C4::Log::logaction( 'HOLDS', 'CANCEL', $self->reserve_id, $self )
583 if C4::Context->preference('HoldsLog');
593 This method marks the hold as filled. It effectively moves it to old_reserves.
599 $self->_result->result_source->schema->txn_do(
601 my $patron = $self->patron;
611 $self->SUPER::delete(); # Do not add a DELETE log
613 # now fix the priority on the others....
614 C4::Reserves::_FixPriority({ biblionumber => $self->biblionumber });
616 if ( C4::Context->preference('HoldFeeMode') eq 'any_time_is_collected' ) {
617 my $fee = $patron->category->reservefee // 0;
619 $patron->account->add_debit(
622 description => $self->biblio->title,
623 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
624 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
625 interface => C4::Context->interface,
627 item_id => $self->itemnumber
633 C4::Log::logaction( 'HOLDS', 'FILL', $self->id, $self )
634 if C4::Context->preference('HoldsLog');
642 Override base store method to set default
643 expirationdate for holds.
650 if ( !$self->in_storage ) {
651 if ( ! $self->expirationdate && $self->patron_expiration_date ) {
652 $self->expirationdate($self->patron_expiration_date);
656 C4::Context->preference('DefaultHoldExpirationdate')
657 && !$self->expirationdate
660 $self->_set_default_expirationdate;
665 my %updated_columns = $self->_result->get_dirty_columns;
666 return $self->SUPER::store unless %updated_columns;
668 if ( exists $updated_columns{reservedate} ) {
670 C4::Context->preference('DefaultHoldExpirationdate')
671 && ! exists $updated_columns{expirationdate}
674 $self->_set_default_expirationdate;
679 $self = $self->SUPER::store;
682 sub _set_default_expirationdate {
685 my $period = C4::Context->preference('DefaultHoldExpirationdatePeriod') || 0;
687 C4::Context->preference('DefaultHoldExpirationdateUnitOfTime') || 'days';
689 $self->expirationdate(
690 dt_from_string( $self->reservedate )->add( $timeunit => $period ) );
695 my $is_moved = $hold->_move_to_old;
697 Move a hold to the old_reserve table following the same pattern as Koha::Patron->move_to_deleted
703 my $hold_infos = $self->unblessed;
704 return Koha::Old::Hold->new( $hold_infos )->store;
707 =head3 to_api_mapping
709 This method returns the mapping for representing a Koha::Hold object
716 reserve_id => 'hold_id',
717 borrowernumber => 'patron_id',
718 reservedate => 'hold_date',
719 biblionumber => 'biblio_id',
720 branchcode => 'pickup_library_id',
721 notificationdate => undef,
722 reminderdate => undef,
723 cancellationdate => 'cancellation_date',
724 reservenotes => 'notes',
726 itemnumber => 'item_id',
727 waitingdate => 'waiting_date',
728 expirationdate => 'expiration_date',
729 patron_expiration_date => undef,
730 lowestPriority => 'lowest_priority',
731 suspend => 'suspended',
732 suspend_until => 'suspended_until',
733 itemtype => 'item_type',
734 item_level_hold => 'item_level',
738 =head2 Internal methods
750 Kyle M Hall <kyle@bywatersolutions.com>
751 Jonathan Druart <jonathan.druart@bugs.koha-community.org>
752 Martin Renvoize <martin.renvoize@ptfs-europe.com>