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>.
24 use Data::Dumper qw(Dumper);
26 use C4::Context qw(preference);
30 use Koha::AuthorisedValues;
31 use Koha::DateUtils qw(dt_from_string output_pref);
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' );
100 Koha::Exceptions::Hold::CannotSuspendFound->throw(
101 'Unhandled data exception on found hold (id='
110 $self->suspend_until($date);
113 logaction( 'HOLDS', 'SUSPEND', $self->reserve_id, Dumper( $self->unblessed ) )
114 if C4::Context->preference('HoldsLog');
121 my $hold = $hold->resume();
129 $self->suspend_until( undef );
133 logaction( 'HOLDS', 'RESUME', $self->reserve_id, Dumper($self->unblessed) )
134 if C4::Context->preference('HoldsLog');
148 my $deleted = $self->SUPER::delete($self);
150 logaction( 'HOLDS', 'DELETE', $self->reserve_id, Dumper($self->unblessed) )
151 if C4::Context->preference('HoldsLog');
161 my ( $self, $transferToDo ) = @_;
166 $self->found('T')->store();
170 my $today = dt_from_string();
173 waitingdate => $today->ymd,
176 my $requested_expiration;
177 if ($self->expirationdate) {
178 $requested_expiration = dt_from_string($self->expirationdate);
181 my $max_pickup_delay = C4::Context->preference("ReservesMaxPickUpDelay");
182 my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
184 my $expirationdate = $today->clone;
185 $expirationdate->add(days => $max_pickup_delay);
187 if ( C4::Context->preference("ExcludeHolidaysFromMaxPickUpDelay") ) {
188 my $itemtype = $self->item ? $self->item->effective_itemtype : $self->biblio->itemtype;
189 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
191 categorycode => $self->borrower->categorycode,
192 itemtype => $itemtype,
193 branchcode => $self->branchcode,
196 my $calendar = Koha::Calendar->new( branchcode => $self->branchcode, days_mode => $daysmode );
198 $expirationdate = $calendar->days_forward( dt_from_string(), $max_pickup_delay );
201 # If patron's requested expiration date is prior to the
202 # calculated one, we keep the patron's one.
203 my $cmp = $requested_expiration ? DateTime->compare($requested_expiration, $expirationdate) : 0;
204 $values->{expirationdate} = $cmp == -1 ? $requested_expiration->ymd : $expirationdate->ymd;
206 $self->set($values)->store();
213 Returns true if hold is a waiting or in transit
220 return 0 unless $self->found();
221 return 1 if $self->found() eq 'W';
222 return 1 if $self->found() eq 'T';
227 Returns true if hold is a waiting hold
234 my $found = $self->found;
235 return $found && $found eq 'W';
240 Returns true if hold is a in_transit hold
247 return 0 unless $self->found();
248 return $self->found() eq 'T';
251 =head3 is_cancelable_from_opac
253 Returns true if hold is a cancelable hold
255 Holds may be only canceled if they are not found.
257 This is used from the OPAC.
261 sub is_cancelable_from_opac {
264 return 1 unless $self->is_found();
265 return 0; # if ->is_in_transit or if ->is_waiting
268 =head3 is_at_destination
270 Returns true if hold is waiting
271 and the hold's pickup branch matches
272 the hold item's holding branch
276 sub is_at_destination {
279 return $self->is_waiting() && ( $self->branchcode() eq $self->item()->holdingbranch() );
284 Returns the related Koha::Biblio object for this hold
291 $self->{_biblio} ||= Koha::Biblios->find( $self->biblionumber() );
293 return $self->{_biblio};
298 Returns the related Koha::Item object for this Hold
305 $self->{_item} ||= Koha::Items->find( $self->itemnumber() );
307 return $self->{_item};
312 Returns the related Koha::Library object for this Hold
319 $self->{_branch} ||= Koha::Libraries->find( $self->branchcode() );
321 return $self->{_branch};
326 Returns the related Koha::Patron object for this Hold
330 # FIXME Should be renamed with ->patron
334 $self->{_borrower} ||= Koha::Patrons->find( $self->borrowernumber() );
336 return $self->{_borrower};
341 my $bool = $hold->is_suspended();
348 return $self->suspend();
354 my $cancel_hold = $hold->cancel();
357 - The hold will be moved to the old_reserves table with a priority=0
358 - The priority of other holds will be updated
359 - The patron will be charge (see ExpireReservesMaxPickUpDelayCharge) if the charge_cancel_fee parameter is set
360 - a CANCEL HOLDS log will be done if the pref HoldsLog is on
365 my ( $self, $params ) = @_;
366 $self->_result->result_source->schema->txn_do(
368 $self->cancellationdate( dt_from_string->strftime( '%Y-%m-%d %H:%M:%S' ) );
370 $self->cancellation_reason( $params->{cancellation_reason} );
373 if ( $params->{cancellation_reason} ) {
374 my $letter = C4::Letters::GetPreparedLetter(
375 module => 'reserves',
376 letter_code => 'HOLD_CANCELLATION',
377 message_transport_type => 'email',
378 branchcode => $self->borrower->branchcode,
379 lang => $self->borrower->lang,
381 branches => $self->borrower->branchcode,
382 borrowers => $self->borrowernumber,
383 items => $self->itemnumber,
384 biblio => $self->biblionumber,
385 biblioitems => $self->biblionumber,
386 reserves => $self->unblessed,
391 C4::Letters::EnqueueLetter(
394 borrowernumber => $self->borrowernumber,
395 message_transport_type => 'email',
402 $self->SUPER::delete(); # Do not add a DELETE log
404 # now fix the priority on the others....
405 C4::Reserves::_FixPriority({ biblionumber => $self->biblionumber });
407 # and, if desired, charge a cancel fee
408 my $charge = C4::Context->preference("ExpireReservesMaxPickUpDelayCharge");
409 if ( $charge && $params->{'charge_cancel_fee'} ) {
411 Koha::Account->new( { patron_id => $self->borrowernumber } );
415 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
416 interface => C4::Context->interface,
417 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
418 type => 'RESERVE_EXPIRED',
419 item_id => $self->itemnumber
424 C4::Log::logaction( 'HOLDS', 'CANCEL', $self->reserve_id, Dumper($self->unblessed) )
425 if C4::Context->preference('HoldsLog');
433 my $is_moved = $hold->_move_to_old;
435 Move a hold to the old_reserve table following the same pattern as Koha::Patron->move_to_deleted
441 my $hold_infos = $self->unblessed;
442 return Koha::Old::Hold->new( $hold_infos )->store;
445 =head3 to_api_mapping
447 This method returns the mapping for representing a Koha::Hold object
454 reserve_id => 'hold_id',
455 borrowernumber => 'patron_id',
456 reservedate => 'hold_date',
457 biblionumber => 'biblio_id',
458 branchcode => 'pickup_library_id',
459 notificationdate => undef,
460 reminderdate => undef,
461 cancellationdate => 'cancellation_date',
462 reservenotes => 'notes',
464 itemnumber => 'item_id',
465 waitingdate => 'waiting_date',
466 expirationdate => 'expiration_date',
467 lowestPriority => 'lowest_priority',
468 suspend => 'suspended',
469 suspend_until => 'suspended_until',
470 itemtype => 'item_type',
471 item_level_hold => 'item_level',
475 =head2 Internal methods
487 Kyle M Hall <kyle@bywatersolutions.com>
488 Jonathan Druart <jonathan.druart@bugs.koha-community.org>
489 Martin Renvoize <martin.renvoize@ptfs-europe.com>