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] [-s|--send-notices] [-d|--digest] [-b|--digest-per-branch] [-v|--verbose]
29 # Once every day for digest messages
30 0 3 * * * automatic_renewals.pl -c -d
31 # Three times a day for non digest messages
32 0 0,8,16 * * * automatic_renewals.pl -c
36 This script searches for issues scheduled for automatic renewal
37 (issues.auto_renew). If there are still renews left (Renewals allowed)
38 and the renewal isn't premature (No Renewal before) the issue is renewed.
44 =item B<-s|--send-notices>
46 DEPRECATED: The system preference AutoRenewalNotices should be used to determine
47 whether notices are sent or not
48 Send AUTO_RENEWALS notices to patrons if the auto renewal has been done.
52 Print report to standard out.
56 Without this parameter no changes will be made
58 =item B<-b|--digest-per-branch>
60 Flag to indicate that generation of message digests should be
61 performed separately for each branch.
63 A patron could potentially have loans at several different branches
64 There is no natural branch to set as the sender on the aggregated
65 message in this situation so the default behavior is to use the
66 borrowers home branch. This could surprise to the borrower when
67 message sender is a library where they have not borrowed anything.
69 Enabling this flag ensures that the issuing library is the sender of
70 the digested message. It has no effect unless the borrower has
71 chosen 'Digests only' on the advance messages.
81 use Koha::Script -cron;
90 my ( $help, $send_notices, $verbose, $confirm, $digest_per_branch );
93 's|send-notices' => \$send_notices,
94 'v|verbose' => \$verbose,
95 'c|confirm' => \$confirm,
96 'b|digest-per-branch' => \$digest_per_branch,
99 pod2usage(0) if $help;
101 my $send_notices_pref = C4::Context->preference('AutoRenewalNotices');
102 if ( $send_notices_pref eq 'cron' ) {
105 The "AutoRenewalNotices" syspref is set to 'Follow the cron switch'.
106 The send_notices switch for this script is deprecated, you should either set the preference
107 to 'Never send emails' or 'Follow patron messaging preferences'
111 # If not following cron then:
112 # - we should not send if set to never
113 # - we will send any notice generated according to preferences if following those
114 $send_notices = $send_notices_pref eq 'never' ? 0 : 1;
117 # Since advance notice options are not visible in the web-interface
118 # unless EnhancedMessagingPreferences is on, let the user know that
119 # this script probably isn't going to do much
120 if ( ! C4::Context->preference('EnhancedMessagingPreferences') ) {
123 The "EnhancedMessagingPreferences" syspref is off.
124 Therefore, it is unlikely that this script will actually produce any messages to be sent.
125 To change this, edit the "EnhancedMessagingPreferences" syspref.
132 $verbose = 1 unless $verbose or $confirm;
133 print "Test run only\n" unless $confirm;
135 print "getting auto renewals\n" if $verbose;
136 my $auto_renews = Koha::Checkouts->search({ auto_renew => 1, 'borrower.autorenew_checkouts' => 1 },{ join => 'borrower'});
137 print "found " . $auto_renews->count . " auto renewals\n" if $verbose;
139 my $renew_digest = {};
141 while ( my $auto_renew = $auto_renews->next ) {
142 print "examining item '" . $auto_renew->itemnumber . "' to auto renew\n" if $verbose;
144 my ( $borrower_preferences, $wants_email, $wants_digest ) = ( undef, 0, 0 );
145 if ( $send_notices_pref eq 'preferences' ){
146 $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences(
148 borrowernumber => $auto_renew->borrowernumber,
149 message_name => 'auto_renewals'
153 if $borrower_preferences
154 && $borrower_preferences->{transports}
155 && $borrower_preferences->{transports}->{email};
158 && $borrower_preferences->{wants_digest};
159 } else { # Preference is never or cron
160 $wants_email = $send_notices;
164 # CanBookBeRenewed returns 'auto_renew' when the renewal should be done by this script
165 my ( $ok, $error ) = CanBookBeRenewed( $auto_renew->borrowernumber, $auto_renew->itemnumber, undef, 1 );
167 if ( $error eq 'auto_renew' ) {
170 say sprintf "Issue id: %s for borrower: %s and item: %s %s be renewed.",
171 $auto_renew->issue_id, $auto_renew->borrowernumber, $auto_renew->itemnumber, $confirm ? 'will' : 'would';
174 my $date_due = AddRenewal( $auto_renew->borrowernumber, $auto_renew->itemnumber, $auto_renew->branchcode, undef, undef, undef, 0 );
175 $auto_renew->auto_renew_error(undef)->store;
177 push @{ $report{ $auto_renew->borrowernumber } }, $auto_renew
178 if ( $wants_email ) && !$wants_digest;
179 } elsif ( $error eq 'too_many'
180 or $error eq 'on_reserve'
181 or $error eq 'restriction'
182 or $error eq 'overdue'
183 or $error eq 'too_unseen'
184 or $error eq 'auto_account_expired'
185 or $error eq 'auto_too_late'
186 or $error eq 'auto_too_much_oweing'
187 or $error eq 'auto_too_soon'
188 or $error eq 'item_denied_renewal' ) {
190 say sprintf "Issue id: %s for borrower: %s and item: %s %s not be renewed. (%s)",
191 $auto_renew->issue_id, $auto_renew->borrowernumber, $auto_renew->itemnumber, $confirm ? 'will' : 'would', $error;
193 $updated = 1 if (!$auto_renew->auto_renew_error || $error ne $auto_renew->auto_renew_error);
195 $auto_renew->auto_renew_error($error)->store if $confirm;
196 push @{ $report{ $auto_renew->borrowernumber } }, $auto_renew
197 if $error ne 'auto_too_soon' && ( $wants_email && !$wants_digest ); # Do not notify if it's too soon
201 if ( $wants_digest ) {
202 # cache this one to process after we've run through all of the items.
203 if ($digest_per_branch) {
204 $renew_digest->{ $auto_renew->branchcode }->{ $auto_renew->borrowernumber }->{success}++ if $error eq 'auto_renew';
205 $renew_digest->{ $auto_renew->branchcode }->{ $auto_renew->borrowernumber }->{error}++ unless $error eq 'auto_renew';
206 push @{$renew_digest->{ $auto_renew->branchcode }->{ $auto_renew->borrowernumber }->{issues}}, $auto_renew->itemnumber;
207 $renew_digest->{ $auto_renew->branchcode }->{ $auto_renew->borrowernumber }->{updated} = 1 if $updated && $error ne 'auto_too_soon';
209 $renew_digest->{ $auto_renew->borrowernumber }->{success} ++ if $error eq 'auto_renew';
210 $renew_digest->{ $auto_renew->borrowernumber }->{error}++ unless $error eq 'auto_renew';
211 $renew_digest->{ $auto_renew->borrowernumber }->{updated} = 1 if $updated && $error ne 'auto_too_soon';
212 push @{$renew_digest->{ $auto_renew->borrowernumber }->{issues}}, $auto_renew->itemnumber;
218 if ( $send_notices && $confirm ) {
219 for my $borrowernumber ( keys %report ) {
220 my $patron = Koha::Patrons->find($borrowernumber);
221 for my $issue ( @{ $report{$borrowernumber} } ) {
222 my $item = Koha::Items->find( $issue->itemnumber );
223 my $letter = C4::Letters::GetPreparedLetter(
224 module => 'circulation',
225 letter_code => 'AUTO_RENEWALS',
227 borrowers => $patron->borrowernumber,
228 issues => $issue->itemnumber,
229 items => $issue->itemnumber,
230 biblio => $item->biblionumber,
232 lang => $patron->lang,
235 my $library = Koha::Libraries->find( $patron->branchcode );
236 my $admin_email_address = $library->from_email_address;
238 C4::Letters::EnqueueLetter(
240 borrowernumber => $borrowernumber,
241 message_transport_type => 'email',
242 from_address => $admin_email_address,
248 if ($digest_per_branch) {
249 while (my ($branchcode, $digests) = each %$renew_digest) {
252 branchcode => $branchcode,
253 letter_code => 'AUTO_RENEWALS_DGST',
258 digests => $renew_digest,
259 letter_code => 'AUTO_RENEWALS_DGST',
273 Enqueue digested letters.
281 Reference to the array of digested messages.
283 =item C<$letter_code>
285 String that denote the letter code.
294 PATRON: while ( my ( $borrowernumber, $digest ) = each %{$params->{digests}} ) {
295 next unless defined $digest->{updated} && $digest->{updated} == 1;
296 my $borrower_preferences =
297 C4::Members::Messaging::GetMessagingPreferences(
299 borrowernumber => $borrowernumber,
300 message_name => 'auto_renewals'
304 next PATRON unless $borrower_preferences; # how could this happen?
306 my $patron = Koha::Patrons->find( $borrowernumber );
308 if ( defined $params->{branchcode} ) {
309 $branchcode = $params->{branchcode};
311 $branchcode = $patron->branchcode;
313 my $library = Koha::Libraries->find( $branchcode );
314 my $from_address = $library->from_email_address;
316 foreach my $transport ( keys %{ $borrower_preferences->{'transports'} } ) {
317 my $letter = C4::Letters::GetPreparedLetter (
318 module => 'circulation',
319 letter_code => $params->{letter_code},
320 branchcode => $branchcode,
321 lang => $patron->lang,
323 error => $digest->{error}||0,
324 success => $digest->{success}||0,
326 loops => { issues => \@{$digest->{issues}} },
328 borrowers => $patron->borrowernumber,
330 message_transport_type => $transport,
331 ) || warn "no letter of type '$params->{letter_code}' found for borrowernumber $borrowernumber. Please see sample_notices.sql";
335 C4::Letters::EnqueueLetter({
337 borrowernumber => $borrowernumber,
338 from_address => $from_address,
339 message_transport_type => $transport