Koha/Hold.pm

   1 package Koha::Hold;
   2
   3 # Copyright ByWater Solutions 2014
   4 # Copyright 2017 Koha Development team
   5 #
   6 # This file is part of Koha.
   7 #
   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.
  12 #
  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.
  17 #
  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>.
  20
  21 use Modern::Perl;
  22
  23 use Carp;
  24 use Data::Dumper qw(Dumper);
  25 use List::MoreUtils qw(any);
  26
  27 use C4::Context qw(preference);
  28 use C4::Letters;
  29 use C4::Log;
  30
  31 use Koha::AuthorisedValues;
  32 use Koha::DateUtils qw(dt_from_string output_pref);
  33 use Koha::Patrons;
  34 use Koha::Biblios;
  35 use Koha::Items;
  36 use Koha::Libraries;
  37 use Koha::Old::Holds;
  38 use Koha::Calendar;
  39
  40 use Koha::Exceptions::Hold;
  41
  42 use base qw(Koha::Object);
  43
  44 =head1 NAME
  45
  46 Koha::Hold - Koha Hold object class
  47
  48 =head1 API
  49
  50 =head2 Class Methods
  51
  52 =cut
  53
  54 =head3 age
  55
  56 returns the number of days since a hold was placed, optionally
  57 using the calendar
  58
  59 my $age = $hold->age( $use_calendar );
  60
  61 =cut
  62
  63 sub age {
  64     my ( $self, $use_calendar ) = @_;
  65
  66     my $today = dt_from_string;
  67     my $age;
  68
  69     if ( $use_calendar ) {
  70         my $calendar = Koha::Calendar->new( branchcode => $self->branchcode );
  71         $age = $calendar->days_between( dt_from_string( $self->reservedate ), $today );
  72     }
  73     else {
  74         $age = $today->delta_days( dt_from_string( $self->reservedate ) );
  75     }
  76
  77     $age = $age->in_units( 'days' );
  78
  79     return $age;
  80 }
  81
  82 =head3 suspend_hold
  83
  84 my $hold = $hold->suspend_hold( $suspend_until_dt );
  85
  86 =cut
  87
  88 sub suspend_hold {
  89     my ( $self, $dt ) = @_;
  90
  91     my $date = $dt ? $dt->clone()->truncate( to => 'day' )->datetime : undef;
  92
  93     if ( $self->is_found ) {    # We can't suspend found holds
  94         if ( $self->is_waiting ) {
  95             Koha::Exceptions::Hold::CannotSuspendFound->throw( status => 'W' );
  96         }
  97         elsif ( $self->is_in_transit ) {
  98             Koha::Exceptions::Hold::CannotSuspendFound->throw( status => 'T' );
  99         }
 100         elsif ( $self->is_in_processing ) {
 101             Koha::Exceptions::Hold::CannotSuspendFound->throw( status => 'P' );
 102         }
 103         else {
 104             Koha::Exceptions::Hold::CannotSuspendFound->throw(
 105                       'Unhandled data exception on found hold (id='
 106                     . $self->id
 107                     . ', found='
 108                     . $self->found
 109                     . ')' );
 110         }
 111     }
 112
 113     $self->suspend(1);
 114     $self->suspend_until($date);
 115     $self->store();
 116
 117     logaction( 'HOLDS', 'SUSPEND', $self->reserve_id, Dumper( $self->unblessed ) )
 118         if C4::Context->preference('HoldsLog');
 119
 120     return $self;
 121 }
 122
 123 =head3 resume
 124
 125 my $hold = $hold->resume();
 126
 127 =cut
 128
 129 sub resume {
 130     my ( $self ) = @_;
 131
 132     $self->suspend(0);
 133     $self->suspend_until( undef );
 134
 135     $self->store();
 136
 137     logaction( 'HOLDS', 'RESUME', $self->reserve_id, Dumper($self->unblessed) )
 138         if C4::Context->preference('HoldsLog');
 139
 140     return $self;
 141 }
 142
 143 =head3 delete
 144
 145 $hold->delete();
 146
 147 =cut
 148
 149 sub delete {
 150     my ( $self ) = @_;
 151
 152     my $deleted = $self->SUPER::delete($self);
 153
 154     logaction( 'HOLDS', 'DELETE', $self->reserve_id, Dumper($self->unblessed) )
 155         if C4::Context->preference('HoldsLog');
 156
 157     return $deleted;
 158 }
 159
 160 =head3 set_transfer
 161
 162 =cut
 163
 164 sub set_transfer {
 165     my ( $self ) = @_;
 166
 167     $self->priority(0);
 168     $self->found('T');
 169     $self->store();
 170
 171     return $self;
 172 }
 173
 174 =head3 set_waiting
 175
 176 =cut
 177
 178 sub set_waiting {
 179     my ( $self, $desk_id ) = @_;
 180
 181     $self->priority(0);
 182
 183     my $today = dt_from_string();
 184     my $values = {
 185         found => 'W',
 186         waitingdate => $today->ymd,
 187         desk_id => $desk_id,
 188     };
 189
 190     my $requested_expiration;
 191     if ($self->expirationdate) {
 192         $requested_expiration = dt_from_string($self->expirationdate);
 193     }
 194
 195     my $max_pickup_delay = C4::Context->preference("ReservesMaxPickUpDelay");
 196     my $cancel_on_holidays = C4::Context->preference('ExpireReservesOnHolidays');
 197
 198     my $expirationdate = $today->clone;
 199     $expirationdate->add(days => $max_pickup_delay);
 200
 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(
 204             {
 205                 categorycode => $self->borrower->categorycode,
 206                 itemtype     => $itemtype,
 207                 branchcode   => $self->branchcode,
 208             }
 209         );
 210         my $calendar = Koha::Calendar->new( branchcode => $self->branchcode, days_mode => $daysmode );
 211
 212         $expirationdate = $calendar->days_forward( dt_from_string(), $max_pickup_delay );
 213     }
 214
 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;
 219
 220     $self->set($values)->store();
 221
 222     return $self;
 223 }
 224
 225 =head3 set_pickup_location
 226
 227     $hold->set_pickup_location({ library_id => $library->id });
 228
 229 Updates the hold pickup location. It throws a I<Koha::Exceptions::Hold::InvalidPickupLocation> if
 230 the passed pickup location is not valid.
 231
 232 =cut
 233
 234 sub set_pickup_location {
 235     my ( $self, $params ) = @_;
 236
 237     Koha::Exceptions::MissingParameter->throw('The library_id parameter is mandatory')
 238         unless $params->{library_id};
 239
 240     my @pickup_locations;
 241
 242     if ( $self->itemnumber ) { # item-level
 243         @pickup_locations = $self->item->pickup_locations({ patron => $self->patron });
 244     }
 245     else { # biblio-level
 246         @pickup_locations = $self->biblio->pickup_locations({ patron => $self->patron });
 247     }
 248
 249     if ( any { $_->branchcode eq $params->{library_id} } @pickup_locations ) {
 250         # all good, set the new pickup location
 251         $self->branchcode( $params->{library_id} )->store;
 252     }
 253     else {
 254         Koha::Exceptions::Hold::InvalidPickupLocation->throw;
 255     }
 256
 257     return $self;
 258 }
 259
 260 =head3 set_processing
 261
 262 $hold->set_processing;
 263
 264 Mark the hold as in processing.
 265
 266 =cut
 267
 268 sub set_processing {
 269     my ( $self ) = @_;
 270
 271     $self->priority(0);
 272     $self->found('P');
 273     $self->store();
 274
 275     return $self;
 276 }
 277
 278 =head3 is_found
 279
 280 Returns true if hold is waiting, in transit or in processing
 281
 282 =cut
 283
 284 sub is_found {
 285     my ($self) = @_;
 286
 287     return 0 unless $self->found();
 288     return 1 if $self->found() eq 'W';
 289     return 1 if $self->found() eq 'T';
 290     return 1 if $self->found() eq 'P';
 291 }
 292
 293 =head3 is_waiting
 294
 295 Returns true if hold is a waiting hold
 296
 297 =cut
 298
 299 sub is_waiting {
 300     my ($self) = @_;
 301
 302     my $found = $self->found;
 303     return $found && $found eq 'W';
 304 }
 305
 306 =head3 is_in_transit
 307
 308 Returns true if hold is a in_transit hold
 309
 310 =cut
 311
 312 sub is_in_transit {
 313     my ($self) = @_;
 314
 315     return 0 unless $self->found();
 316     return $self->found() eq 'T';
 317 }
 318
 319 =head3 is_in_processing
 320
 321 Returns true if hold is a in_processing hold
 322
 323 =cut
 324
 325 sub is_in_processing {
 326     my ($self) = @_;
 327
 328     return 0 unless $self->found();
 329     return $self->found() eq 'P';
 330 }
 331
 332 =head3 is_cancelable_from_opac
 333
 334 Returns true if hold is a cancelable hold
 335
 336 Holds may be only canceled if they are not found.
 337
 338 This is used from the OPAC.
 339
 340 =cut
 341
 342 sub is_cancelable_from_opac {
 343     my ($self) = @_;
 344
 345     return 1 unless $self->is_found();
 346     return 0; # if ->is_in_transit or if ->is_waiting or ->is_in_processing
 347 }
 348
 349 =head3 is_at_destination
 350
 351 Returns true if hold is waiting
 352 and the hold's pickup branch matches
 353 the hold item's holding branch
 354
 355 =cut
 356
 357 sub is_at_destination {
 358     my ($self) = @_;
 359
 360     return $self->is_waiting() && ( $self->branchcode() eq $self->item()->holdingbranch() );
 361 }
 362
 363 =head3 biblio
 364
 365 Returns the related Koha::Biblio object for this hold
 366
 367 =cut
 368
 369 sub biblio {
 370     my ($self) = @_;
 371
 372     $self->{_biblio} ||= Koha::Biblios->find( $self->biblionumber() );
 373
 374     return $self->{_biblio};
 375 }
 376
 377 =head3 patron
 378
 379 Returns the related Koha::Patron object for this hold
 380
 381 =cut
 382
 383 sub patron {
 384     my ($self) = @_;
 385
 386     my $patron_rs = $self->_result->patron;
 387     return Koha::Patron->_new_from_dbic($patron_rs);
 388 }
 389
 390 =head3 item
 391
 392 Returns the related Koha::Item object for this Hold
 393
 394 =cut
 395
 396 sub item {
 397     my ($self) = @_;
 398
 399     $self->{_item} ||= Koha::Items->find( $self->itemnumber() );
 400
 401     return $self->{_item};
 402 }
 403
 404 =head3 branch
 405
 406 Returns the related Koha::Library object for this Hold
 407
 408 =cut
 409
 410 sub branch {
 411     my ($self) = @_;
 412
 413     $self->{_branch} ||= Koha::Libraries->find( $self->branchcode() );
 414
 415     return $self->{_branch};
 416 }
 417
 418 =head3 desk
 419
 420 Returns the related Koha::Desk object for this Hold
 421
 422 =cut
 423
 424 sub desk {
 425     my $self = shift;
 426     my $desk_rs = $self->_result->desk;
 427     return unless $desk_rs;
 428     return Koha::Desk->_new_from_dbic($desk_rs);
 429 }
 430
 431 =head3 borrower
 432
 433 Returns the related Koha::Patron object for this Hold
 434
 435 =cut
 436
 437 # FIXME Should be renamed with ->patron
 438 sub borrower {
 439     my ($self) = @_;
 440
 441     $self->{_borrower} ||= Koha::Patrons->find( $self->borrowernumber() );
 442
 443     return $self->{_borrower};
 444 }
 445
 446 =head3 is_suspended
 447
 448 my $bool = $hold->is_suspended();
 449
 450 =cut
 451
 452 sub is_suspended {
 453     my ( $self ) = @_;
 454
 455     return $self->suspend();
 456 }
 457
 458
 459 =head3 cancel
 460
 461 my $cancel_hold = $hold->cancel(
 462     {
 463         [ charge_cancel_fee => 1||0, ]
 464         [ cancellation_reason => $cancellation_reason, ]
 465     }
 466 );
 467
 468 Cancel a hold:
 469 - The hold will be moved to the old_reserves table with a priority=0
 470 - The priority of other holds will be updated
 471 - The patron will be charge (see ExpireReservesMaxPickUpDelayCharge) if the charge_cancel_fee parameter is set
 472 - The canceled hold will have the cancellation reason added to old_reserves.cancellation_reason if one is passed in
 473 - a CANCEL HOLDS log will be done if the pref HoldsLog is on
 474
 475 =cut
 476
 477 sub cancel {
 478     my ( $self, $params ) = @_;
 479     $self->_result->result_source->schema->txn_do(
 480         sub {
 481             $self->cancellationdate( dt_from_string->strftime( '%Y-%m-%d %H:%M:%S' ) );
 482             $self->priority(0);
 483             $self->cancellation_reason( $params->{cancellation_reason} );
 484             $self->store();
 485
 486             if ( $params->{cancellation_reason} ) {
 487                 my $letter = C4::Letters::GetPreparedLetter(
 488                     module                 => 'reserves',
 489                     letter_code            => 'HOLD_CANCELLATION',
 490                     message_transport_type => 'email',
 491                     branchcode             => $self->borrower->branchcode,
 492                     lang                   => $self->borrower->lang,
 493                     tables => {
 494                         branches    => $self->borrower->branchcode,
 495                         borrowers   => $self->borrowernumber,
 496                         items       => $self->itemnumber,
 497                         biblio      => $self->biblionumber,
 498                         biblioitems => $self->biblionumber,
 499                         reserves    => $self->unblessed,
 500                     }
 501                 );
 502
 503                 if ($letter) {
 504                     C4::Letters::EnqueueLetter(
 505                         {
 506                             letter                   => $letter,
 507                             borrowernumber         => $self->borrowernumber,
 508                             message_transport_type => 'email',
 509                         }
 510                     );
 511                 }
 512             }
 513
 514             $self->_move_to_old;
 515             $self->SUPER::delete(); # Do not add a DELETE log
 516
 517             # now fix the priority on the others....
 518             C4::Reserves::_FixPriority({ biblionumber => $self->biblionumber });
 519
 520             # and, if desired, charge a cancel fee
 521             my $charge = C4::Context->preference("ExpireReservesMaxPickUpDelayCharge");
 522             if ( $charge && $params->{'charge_cancel_fee'} ) {
 523                 my $account =
 524                   Koha::Account->new( { patron_id => $self->borrowernumber } );
 525                 $account->add_debit(
 526                     {
 527                         amount     => $charge,
 528                         user_id    => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
 529                         interface  => C4::Context->interface,
 530                         library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
 531                         type       => 'RESERVE_EXPIRED',
 532                         item_id    => $self->itemnumber
 533                     }
 534                 );
 535             }
 536
 537             C4::Log::logaction( 'HOLDS', 'CANCEL', $self->reserve_id, Dumper($self->unblessed) )
 538                 if C4::Context->preference('HoldsLog');
 539         }
 540     );
 541     return $self;
 542 }
 543
 544 =head3 _move_to_old
 545
 546 my $is_moved = $hold->_move_to_old;
 547
 548 Move a hold to the old_reserve table following the same pattern as Koha::Patron->move_to_deleted
 549
 550 =cut
 551
 552 sub _move_to_old {
 553     my ($self) = @_;
 554     my $hold_infos = $self->unblessed;
 555     return Koha::Old::Hold->new( $hold_infos )->store;
 556 }
 557
 558 =head3 to_api_mapping
 559
 560 This method returns the mapping for representing a Koha::Hold object
 561 on the API.
 562
 563 =cut
 564
 565 sub to_api_mapping {
 566     return {
 567         reserve_id       => 'hold_id',
 568         borrowernumber   => 'patron_id',
 569         reservedate      => 'hold_date',
 570         biblionumber     => 'biblio_id',
 571         branchcode       => 'pickup_library_id',
 572         notificationdate => undef,
 573         reminderdate     => undef,
 574         cancellationdate => 'cancellation_date',
 575         reservenotes     => 'notes',
 576         found            => 'status',
 577         itemnumber       => 'item_id',
 578         waitingdate      => 'waiting_date',
 579         expirationdate   => 'expiration_date',
 580         lowestPriority   => 'lowest_priority',
 581         suspend          => 'suspended',
 582         suspend_until    => 'suspended_until',
 583         itemtype         => 'item_type',
 584         item_level_hold  => 'item_level',
 585     };
 586 }
 587
 588 =head2 Internal methods
 589
 590 =head3 _type
 591
 592 =cut
 593
 594 sub _type {
 595     return 'Reserve';
 596 }
 597
 598 =head1 AUTHORS
 599
 600 Kyle M Hall <kyle@bywatersolutions.com>
 601 Jonathan Druart <jonathan.druart@bugs.koha-community.org>
 602 Martin Renvoize <martin.renvoize@ptfs-europe.com>
 603
 604 =cut
 605
 606 1;