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 Data::Dumper qw( Dumper );
24 use List::MoreUtils qw( any );
27 use C4::Letters qw( GetPreparedLetter EnqueueLetter );
28 use C4::Log qw( logaction );
30 use Koha::AuthorisedValues;
31 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);
116 logaction( 'HOLDS', 'SUSPEND', $self->reserve_id, Dumper( $self->unblessed ) )
117 if C4::Context->preference('HoldsLog');
124 my $hold = $hold->resume();
132 $self->suspend_until( undef );
136 logaction( 'HOLDS', 'RESUME', $self->reserve_id, Dumper($self->unblessed) )
137 if C4::Context->preference('HoldsLog');
151 my $deleted = $self->SUPER::delete($self);
153 logaction( 'HOLDS', 'DELETE', $self->reserve_id, Dumper($self->unblessed) )
154 if C4::Context->preference('HoldsLog');
178 my ( $self, $desk_id ) = @_;
182 my $today = dt_from_string();
185 waitingdate => $today->ymd,
189 my $requested_expiration;
190 if ($self->expirationdate) {
191 $requested_expiration = dt_from_string($self->expirationdate);
194 my $max_pickup_delay = C4::Context->preference("ReservesMaxPickUpDelay");
195 my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
197 my $expirationdate = $today->clone;
198 $expirationdate->add(days => $max_pickup_delay);
200 if ( C4::Context->preference("ExcludeHolidaysFromMaxPickUpDelay") ) {
201 my $itemtype = $self->item ? $self->item->effective_itemtype : $self->biblio->itemtype;
202 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
204 categorycode => $self->borrower->categorycode,
205 itemtype => $itemtype,
206 branchcode => $self->branchcode,
209 my $calendar = Koha::Calendar->new( branchcode => $self->branchcode, days_mode => $daysmode );
211 $expirationdate = $calendar->days_forward( dt_from_string(), $max_pickup_delay );
214 # If patron's requested expiration date is prior to the
215 # calculated one, we keep the patron's one.
216 my $cmp = $requested_expiration ? DateTime->compare($requested_expiration, $expirationdate) : 0;
217 $values->{expirationdate} = $cmp == -1 ? $requested_expiration->ymd : $expirationdate->ymd;
219 $self->set($values)->store();
224 =head3 is_pickup_location_valid
226 if ($hold->is_pickup_location_valid({ library_id => $library->id }) ) {
230 Returns a I<boolean> representing if the passed pickup location is valid for the hold.
231 It throws a I<Koha::Exceptions::_MissingParameter> if the library_id parameter is not
236 sub is_pickup_location_valid {
237 my ( $self, $params ) = @_;
239 Koha::Exceptions::MissingParameter->throw('The library_id parameter is mandatory')
240 unless $params->{library_id};
242 my @pickup_locations;
244 if ( $self->itemnumber ) { # item-level
245 @pickup_locations = $self->item->pickup_locations({ patron => $self->patron });
247 else { # biblio-level
248 @pickup_locations = $self->biblio->pickup_locations({ patron => $self->patron });
251 return any { $_->branchcode eq $params->{library_id} } @pickup_locations;
254 =head3 set_pickup_location
256 $hold->set_pickup_location(
258 library_id => $library->id,
263 Updates the hold pickup location. It throws a I<Koha::Exceptions::Hold::InvalidPickupLocation> if
264 the passed pickup location is not valid.
266 Note: It is up to the caller to verify if I<AllowHoldPolicyOverride> is set when setting the
271 sub set_pickup_location {
272 my ( $self, $params ) = @_;
274 Koha::Exceptions::MissingParameter->throw('The library_id parameter is mandatory')
275 unless $params->{library_id};
279 || $self->is_pickup_location_valid(
280 { library_id => $params->{library_id} }
284 # all good, set the new pickup location
285 $self->branchcode( $params->{library_id} )->store;
288 Koha::Exceptions::Hold::InvalidPickupLocation->throw;
294 =head3 set_processing
296 $hold->set_processing;
298 Mark the hold as in processing.
314 Returns true if hold is waiting, in transit or in processing
321 return 0 unless $self->found();
322 return 1 if $self->found() eq 'W';
323 return 1 if $self->found() eq 'T';
324 return 1 if $self->found() eq 'P';
329 Returns true if hold is a waiting hold
336 my $found = $self->found;
337 return $found && $found eq 'W';
342 Returns true if hold is a in_transit hold
349 return 0 unless $self->found();
350 return $self->found() eq 'T';
353 =head3 is_in_processing
355 Returns true if hold is a in_processing hold
359 sub is_in_processing {
362 return 0 unless $self->found();
363 return $self->found() eq 'P';
366 =head3 is_cancelable_from_opac
368 Returns true if hold is a cancelable hold
370 Holds may be only canceled if they are not found.
372 This is used from the OPAC.
376 sub is_cancelable_from_opac {
379 return 1 unless $self->is_found();
380 return 0; # if ->is_in_transit or if ->is_waiting or ->is_in_processing
383 =head3 is_at_destination
385 Returns true if hold is waiting
386 and the hold's pickup branch matches
387 the hold item's holding branch
391 sub is_at_destination {
394 return $self->is_waiting() && ( $self->branchcode() eq $self->item()->holdingbranch() );
399 Returns the related Koha::Biblio object for this hold
406 $self->{_biblio} ||= Koha::Biblios->find( $self->biblionumber() );
408 return $self->{_biblio};
413 Returns the related Koha::Patron object for this hold
420 my $patron_rs = $self->_result->patron;
421 return Koha::Patron->_new_from_dbic($patron_rs);
426 Returns the related Koha::Item object for this Hold
433 $self->{_item} ||= Koha::Items->find( $self->itemnumber() );
435 return $self->{_item};
440 Returns the related Koha::Library object for this Hold
447 $self->{_branch} ||= Koha::Libraries->find( $self->branchcode() );
449 return $self->{_branch};
454 Returns the related Koha::Desk object for this Hold
460 my $desk_rs = $self->_result->desk;
461 return unless $desk_rs;
462 return Koha::Desk->_new_from_dbic($desk_rs);
467 Returns the related Koha::Patron object for this Hold
471 # FIXME Should be renamed with ->patron
475 $self->{_borrower} ||= Koha::Patrons->find( $self->borrowernumber() );
477 return $self->{_borrower};
482 my $bool = $hold->is_suspended();
489 return $self->suspend();
495 my $cancel_hold = $hold->cancel(
497 [ charge_cancel_fee => 1||0, ]
498 [ cancellation_reason => $cancellation_reason, ]
503 - The hold will be moved to the old_reserves table with a priority=0
504 - The priority of other holds will be updated
505 - The patron will be charge (see ExpireReservesMaxPickUpDelayCharge) if the charge_cancel_fee parameter is set
506 - The canceled hold will have the cancellation reason added to old_reserves.cancellation_reason if one is passed in
507 - a CANCEL HOLDS log will be done if the pref HoldsLog is on
512 my ( $self, $params ) = @_;
513 $self->_result->result_source->schema->txn_do(
515 $self->cancellationdate( dt_from_string->strftime( '%Y-%m-%d %H:%M:%S' ) );
517 $self->cancellation_reason( $params->{cancellation_reason} );
520 if ( $params->{cancellation_reason} ) {
521 my $letter = C4::Letters::GetPreparedLetter(
522 module => 'reserves',
523 letter_code => 'HOLD_CANCELLATION',
524 message_transport_type => 'email',
525 branchcode => $self->borrower->branchcode,
526 lang => $self->borrower->lang,
528 branches => $self->borrower->branchcode,
529 borrowers => $self->borrowernumber,
530 items => $self->itemnumber,
531 biblio => $self->biblionumber,
532 biblioitems => $self->biblionumber,
533 reserves => $self->unblessed,
538 C4::Letters::EnqueueLetter(
541 borrowernumber => $self->borrowernumber,
542 message_transport_type => 'email',
549 $self->SUPER::delete(); # Do not add a DELETE log
551 # now fix the priority on the others....
552 C4::Reserves::_FixPriority({ biblionumber => $self->biblionumber });
554 # and, if desired, charge a cancel fee
555 my $charge = C4::Context->preference("ExpireReservesMaxPickUpDelayCharge");
556 if ( $charge && $params->{'charge_cancel_fee'} ) {
558 Koha::Account->new( { patron_id => $self->borrowernumber } );
562 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
563 interface => C4::Context->interface,
564 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
565 type => 'RESERVE_EXPIRED',
566 item_id => $self->itemnumber
571 C4::Log::logaction( 'HOLDS', 'CANCEL', $self->reserve_id, Dumper($self->unblessed) )
572 if C4::Context->preference('HoldsLog');
580 Override base store method to set default
581 expirationdate for holds.
588 if ( !$self->in_storage ) {
590 C4::Context->preference('DefaultHoldExpirationdate')
591 and ( not defined $self->expirationdate
592 or $self->expirationdate eq '' )
595 $self->_set_default_expirationdate;
600 my %updated_columns = $self->_result->get_dirty_columns;
601 return $self->SUPER::store unless %updated_columns;
603 if ( exists $updated_columns{reservedate} ) {
605 C4::Context->preference('DefaultHoldExpirationdate')
606 and ( not exists $updated_columns{expirationdate}
607 or exists $updated_columns{expirationdate}
608 and $updated_columns{expirationdate} eq '' )
611 $self->_set_default_expirationdate;
616 $self = $self->SUPER::store;
619 sub _set_default_expirationdate {
622 my $period = C4::Context->preference('DefaultHoldExpirationdatePeriod') || 0;
624 C4::Context->preference('DefaultHoldExpirationdateUnitOfTime') || 'days';
626 $self->expirationdate(
627 dt_from_string( $self->reservedate )->add( $timeunit => $period ) );
632 my $is_moved = $hold->_move_to_old;
634 Move a hold to the old_reserve table following the same pattern as Koha::Patron->move_to_deleted
640 my $hold_infos = $self->unblessed;
641 return Koha::Old::Hold->new( $hold_infos )->store;
644 =head3 to_api_mapping
646 This method returns the mapping for representing a Koha::Hold object
653 reserve_id => 'hold_id',
654 borrowernumber => 'patron_id',
655 reservedate => 'hold_date',
656 biblionumber => 'biblio_id',
657 branchcode => 'pickup_library_id',
658 notificationdate => undef,
659 reminderdate => undef,
660 cancellationdate => 'cancellation_date',
661 reservenotes => 'notes',
663 itemnumber => 'item_id',
664 waitingdate => 'waiting_date',
665 expirationdate => 'expiration_date',
666 lowestPriority => 'lowest_priority',
667 suspend => 'suspended',
668 suspend_until => 'suspended_until',
669 itemtype => 'item_type',
670 item_level_hold => 'item_level',
674 =head2 Internal methods
686 Kyle M Hall <kyle@bywatersolutions.com>
687 Jonathan Druart <jonathan.druart@bugs.koha-community.org>
688 Martin Renvoize <martin.renvoize@ptfs-europe.com>