3 # This file is part of Koha.
5 # Copyright (C) 2014 Hochschule für Gesundheit (hsg), Germany
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
22 automatic_renewals.pl - cron script to renew loans
26 ./automatic_renewals.pl [-c|--confirm] [--send-notices]
29 0 3 * * * automatic_renewals.pl -c
33 This script searches for issues scheduled for automatic renewal
34 (issues.auto_renew). If there are still renews left (Renewals allowed)
35 and the renewal isn't premature (No Renewal before) the issue is renewed.
41 =item B<--send-notices>
43 Send AUTO_RENEWALS notices to patrons if the auto renewal has been done.
45 Note that this option does not support digest yet.
49 Print report to standard out.
53 Without this parameter no changes will be made
63 use Koha::Script -cron;
72 my ( $help, $send_notices, $verbose, $confirm );
75 'send-notices' => \$send_notices,
76 'v|verbose' => \$verbose,
77 'c|confirm' => \$confirm,
80 pod2usage(0) if $help;
83 my $auto_renews = Koha::Checkouts->search({ auto_renew => 1, 'borrower.autorenew_checkouts' => 1 },{ join => 'borrower'});
86 $verbose = 1 unless $verbose or $confirm;
87 print "Test run only\n" unless $confirm;
88 while ( my $auto_renew = $auto_renews->next ) {
90 # CanBookBeRenewed returns 'auto_renew' when the renewal should be done by this script
91 my ( $ok, $error ) = CanBookBeRenewed( $auto_renew->borrowernumber, $auto_renew->itemnumber, undef, 1 );
92 if ( $error eq 'auto_renew' ) {
94 say sprintf "Issue id: %s for borrower: %s and item: %s ". ( $confirm ? 'will' : 'would') . " be renewed.",
95 $auto_renew->issue_id, $auto_renew->borrowernumber, $auto_renew->itemnumber;
98 my $date_due = AddRenewal( $auto_renew->borrowernumber, $auto_renew->itemnumber, $auto_renew->branchcode, undef, undef, undef, 0 );
99 $auto_renew->auto_renew_error(undef)->store;
101 push @{ $report{ $auto_renew->borrowernumber } }, $auto_renew;
102 } elsif ( $error eq 'too_many'
103 or $error eq 'on_reserve'
104 or $error eq 'restriction'
105 or $error eq 'overdue'
106 or $error eq 'too_unseen'
107 or $error eq 'auto_account_expired'
108 or $error eq 'auto_too_late'
109 or $error eq 'auto_too_much_oweing'
110 or $error eq 'auto_too_soon'
111 or $error eq 'item_denied_renewal' ) {
113 say sprintf "Issue id: %s for borrower: %s and item: %s ". ( $confirm ? 'will' : 'would') . " not be renewed. (%s)",
114 $auto_renew->issue_id, $auto_renew->borrowernumber, $auto_renew->itemnumber, $error;
116 if ( not $auto_renew->auto_renew_error or $error ne $auto_renew->auto_renew_error ) {
117 $auto_renew->auto_renew_error($error)->store if $confirm;
118 push @{ $report{ $auto_renew->borrowernumber } }, $auto_renew
119 if $error ne 'auto_too_soon'; # Do not notify if it's too soon
124 if ( $send_notices ) {
125 for my $borrowernumber ( keys %report ) {
126 my $patron = Koha::Patrons->find($borrowernumber);
127 for my $issue ( @{ $report{$borrowernumber} } ) {
128 my $item = Koha::Items->find( $issue->itemnumber );
129 my $letter = C4::Letters::GetPreparedLetter(
130 module => 'circulation',
131 letter_code => 'AUTO_RENEWALS',
133 borrowers => $patron->borrowernumber,
134 issues => $issue->itemnumber,
135 items => $issue->itemnumber,
136 biblio => $item->biblionumber,
138 lang => $patron->lang,
141 my $library = Koha::Libraries->find( $patron->branchcode );
142 my $admin_email_address = $library->branchemail || C4::Context->preference('KohaAdminEmailAddress');
144 C4::Letters::EnqueueLetter(
146 borrowernumber => $borrowernumber,
147 message_transport_type => 'email',
148 from_address => $admin_email_address,