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' );
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');
182 my $today = dt_from_string();
185 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 set_processing
225 $hold->set_processing;
227 Mark the hold as in processing.
243 Returns true if hold is waiting, in transit or in processing
250 return 0 unless $self->found();
251 return 1 if $self->found() eq 'W';
252 return 1 if $self->found() eq 'T';
253 return 1 if $self->found() eq 'P';
258 Returns true if hold is a waiting hold
265 my $found = $self->found;
266 return $found && $found eq 'W';
271 Returns true if hold is a in_transit hold
278 return 0 unless $self->found();
279 return $self->found() eq 'T';
282 =head3 is_in_processing
284 Returns true if hold is a in_processing hold
288 sub is_in_processing {
291 return 0 unless $self->found();
292 return $self->found() eq 'P';
295 =head3 is_cancelable_from_opac
297 Returns true if hold is a cancelable hold
299 Holds may be only canceled if they are not found.
301 This is used from the OPAC.
305 sub is_cancelable_from_opac {
308 return 1 unless $self->is_found();
309 return 0; # if ->is_in_transit or if ->is_waiting or ->is_in_processing
312 =head3 is_at_destination
314 Returns true if hold is waiting
315 and the hold's pickup branch matches
316 the hold item's holding branch
320 sub is_at_destination {
323 return $self->is_waiting() && ( $self->branchcode() eq $self->item()->holdingbranch() );
328 Returns the related Koha::Biblio object for this hold
335 $self->{_biblio} ||= Koha::Biblios->find( $self->biblionumber() );
337 return $self->{_biblio};
342 Returns the related Koha::Item object for this Hold
349 $self->{_item} ||= Koha::Items->find( $self->itemnumber() );
351 return $self->{_item};
356 Returns the related Koha::Library object for this Hold
363 $self->{_branch} ||= Koha::Libraries->find( $self->branchcode() );
365 return $self->{_branch};
370 Returns the related Koha::Patron object for this Hold
374 # FIXME Should be renamed with ->patron
378 $self->{_borrower} ||= Koha::Patrons->find( $self->borrowernumber() );
380 return $self->{_borrower};
385 my $bool = $hold->is_suspended();
392 return $self->suspend();
398 my $cancel_hold = $hold->cancel(
400 [ charge_cancel_fee => 1||0, ]
401 [ cancellation_reason => $cancellation_reason, ]
406 - The hold will be moved to the old_reserves table with a priority=0
407 - The priority of other holds will be updated
408 - The patron will be charge (see ExpireReservesMaxPickUpDelayCharge) if the charge_cancel_fee parameter is set
409 - The canceled hold will have the cancellation reason added to old_reserves.cancellation_reason if one is passed in
410 - a CANCEL HOLDS log will be done if the pref HoldsLog is on
415 my ( $self, $params ) = @_;
416 $self->_result->result_source->schema->txn_do(
418 $self->cancellationdate( dt_from_string->strftime( '%Y-%m-%d %H:%M:%S' ) );
420 $self->cancellation_reason( $params->{cancellation_reason} );
423 if ( $params->{cancellation_reason} ) {
424 my $letter = C4::Letters::GetPreparedLetter(
425 module => 'reserves',
426 letter_code => 'HOLD_CANCELLATION',
427 message_transport_type => 'email',
428 branchcode => $self->borrower->branchcode,
429 lang => $self->borrower->lang,
431 branches => $self->borrower->branchcode,
432 borrowers => $self->borrowernumber,
433 items => $self->itemnumber,
434 biblio => $self->biblionumber,
435 biblioitems => $self->biblionumber,
436 reserves => $self->unblessed,
441 C4::Letters::EnqueueLetter(
444 borrowernumber => $self->borrowernumber,
445 message_transport_type => 'email',
452 $self->SUPER::delete(); # Do not add a DELETE log
454 # now fix the priority on the others....
455 C4::Reserves::_FixPriority({ biblionumber => $self->biblionumber });
457 # and, if desired, charge a cancel fee
458 my $charge = C4::Context->preference("ExpireReservesMaxPickUpDelayCharge");
459 if ( $charge && $params->{'charge_cancel_fee'} ) {
461 Koha::Account->new( { patron_id => $self->borrowernumber } );
465 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
466 interface => C4::Context->interface,
467 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
468 type => 'RESERVE_EXPIRED',
469 item_id => $self->itemnumber
474 C4::Log::logaction( 'HOLDS', 'CANCEL', $self->reserve_id, Dumper($self->unblessed) )
475 if C4::Context->preference('HoldsLog');
483 my $is_moved = $hold->_move_to_old;
485 Move a hold to the old_reserve table following the same pattern as Koha::Patron->move_to_deleted
491 my $hold_infos = $self->unblessed;
492 return Koha::Old::Hold->new( $hold_infos )->store;
495 =head3 to_api_mapping
497 This method returns the mapping for representing a Koha::Hold object
504 reserve_id => 'hold_id',
505 borrowernumber => 'patron_id',
506 reservedate => 'hold_date',
507 biblionumber => 'biblio_id',
508 branchcode => 'pickup_library_id',
509 notificationdate => undef,
510 reminderdate => undef,
511 cancellationdate => 'cancellation_date',
512 reservenotes => 'notes',
514 itemnumber => 'item_id',
515 waitingdate => 'waiting_date',
516 expirationdate => 'expiration_date',
517 lowestPriority => 'lowest_priority',
518 suspend => 'suspended',
519 suspend_until => 'suspended_until',
520 itemtype => 'item_type',
521 item_level_hold => 'item_level',
525 =head2 Internal methods
537 Kyle M Hall <kyle@bywatersolutions.com>
538 Jonathan Druart <jonathan.druart@bugs.koha-community.org>
539 Martin Renvoize <martin.renvoize@ptfs-europe.com>