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);
29 use Koha
::DateUtils
qw(dt_from_string output_pref);
37 use Koha
::Exceptions
::Hold
;
39 use base
qw(Koha::Object);
43 Koha::Hold - Koha Hold object class
53 returns the number of days since a hold was placed, optionally
56 my $age = $hold->age( $use_calendar );
61 my ( $self, $use_calendar ) = @_;
63 my $today = dt_from_string
;
66 if ( $use_calendar ) {
67 my $calendar = Koha
::Calendar
->new( branchcode
=> $self->branchcode );
68 $age = $calendar->days_between( dt_from_string
( $self->reservedate ), $today );
71 $age = $today->delta_days( dt_from_string
( $self->reservedate ) );
74 $age = $age->in_units( 'days' );
81 my $hold = $hold->suspend_hold( $suspend_until_dt );
86 my ( $self, $dt ) = @_;
88 my $date = $dt ?
$dt->clone()->truncate( to
=> 'day' )->datetime : undef;
90 if ( $self->is_found ) { # We can't suspend found holds
91 if ( $self->is_waiting ) {
92 Koha
::Exceptions
::Hold
::CannotSuspendFound
->throw( status
=> 'W' );
94 elsif ( $self->is_in_transit ) {
95 Koha
::Exceptions
::Hold
::CannotSuspendFound
->throw( status
=> 'T' );
98 Koha
::Exceptions
::Hold
::CannotSuspendFound
->throw(
99 'Unhandled data exception on found hold (id='
108 $self->suspend_until($date);
111 logaction
( 'HOLDS', 'SUSPEND', $self->reserve_id, Dumper
( $self->unblessed ) )
112 if C4
::Context
->preference('HoldsLog');
119 my $hold = $hold->resume();
127 $self->suspend_until( undef );
131 logaction
( 'HOLDS', 'RESUME', $self->reserve_id, Dumper
($self->unblessed) )
132 if C4
::Context
->preference('HoldsLog');
146 my $deleted = $self->SUPER::delete($self);
148 logaction
( 'HOLDS', 'DELETE', $self->reserve_id, Dumper
($self->unblessed) )
149 if C4
::Context
->preference('HoldsLog');
159 my ( $self, $transferToDo ) = @_;
164 $self->found('T')->store();
168 my $today = dt_from_string
();
171 waitingdate
=> $today->ymd,
174 my $requested_expiration;
175 if ($self->expirationdate) {
176 $requested_expiration = dt_from_string
($self->expirationdate);
179 my $max_pickup_delay = C4
::Context
->preference("ReservesMaxPickUpDelay");
180 my $cancel_on_holidays = C4
::Context
->preference('ExpireReservesOnHolidays');
182 my $expirationdate = $today->clone;
183 $expirationdate->add(days
=> $max_pickup_delay);
185 if ( C4
::Context
->preference("ExcludeHolidaysFromMaxPickUpDelay") ) {
186 my $itemtype = $self->item ?
$self->item->effective_itemtype : $self->biblio->itemtype;
187 my $daysmode = Koha
::CirculationRules
->get_effective_daysmode(
189 categorycode
=> $self->borrower->categorycode,
190 itemtype
=> $itemtype,
191 branchcode
=> $self->branchcode,
194 my $calendar = Koha
::Calendar
->new( branchcode
=> $self->branchcode, days_mode
=> $daysmode );
196 $expirationdate = $calendar->days_forward( dt_from_string
(), $max_pickup_delay );
199 # If patron's requested expiration date is prior to the
200 # calculated one, we keep the patron's one.
201 my $cmp = $requested_expiration ? DateTime
->compare($requested_expiration, $expirationdate) : 0;
202 $values->{expirationdate
} = $cmp == -1 ?
$requested_expiration->ymd : $expirationdate->ymd;
204 $self->set($values)->store();
211 Returns true if hold is a waiting or in transit
218 return 0 unless $self->found();
219 return 1 if $self->found() eq 'W';
220 return 1 if $self->found() eq 'T';
225 Returns true if hold is a waiting hold
232 my $found = $self->found;
233 return $found && $found eq 'W';
238 Returns true if hold is a in_transit hold
245 return 0 unless $self->found();
246 return $self->found() eq 'T';
249 =head3 is_cancelable_from_opac
251 Returns true if hold is a cancelable hold
253 Holds may be only canceled if they are not found.
255 This is used from the OPAC.
259 sub is_cancelable_from_opac
{
262 return 1 unless $self->is_found();
263 return 0; # if ->is_in_transit or if ->is_waiting
266 =head3 is_at_destination
268 Returns true if hold is waiting
269 and the hold's pickup branch matches
270 the hold item's holding branch
274 sub is_at_destination
{
277 return $self->is_waiting() && ( $self->branchcode() eq $self->item()->holdingbranch() );
282 Returns the related Koha::Biblio object for this hold
289 $self->{_biblio
} ||= Koha
::Biblios
->find( $self->biblionumber() );
291 return $self->{_biblio
};
296 Returns the related Koha::Item object for this Hold
303 $self->{_item
} ||= Koha
::Items
->find( $self->itemnumber() );
305 return $self->{_item
};
310 Returns the related Koha::Library object for this Hold
317 $self->{_branch
} ||= Koha
::Libraries
->find( $self->branchcode() );
319 return $self->{_branch
};
324 Returns the related Koha::Patron object for this Hold
328 # FIXME Should be renamed with ->patron
332 $self->{_borrower
} ||= Koha
::Patrons
->find( $self->borrowernumber() );
334 return $self->{_borrower
};
339 my $bool = $hold->is_suspended();
346 return $self->suspend();
352 my $cancel_hold = $hold->cancel();
355 - The hold will be moved to the old_reserves table with a priority=0
356 - The priority of other holds will be updated
357 - The patron will be charge (see ExpireReservesMaxPickUpDelayCharge) if the charge_cancel_fee parameter is set
358 - a CANCEL HOLDS log will be done if the pref HoldsLog is on
363 my ( $self, $params ) = @_;
364 $self->_result->result_source->schema->txn_do(
366 $self->cancellationdate( dt_from_string
->strftime( '%Y-%m-%d %H:%M:%S' ) );
369 $self->SUPER::delete(); # Do not add a DELETE log
371 # now fix the priority on the others....
372 C4
::Reserves
::_FixPriority
({ biblionumber
=> $self->biblionumber });
374 # and, if desired, charge a cancel fee
375 my $charge = C4
::Context
->preference("ExpireReservesMaxPickUpDelayCharge");
376 if ( $charge && $params->{'charge_cancel_fee'} ) {
378 Koha
::Account
->new( { patron_id
=> $self->borrowernumber } );
382 user_id
=> C4
::Context
->userenv ? C4
::Context
->userenv->{'number'} : undef,
383 interface
=> C4
::Context
->interface,
384 library_id
=> C4
::Context
->userenv ? C4
::Context
->userenv->{'branch'} : undef,
385 type
=> 'RESERVE_EXPIRED',
386 item_id
=> $self->itemnumber
391 C4
::Log
::logaction
( 'HOLDS', 'CANCEL', $self->reserve_id, Dumper
($self->unblessed) )
392 if C4
::Context
->preference('HoldsLog');
400 my $is_moved = $hold->_move_to_old;
402 Move a hold to the old_reserve table following the same pattern as Koha::Patron->move_to_deleted
408 my $hold_infos = $self->unblessed;
409 return Koha
::Old
::Hold
->new( $hold_infos )->store;
412 =head3 to_api_mapping
414 This method returns the mapping for representing a Koha::Hold object
421 reserve_id
=> 'hold_id',
422 borrowernumber
=> 'patron_id',
423 reservedate
=> 'hold_date',
424 biblionumber
=> 'biblio_id',
425 branchcode
=> 'pickup_library_id',
426 notificationdate
=> undef,
427 reminderdate
=> undef,
428 cancellationdate
=> 'cancellation_date',
429 reservenotes
=> 'notes',
431 itemnumber
=> 'item_id',
432 waitingdate
=> 'waiting_date',
433 expirationdate
=> 'expiration_date',
434 lowestPriority
=> 'lowest_priority',
435 suspend
=> 'suspended',
436 suspend_until
=> 'suspended_until',
437 itemtype
=> 'item_type',
438 item_level_hold
=> 'item_level',
442 =head2 Internal methods
454 Kyle M Hall <kyle@bywatersolutions.com>
455 Jonathan Druart <jonathan.druart@bugs.koha-community.org>
456 Martin Renvoize <martin.renvoize@ptfs-europe.com>