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);
25 use List::MoreUtils qw(any);
27 use C4::Context qw(preference);
31 use Koha::AuthorisedValues;
32 use Koha::DateUtils qw(dt_from_string output_pref);
40 use Koha::Exceptions::Hold;
42 use base qw(Koha::Object);
46 Koha::Hold - Koha Hold object class
56 returns the number of days since a hold was placed, optionally
59 my $age = $hold->age( $use_calendar );
64 my ( $self, $use_calendar ) = @_;
66 my $today = dt_from_string;
69 if ( $use_calendar ) {
70 my $calendar = Koha::Calendar->new( branchcode => $self->branchcode );
71 $age = $calendar->days_between( dt_from_string( $self->reservedate ), $today );
74 $age = $today->delta_days( dt_from_string( $self->reservedate ) );
77 $age = $age->in_units( 'days' );
84 my $hold = $hold->suspend_hold( $suspend_until_dt );
89 my ( $self, $dt ) = @_;
91 my $date = $dt ? $dt->clone()->truncate( to => 'day' )->datetime : undef;
93 if ( $self->is_found ) { # We can't suspend found holds
94 if ( $self->is_waiting ) {
95 Koha::Exceptions::Hold::CannotSuspendFound->throw( status => 'W' );
97 elsif ( $self->is_in_transit ) {
98 Koha::Exceptions::Hold::CannotSuspendFound->throw( status => 'T' );
100 elsif ( $self->is_in_processing ) {
101 Koha::Exceptions::Hold::CannotSuspendFound->throw( status => 'P' );
104 Koha::Exceptions::Hold::CannotSuspendFound->throw(
105 'Unhandled data exception on found hold (id='
114 $self->suspend_until($date);
117 logaction( 'HOLDS', 'SUSPEND', $self->reserve_id, Dumper( $self->unblessed ) )
118 if C4::Context->preference('HoldsLog');
125 my $hold = $hold->resume();
133 $self->suspend_until( undef );
137 logaction( 'HOLDS', 'RESUME', $self->reserve_id, Dumper($self->unblessed) )
138 if C4::Context->preference('HoldsLog');
152 my $deleted = $self->SUPER::delete($self);
154 logaction( 'HOLDS', 'DELETE', $self->reserve_id, Dumper($self->unblessed) )
155 if C4::Context->preference('HoldsLog');
179 my ( $self, $desk_id ) = @_;
183 my $today = dt_from_string();
186 waitingdate => $today->ymd,
190 my $requested_expiration;
191 if ($self->expirationdate) {
192 $requested_expiration = dt_from_string($self->expirationdate);
195 my $max_pickup_delay = C4::Context->preference("ReservesMaxPickUpDelay");
196 my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
198 my $expirationdate = $today->clone;
199 $expirationdate->add(days => $max_pickup_delay);
201 if ( C4::Context->preference("ExcludeHolidaysFromMaxPickUpDelay") ) {
202 my $itemtype = $self->item ? $self->item->effective_itemtype : $self->biblio->itemtype;
203 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
205 categorycode => $self->borrower->categorycode,
206 itemtype => $itemtype,
207 branchcode => $self->branchcode,
210 my $calendar = Koha::Calendar->new( branchcode => $self->branchcode, days_mode => $daysmode );
212 $expirationdate = $calendar->days_forward( dt_from_string(), $max_pickup_delay );
215 # If patron's requested expiration date is prior to the
216 # calculated one, we keep the patron's one.
217 my $cmp = $requested_expiration ? DateTime->compare($requested_expiration, $expirationdate) : 0;
218 $values->{expirationdate} = $cmp == -1 ? $requested_expiration->ymd : $expirationdate->ymd;
220 $self->set($values)->store();
225 =head3 is_pickup_location_valid
227 if ($hold->is_pickup_location_valid({ library_id => $library->id }) ) {
231 Returns a I<boolean> representing if the passed pickup location is valid for the hold.
232 It throws a I<Koha::Exceptions::_MissingParameter> if the library_id parameter is not
237 sub is_pickup_location_valid {
238 my ( $self, $params ) = @_;
240 Koha::Exceptions::MissingParameter->throw('The library_id parameter is mandatory')
241 unless $params->{library_id};
243 my @pickup_locations;
245 if ( $self->itemnumber ) { # item-level
246 @pickup_locations = $self->item->pickup_locations({ patron => $self->patron });
248 else { # biblio-level
249 @pickup_locations = $self->biblio->pickup_locations({ patron => $self->patron });
252 return any { $_->branchcode eq $params->{library_id} } @pickup_locations;
255 =head3 set_pickup_location
257 $hold->set_pickup_location({ library_id => $library->id });
259 Updates the hold pickup location. It throws a I<Koha::Exceptions::Hold::InvalidPickupLocation> if
260 the passed pickup location is not valid.
264 sub set_pickup_location {
265 my ( $self, $params ) = @_;
267 Koha::Exceptions::MissingParameter->throw('The library_id parameter is mandatory')
268 unless $params->{library_id};
270 if ( $self->is_pickup_location_valid({ library_id => $params->{library_id} }) ) {
271 # all good, set the new pickup location
272 $self->branchcode( $params->{library_id} )->store;
275 Koha::Exceptions::Hold::InvalidPickupLocation->throw;
281 =head3 set_processing
283 $hold->set_processing;
285 Mark the hold as in processing.
301 Returns true if hold is waiting, in transit or in processing
308 return 0 unless $self->found();
309 return 1 if $self->found() eq 'W';
310 return 1 if $self->found() eq 'T';
311 return 1 if $self->found() eq 'P';
316 Returns true if hold is a waiting hold
323 my $found = $self->found;
324 return $found && $found eq 'W';
329 Returns true if hold is a in_transit hold
336 return 0 unless $self->found();
337 return $self->found() eq 'T';
340 =head3 is_in_processing
342 Returns true if hold is a in_processing hold
346 sub is_in_processing {
349 return 0 unless $self->found();
350 return $self->found() eq 'P';
353 =head3 is_cancelable_from_opac
355 Returns true if hold is a cancelable hold
357 Holds may be only canceled if they are not found.
359 This is used from the OPAC.
363 sub is_cancelable_from_opac {
366 return 1 unless $self->is_found();
367 return 0; # if ->is_in_transit or if ->is_waiting or ->is_in_processing
370 =head3 is_at_destination
372 Returns true if hold is waiting
373 and the hold's pickup branch matches
374 the hold item's holding branch
378 sub is_at_destination {
381 return $self->is_waiting() && ( $self->branchcode() eq $self->item()->holdingbranch() );
386 Returns the related Koha::Biblio object for this hold
393 $self->{_biblio} ||= Koha::Biblios->find( $self->biblionumber() );
395 return $self->{_biblio};
400 Returns the related Koha::Patron object for this hold
407 my $patron_rs = $self->_result->patron;
408 return Koha::Patron->_new_from_dbic($patron_rs);
413 Returns the related Koha::Item object for this Hold
420 $self->{_item} ||= Koha::Items->find( $self->itemnumber() );
422 return $self->{_item};
427 Returns the related Koha::Library object for this Hold
434 $self->{_branch} ||= Koha::Libraries->find( $self->branchcode() );
436 return $self->{_branch};
441 Returns the related Koha::Desk object for this Hold
447 my $desk_rs = $self->_result->desk;
448 return unless $desk_rs;
449 return Koha::Desk->_new_from_dbic($desk_rs);
454 Returns the related Koha::Patron object for this Hold
458 # FIXME Should be renamed with ->patron
462 $self->{_borrower} ||= Koha::Patrons->find( $self->borrowernumber() );
464 return $self->{_borrower};
469 my $bool = $hold->is_suspended();
476 return $self->suspend();
482 my $cancel_hold = $hold->cancel(
484 [ charge_cancel_fee => 1||0, ]
485 [ cancellation_reason => $cancellation_reason, ]
490 - The hold will be moved to the old_reserves table with a priority=0
491 - The priority of other holds will be updated
492 - The patron will be charge (see ExpireReservesMaxPickUpDelayCharge) if the charge_cancel_fee parameter is set
493 - The canceled hold will have the cancellation reason added to old_reserves.cancellation_reason if one is passed in
494 - a CANCEL HOLDS log will be done if the pref HoldsLog is on
499 my ( $self, $params ) = @_;
500 $self->_result->result_source->schema->txn_do(
502 $self->cancellationdate( dt_from_string->strftime( '%Y-%m-%d %H:%M:%S' ) );
504 $self->cancellation_reason( $params->{cancellation_reason} );
507 if ( $params->{cancellation_reason} ) {
508 my $letter = C4::Letters::GetPreparedLetter(
509 module => 'reserves',
510 letter_code => 'HOLD_CANCELLATION',
511 message_transport_type => 'email',
512 branchcode => $self->borrower->branchcode,
513 lang => $self->borrower->lang,
515 branches => $self->borrower->branchcode,
516 borrowers => $self->borrowernumber,
517 items => $self->itemnumber,
518 biblio => $self->biblionumber,
519 biblioitems => $self->biblionumber,
520 reserves => $self->unblessed,
525 C4::Letters::EnqueueLetter(
528 borrowernumber => $self->borrowernumber,
529 message_transport_type => 'email',
536 $self->SUPER::delete(); # Do not add a DELETE log
538 # now fix the priority on the others....
539 C4::Reserves::_FixPriority({ biblionumber => $self->biblionumber });
541 # and, if desired, charge a cancel fee
542 my $charge = C4::Context->preference("ExpireReservesMaxPickUpDelayCharge");
543 if ( $charge && $params->{'charge_cancel_fee'} ) {
545 Koha::Account->new( { patron_id => $self->borrowernumber } );
549 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
550 interface => C4::Context->interface,
551 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
552 type => 'RESERVE_EXPIRED',
553 item_id => $self->itemnumber
558 C4::Log::logaction( 'HOLDS', 'CANCEL', $self->reserve_id, Dumper($self->unblessed) )
559 if C4::Context->preference('HoldsLog');
567 my $is_moved = $hold->_move_to_old;
569 Move a hold to the old_reserve table following the same pattern as Koha::Patron->move_to_deleted
575 my $hold_infos = $self->unblessed;
576 return Koha::Old::Hold->new( $hold_infos )->store;
579 =head3 to_api_mapping
581 This method returns the mapping for representing a Koha::Hold object
588 reserve_id => 'hold_id',
589 borrowernumber => 'patron_id',
590 reservedate => 'hold_date',
591 biblionumber => 'biblio_id',
592 branchcode => 'pickup_library_id',
593 notificationdate => undef,
594 reminderdate => undef,
595 cancellationdate => 'cancellation_date',
596 reservenotes => 'notes',
598 itemnumber => 'item_id',
599 waitingdate => 'waiting_date',
600 expirationdate => 'expiration_date',
601 lowestPriority => 'lowest_priority',
602 suspend => 'suspended',
603 suspend_until => 'suspended_until',
604 itemtype => 'item_type',
605 item_level_hold => 'item_level',
609 =head2 Internal methods
621 Kyle M Hall <kyle@bywatersolutions.com>
622 Jonathan Druart <jonathan.druart@bugs.koha-community.org>
623 Martin Renvoize <martin.renvoize@ptfs-europe.com>