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();
184 waitingdate => $today->ymd,
188 my $requested_expiration;
189 if ($self->expirationdate) {
190 $requested_expiration = dt_from_string($self->expirationdate);
193 my $max_pickup_delay = C4::Context->preference("ReservesMaxPickUpDelay");
194 my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
196 my $expirationdate = $today->clone;
197 $expirationdate->add(days => $max_pickup_delay);
199 if ( C4::Context->preference("ExcludeHolidaysFromMaxPickUpDelay") ) {
200 my $itemtype = $self->item ? $self->item->effective_itemtype : $self->biblio->itemtype;
201 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
203 categorycode => $self->borrower->categorycode,
204 itemtype => $itemtype,
205 branchcode => $self->branchcode,
208 my $calendar = Koha::Calendar->new( branchcode => $self->branchcode, days_mode => $daysmode );
210 $expirationdate = $calendar->days_forward( dt_from_string(), $max_pickup_delay );
213 # If patron's requested expiration date is prior to the
214 # calculated one, we keep the patron's one.
215 my $cmp = $requested_expiration ? DateTime->compare($requested_expiration, $expirationdate) : 0;
216 $values->{expirationdate} = $cmp == -1 ? $requested_expiration->ymd : $expirationdate->ymd;
218 $self->set($values)->store();
223 =head3 is_pickup_location_valid
225 if ($hold->is_pickup_location_valid({ library_id => $library->id }) ) {
229 Returns a I<boolean> representing if the passed pickup location is valid for the hold.
230 It throws a I<Koha::Exceptions::_MissingParameter> if the library_id parameter is not
235 sub is_pickup_location_valid {
236 my ( $self, $params ) = @_;
238 Koha::Exceptions::MissingParameter->throw('The library_id parameter is mandatory')
239 unless $params->{library_id};
241 my $pickup_locations;
243 if ( $self->itemnumber ) { # item-level
244 $pickup_locations = $self->item->pickup_locations({ patron => $self->patron });
246 else { # biblio-level
247 $pickup_locations = $self->biblio->pickup_locations({ patron => $self->patron });
250 return any { $_->branchcode eq $params->{library_id} } $pickup_locations->as_list;
253 =head3 set_pickup_location
255 $hold->set_pickup_location(
257 library_id => $library->id,
262 Updates the hold pickup location. It throws a I<Koha::Exceptions::Hold::InvalidPickupLocation> if
263 the passed pickup location is not valid.
265 Note: It is up to the caller to verify if I<AllowHoldPolicyOverride> is set when setting the
270 sub set_pickup_location {
271 my ( $self, $params ) = @_;
273 Koha::Exceptions::MissingParameter->throw('The library_id parameter is mandatory')
274 unless $params->{library_id};
278 || $self->is_pickup_location_valid(
279 { library_id => $params->{library_id} }
283 # all good, set the new pickup location
284 $self->branchcode( $params->{library_id} )->store;
287 Koha::Exceptions::Hold::InvalidPickupLocation->throw;
293 =head3 set_processing
295 $hold->set_processing;
297 Mark the hold as in processing.
313 Returns true if hold is waiting, in transit or in processing
320 return 0 unless $self->found();
321 return 1 if $self->found() eq 'W';
322 return 1 if $self->found() eq 'T';
323 return 1 if $self->found() eq 'P';
328 Returns true if hold is a waiting hold
335 my $found = $self->found;
336 return $found && $found eq 'W';
341 Returns true if hold is a in_transit hold
348 return 0 unless $self->found();
349 return $self->found() eq 'T';
352 =head3 is_in_processing
354 Returns true if hold is a in_processing hold
358 sub is_in_processing {
361 return 0 unless $self->found();
362 return $self->found() eq 'P';
365 =head3 is_cancelable_from_opac
367 Returns true if hold is a cancelable hold
369 Holds may be only canceled if they are not found.
371 This is used from the OPAC.
375 sub is_cancelable_from_opac {
378 return 1 unless $self->is_found();
379 return 0; # if ->is_in_transit or if ->is_waiting or ->is_in_processing
382 =head3 is_at_destination
384 Returns true if hold is waiting
385 and the hold's pickup branch matches
386 the hold item's holding branch
390 sub is_at_destination {
393 return $self->is_waiting() && ( $self->branchcode() eq $self->item()->holdingbranch() );
398 Returns the related Koha::Biblio object for this hold
405 $self->{_biblio} ||= Koha::Biblios->find( $self->biblionumber() );
407 return $self->{_biblio};
412 Returns the related Koha::Patron object for this hold
419 my $patron_rs = $self->_result->patron;
420 return Koha::Patron->_new_from_dbic($patron_rs);
425 Returns the related Koha::Item object for this Hold
432 $self->{_item} ||= Koha::Items->find( $self->itemnumber() );
434 return $self->{_item};
439 Returns the related Koha::Library object for this Hold
446 $self->{_branch} ||= Koha::Libraries->find( $self->branchcode() );
448 return $self->{_branch};
453 Returns the related Koha::Desk object for this Hold
459 my $desk_rs = $self->_result->desk;
460 return unless $desk_rs;
461 return Koha::Desk->_new_from_dbic($desk_rs);
466 Returns the related Koha::Patron object for this Hold
470 # FIXME Should be renamed with ->patron
474 $self->{_borrower} ||= Koha::Patrons->find( $self->borrowernumber() );
476 return $self->{_borrower};
481 my $bool = $hold->is_suspended();
488 return $self->suspend();
494 my $cancel_hold = $hold->cancel(
496 [ charge_cancel_fee => 1||0, ]
497 [ cancellation_reason => $cancellation_reason, ]
502 - The hold will be moved to the old_reserves table with a priority=0
503 - The priority of other holds will be updated
504 - The patron will be charge (see ExpireReservesMaxPickUpDelayCharge) if the charge_cancel_fee parameter is set
505 - The canceled hold will have the cancellation reason added to old_reserves.cancellation_reason if one is passed in
506 - a CANCEL HOLDS log will be done if the pref HoldsLog is on
511 my ( $self, $params ) = @_;
512 $self->_result->result_source->schema->txn_do(
514 $self->cancellationdate( dt_from_string->strftime( '%Y-%m-%d %H:%M:%S' ) );
516 $self->cancellation_reason( $params->{cancellation_reason} );
519 if ( $params->{cancellation_reason} ) {
520 my $letter = C4::Letters::GetPreparedLetter(
521 module => 'reserves',
522 letter_code => 'HOLD_CANCELLATION',
523 message_transport_type => 'email',
524 branchcode => $self->borrower->branchcode,
525 lang => $self->borrower->lang,
527 branches => $self->borrower->branchcode,
528 borrowers => $self->borrowernumber,
529 items => $self->itemnumber,
530 biblio => $self->biblionumber,
531 biblioitems => $self->biblionumber,
532 reserves => $self->unblessed,
537 C4::Letters::EnqueueLetter(
540 borrowernumber => $self->borrowernumber,
541 message_transport_type => 'email',
548 $self->SUPER::delete(); # Do not add a DELETE log
550 # now fix the priority on the others....
551 C4::Reserves::_FixPriority({ biblionumber => $self->biblionumber });
553 # and, if desired, charge a cancel fee
554 my $charge = C4::Context->preference("ExpireReservesMaxPickUpDelayCharge");
555 if ( $charge && $params->{'charge_cancel_fee'} ) {
557 Koha::Account->new( { patron_id => $self->borrowernumber } );
561 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
562 interface => C4::Context->interface,
563 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
564 type => 'RESERVE_EXPIRED',
565 item_id => $self->itemnumber
570 C4::Log::logaction( 'HOLDS', 'CANCEL', $self->reserve_id, $self )
571 if C4::Context->preference('HoldsLog');
579 Override base store method to set default
580 expirationdate for holds.
587 if ( !$self->in_storage ) {
589 C4::Context->preference('DefaultHoldExpirationdate')
590 and ( not defined $self->expirationdate
591 or $self->expirationdate eq '' )
594 $self->_set_default_expirationdate;
599 my %updated_columns = $self->_result->get_dirty_columns;
600 return $self->SUPER::store unless %updated_columns;
602 if ( exists $updated_columns{reservedate} ) {
604 C4::Context->preference('DefaultHoldExpirationdate')
605 and ( not exists $updated_columns{expirationdate}
606 or exists $updated_columns{expirationdate}
607 and $updated_columns{expirationdate} eq '' )
610 $self->_set_default_expirationdate;
615 $self = $self->SUPER::store;
618 sub _set_default_expirationdate {
621 my $period = C4::Context->preference('DefaultHoldExpirationdatePeriod') || 0;
623 C4::Context->preference('DefaultHoldExpirationdateUnitOfTime') || 'days';
625 $self->expirationdate(
626 dt_from_string( $self->reservedate )->add( $timeunit => $period ) );
631 my $is_moved = $hold->_move_to_old;
633 Move a hold to the old_reserve table following the same pattern as Koha::Patron->move_to_deleted
639 my $hold_infos = $self->unblessed;
640 return Koha::Old::Hold->new( $hold_infos )->store;
643 =head3 to_api_mapping
645 This method returns the mapping for representing a Koha::Hold object
652 reserve_id => 'hold_id',
653 borrowernumber => 'patron_id',
654 reservedate => 'hold_date',
655 biblionumber => 'biblio_id',
656 branchcode => 'pickup_library_id',
657 notificationdate => undef,
658 reminderdate => undef,
659 cancellationdate => 'cancellation_date',
660 reservenotes => 'notes',
662 itemnumber => 'item_id',
663 waitingdate => 'waiting_date',
664 expirationdate => 'expiration_date',
665 lowestPriority => 'lowest_priority',
666 suspend => 'suspended',
667 suspend_until => 'suspended_until',
668 itemtype => 'item_type',
669 item_level_hold => 'item_level',
673 =head2 Internal methods
685 Kyle M Hall <kyle@bywatersolutions.com>
686 Jonathan Druart <jonathan.druart@bugs.koha-community.org>
687 Martin Renvoize <martin.renvoize@ptfs-europe.com>