Bug 24153: Add the confirm flag to the crontab calls
[koha.git] / misc / cronjobs / advance_notices.pl
1 #!/usr/bin/perl
2
3 # Copyright 2008 LibLime
4 #
5 # This file is part of Koha.
6 #
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.
11 #
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.
16 #
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>.
19
20 =head1 NAME
21
22 advance_notices.pl - cron script to put item due reminders into message queue
23
24 =head1 SYNOPSIS
25
26 ./advance_notices.pl -c
27
28 or, in crontab:
29 0 1 * * * advance_notices.pl -c
30
31 =head1 DESCRIPTION
32
33 This script prepares pre-due and item due reminders to be sent to
34 patrons. It queues them in the message queue, which is processed by
35 the process_message_queue.pl cronjob. The type and timing of the
36 messages can be configured by the patrons in their "My Alerts" tab in
37 the OPAC.
38
39 =cut
40
41 use strict;
42 use warnings;
43 use Getopt::Long;
44 use Pod::Usage;
45 use Data::Dumper;
46 BEGIN {
47     # find Koha's Perl modules
48     # test carefully before changing this
49     use FindBin;
50     eval { require "$FindBin::Bin/../kohalib.pl" };
51 }
52 use Koha::Script -cron;
53 use C4::Biblio;
54 use C4::Context;
55 use C4::Letters;
56 use C4::Members;
57 use C4::Members::Messaging;
58 use C4::Overdues;
59 use Koha::DateUtils;
60 use C4::Log;
61 use Koha::Items;
62 use Koha::Libraries;
63 use Koha::Patrons;
64
65 =head1 NAME
66
67 advance_notices.pl - prepare messages to be sent to patrons for nearly due, or due, items
68
69 =head1 SYNOPSIS
70
71 advance_notices.pl
72   [ -n ][ -m <number of days> ][ --itemscontent <comma separated field list> ][ -c ]
73
74 =head1 OPTIONS
75
76 =over 8
77
78 =item B<--help>
79
80 Print a brief help message and exits.
81
82 =item B<--man>
83
84 Prints the manual page and exits.
85
86 =item B<-v>
87
88 Verbose. Without this flag set, only fatal errors are reported.
89
90 =item B<-n>
91
92 Do not send any email. Advanced or due notices that would have been sent to
93 the patrons are printed to standard out.
94
95 =item B<-m>
96
97 Defines the maximum number of days in advance to send advance notices.
98
99 =item B<-c>
100
101 Confirm flag: Add this option. The script will only print a usage
102 statement otherwise.
103
104 =item B<--itemscontent>
105
106 comma separated list of fields that get substituted into templates in
107 places of the E<lt>E<lt>items.contentE<gt>E<gt> placeholder. This
108 defaults to date_due,title,author,barcode
109
110 Other possible values come from fields in the biblios, items and
111 issues tables.
112
113 =item B<--digest-per-branch>
114
115 Flag to indicate that generation of message digests should be
116 performed separately for each branch.
117
118 A patron could potentially have loans at several different branches
119 There is no natural branch to set as the sender on the aggregated
120 message in this situation so the default behavior is to use the
121 borrowers home branch.  This could surprise to the borrower when
122 message sender is a library where they have not borrowed anything.
123
124 Enabling this flag ensures that the issuing library is the sender of
125 the digested message.  It has no effect unless the borrower has
126 chosen 'Digests only' on the advance messages.
127
128 =back
129
130 =head1 DESCRIPTION
131
132 This script is designed to alert patrons when items are due, or coming due
133
134 =head2 Configuration
135
136 This script pays attention to the advanced notice configuration
137 performed by borrowers in the OPAC, or by staff in the patron detail page of the intranet. The content of the messages is configured in Tools -> Notices and slips. Advanced notices use the PREDUE template, due notices use DUE. More information about the use of this
138 section of Koha is available in the Koha manual.
139
140 =head2 Outgoing emails
141
142 Typically, messages are prepared for each patron with due
143 items, and who have selected (or the library has elected for them) Advance or Due notices.
144
145 These emails are staged in the outgoing message queue, as are messages
146 produced by other features of Koha. This message queue must be
147 processed regularly by the
148 F<misc/cronjobs/process_message_queue.pl> program.
149
150 In the event that the C<-n> flag is passed to this program, no emails
151 are sent. Instead, messages are sent on standard output from this
152 program. They may be redirected to a file if desired.
153
154 =head2 Templates
155
156 Templates can contain variables enclosed in double angle brackets like
157 E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
158 specific to the overdue items or relevant patron. Available variables
159 are:
160
161 =over
162
163 =item E<lt>E<lt>items.contentE<gt>E<gt>
164
165 one line for each item, each line containing a tab separated list of
166 date due, title, author, barcode
167
168 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
169
170 any field from the borrowers table
171
172 =item E<lt>E<lt>branches.*E<gt>E<gt>
173
174 any field from the branches table
175
176 =back
177
178 =head1 SEE ALSO
179
180 The F<misc/cronjobs/overdue_notices.pl> program allows you to send
181 messages to patrons when their messages are overdue.
182
183 =cut
184
185 binmode( STDOUT, ':encoding(UTF-8)' );
186
187 # These are defaults for command line options.
188 my $confirm;                                                        # -c: Confirm that the user has read and configured this script.
189 my $nomail;                                                         # -n: No mail. Will not send any emails.
190 my $mindays     = 0;                                                # -m: Maximum number of days in advance to send notices
191 my $maxdays     = 30;                                               # -e: the End of the time period
192 my $verbose     = 0;                                                # -v: verbose
193 my $digest_per_branch = 0;                                          # -digest-per-branch: Prepare and send digests per branch
194 my $itemscontent = join(',',qw( date_due title author barcode ));
195
196 my $help    = 0;
197 my $man     = 0;
198
199 GetOptions(
200             'help|?'         => \$help,
201             'man'            => \$man,
202             'c'              => \$confirm,
203             'n'              => \$nomail,
204             'm:i'            => \$maxdays,
205             'v'              => \$verbose,
206             'digest-per-branch' => \$digest_per_branch,
207             'itemscontent=s' => \$itemscontent,
208        )or pod2usage(2);
209 pod2usage(1) if $help;
210 pod2usage( -verbose => 2 ) if $man;
211
212 # Since advance notice options are not visible in the web-interface
213 # unless EnhancedMessagingPreferences is on, let the user know that
214 # this script probably isn't going to do much
215 if ( ! C4::Context->preference('EnhancedMessagingPreferences') ) {
216     warn <<'END_WARN';
217
218 The "EnhancedMessagingPreferences" syspref is off.
219 Therefore, it is unlikely that this script will actually produce any messages to be sent.
220 To change this, edit the "EnhancedMessagingPreferences" syspref.
221
222 END_WARN
223 }
224 unless ($confirm) {
225      pod2usage(1);
226 }
227 cronlogaction();
228
229 # The fields that will be substituted into <<items.content>>
230 my @item_content_fields = split(/,/,$itemscontent);
231
232 warn 'getting upcoming due issues' if $verbose;
233 my $upcoming_dues = C4::Circulation::GetUpcomingDueIssues( { days_in_advance => $maxdays } );
234 warn 'found ' . scalar( @$upcoming_dues ) . ' issues' if $verbose;
235
236 # hash of borrowernumber to number of items upcoming
237 # for patrons wishing digests only.
238 my $upcoming_digest = {};
239 my $due_digest = {};
240
241 my $dbh = C4::Context->dbh();
242 my $sth = $dbh->prepare(<<'END_SQL');
243 SELECT biblio.*, items.*, issues.*
244   FROM issues,items,biblio
245   WHERE items.itemnumber=issues.itemnumber
246     AND biblio.biblionumber=items.biblionumber
247     AND issues.borrowernumber = ?
248     AND issues.itemnumber = ?
249     AND (TO_DAYS(date_due)-TO_DAYS(NOW()) = ?)
250 END_SQL
251
252 my $admin_adress = C4::Context->preference('KohaAdminEmailAddress');
253
254 my @letters;
255 UPCOMINGITEM: foreach my $upcoming ( @$upcoming_dues ) {
256     @letters = ();
257     warn 'examining ' . $upcoming->{'itemnumber'} . ' upcoming due items' if $verbose;
258
259     my $from_address = $upcoming->{branchemail} || $admin_adress;
260
261     my $borrower_preferences;
262     if ( 0 == $upcoming->{'days_until_due'} ) {
263         # This item is due today. Send an 'item due' message.
264         $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $upcoming->{'borrowernumber'},
265                                                                                    message_name   => 'item_due' } );
266         next unless $borrower_preferences;
267         
268         if ( $borrower_preferences->{'wants_digest'} ) {
269             # cache this one to process after we've run through all of the items.
270             if ($digest_per_branch) {
271                 $due_digest->{ $upcoming->{branchcode} }->{ $upcoming->{borrowernumber} }->{email} = $from_address;
272                 $due_digest->{ $upcoming->{branchcode} }->{ $upcoming->{borrowernumber} }->{count}++;
273             } else {
274                 $due_digest->{ $upcoming->{borrowernumber} }->{email} = $from_address;
275                 $due_digest->{ $upcoming->{borrowernumber} }->{count}++;
276             }
277         } else {
278             my $item = Koha::Items->find( $upcoming->{itemnumber} );
279             my $letter_type = 'DUE';
280             $sth->execute($upcoming->{'borrowernumber'},$upcoming->{'itemnumber'},'0');
281             my $titles = "";
282             while ( my $item_info = $sth->fetchrow_hashref()) {
283                 $titles .= C4::Letters::get_item_content( { item => $item_info, item_content_fields => \@item_content_fields } );
284             }
285
286             ## Get branch info for borrowers home library.
287             foreach my $transport ( keys %{$borrower_preferences->{'transports'}} ) {
288                 my $letter = parse_letter( { letter_code    => $letter_type,
289                                       borrowernumber => $upcoming->{'borrowernumber'},
290                                       branchcode     => $upcoming->{'branchcode'},
291                                       biblionumber   => $item->biblionumber,
292                                       itemnumber     => $upcoming->{'itemnumber'},
293                                       substitute     => { 'items.content' => $titles },
294                                       message_transport_type => $transport,
295                                     } )
296                     or warn "no letter of type '$letter_type' found for borrowernumber ".$upcoming->{'borrowernumber'}.". Please see sample_notices.sql";
297                 push @letters, $letter if $letter;
298             }
299         }
300     } else {
301         $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $upcoming->{'borrowernumber'},
302                                                                                    message_name   => 'advance_notice' } );
303         next UPCOMINGITEM unless $borrower_preferences && exists $borrower_preferences->{'days_in_advance'};
304         next UPCOMINGITEM unless $borrower_preferences->{'days_in_advance'} == $upcoming->{'days_until_due'};
305
306         if ( $borrower_preferences->{'wants_digest'} ) {
307             # cache this one to process after we've run through all of the items.
308             if ($digest_per_branch) {
309                 $upcoming_digest->{ $upcoming->{branchcode} }->{ $upcoming->{borrowernumber} }->{email} = $from_address;
310                 $upcoming_digest->{ $upcoming->{branchcode} }->{ $upcoming->{borrowernumber} }->{count}++;
311             } else {
312                 $upcoming_digest->{ $upcoming->{borrowernumber} }->{email} = $from_address;
313                 $upcoming_digest->{ $upcoming->{borrowernumber} }->{count}++;
314             }
315         } else {
316             my $item = Koha::Items->find( $upcoming->{itemnumber} );
317             my $letter_type = 'PREDUE';
318             $sth->execute($upcoming->{'borrowernumber'},$upcoming->{'itemnumber'},$borrower_preferences->{'days_in_advance'});
319             my $titles = "";
320             while ( my $item_info = $sth->fetchrow_hashref()) {
321                 $titles .= C4::Letters::get_item_content( { item => $item_info, item_content_fields => \@item_content_fields } );
322             }
323
324             ## Get branch info for borrowers home library.
325             foreach my $transport ( keys %{$borrower_preferences->{'transports'}} ) {
326                 my $letter = parse_letter( { letter_code    => $letter_type,
327                                       borrowernumber => $upcoming->{'borrowernumber'},
328                                       branchcode     => $upcoming->{'branchcode'},
329                                       biblionumber   => $item->biblionumber,
330                                       itemnumber     => $upcoming->{'itemnumber'},
331                                       substitute     => { 'items.content' => $titles },
332                                       message_transport_type => $transport,
333                                     } )
334                     or warn "no letter of type '$letter_type' found for borrowernumber ".$upcoming->{'borrowernumber'}.". Please see sample_notices.sql";
335                 push @letters, $letter if $letter;
336             }
337         }
338     }
339
340     # If we have prepared a letter, send it.
341     if ( @letters ) {
342       if ($nomail) {
343         for my $letter ( @letters ) {
344             local $, = "\f";
345             print $letter->{'content'};
346         }
347       }
348       else {
349         for my $letter ( @letters ) {
350             C4::Letters::EnqueueLetter( { letter                 => $letter,
351                                           borrowernumber         => $upcoming->{'borrowernumber'},
352                                           from_address           => $from_address,
353                                           message_transport_type => $letter->{message_transport_type} } );
354         }
355       }
356     }
357 }
358
359
360
361 # Now, run through all the people that want digests and send them
362
363 my $sth_digest = $dbh->prepare(<<'END_SQL');
364 SELECT biblio.*, items.*, issues.*
365   FROM issues,items,biblio
366   WHERE items.itemnumber=issues.itemnumber
367     AND biblio.biblionumber=items.biblionumber
368     AND issues.borrowernumber = ?
369     AND (TO_DAYS(date_due)-TO_DAYS(NOW()) = ?)
370 END_SQL
371
372 if ($digest_per_branch) {
373     while (my ($branchcode, $digests) = each %$upcoming_digest) {
374         send_digests({
375             sth => $sth_digest,
376             digests => $digests,
377             letter_code => 'PREDUEDGST',
378             message_name => 'advance_notice',
379             branchcode => $branchcode,
380             get_item_info => sub {
381                 my $params = shift;
382                 $params->{sth}->execute($params->{borrowernumber},
383                                         $params->{borrower_preferences}->{'days_in_advance'});
384                 return sub {
385                     $params->{sth}->fetchrow_hashref;
386                 };
387             }
388         });
389     }
390
391     while (my ($branchcode, $digests) = each %$due_digest) {
392         send_digests({
393             sth => $sth_digest,
394             digests => $due_digest,
395             letter_code => 'DUEDGST',
396             branchcode => $branchcode,
397             message_name => 'item_due',
398             get_item_info => sub {
399                 my $params = shift;
400                 $params->{sth}->execute($params->{borrowernumber}, 0);
401                 return sub {
402                     $params->{sth}->fetchrow_hashref;
403                 };
404             }
405         });
406     }
407 } else {
408     send_digests({
409         sth => $sth_digest,
410         digests => $upcoming_digest,
411         letter_code => 'PREDUEDGST',
412         message_name => 'advance_notice',
413         get_item_info => sub {
414             my $params = shift;
415             $params->{sth}->execute($params->{borrowernumber},
416                                     $params->{borrower_preferences}->{'days_in_advance'});
417             return sub {
418                 $params->{sth}->fetchrow_hashref;
419             };
420         }
421     });
422
423     send_digests({
424         sth => $sth_digest,
425         digests => $due_digest,
426         letter_code => 'DUEDGST',
427         message_name => 'item_due',
428         get_item_info => sub {
429             my $params = shift;
430             $params->{sth}->execute($params->{borrowernumber}, 0);
431             return sub {
432                 $params->{sth}->fetchrow_hashref;
433             };
434         }
435     });
436 }
437
438 =head1 METHODS
439
440 =head2 parse_letter
441
442 =cut
443
444 sub parse_letter {
445     my $params = shift;
446
447     foreach my $required ( qw( letter_code borrowernumber ) ) {
448         return unless exists $params->{$required};
449     }
450     my $patron = Koha::Patrons->find( $params->{borrowernumber} );
451
452     my %table_params = ( 'borrowers' => $params->{'borrowernumber'} );
453
454     if ( my $p = $params->{'branchcode'} ) {
455         $table_params{'branches'} = $p;
456     }
457     if ( my $p = $params->{'itemnumber'} ) {
458         $table_params{'issues'} = $p;
459         $table_params{'items'} = $p;
460     }
461     if ( my $p = $params->{'biblionumber'} ) {
462         $table_params{'biblio'} = $p;
463         $table_params{'biblioitems'} = $p;
464     }
465
466     return C4::Letters::GetPreparedLetter (
467         module => 'circulation',
468         letter_code => $params->{'letter_code'},
469         branchcode => $table_params{'branches'},
470         lang => $patron->lang,
471         substitute => $params->{'substitute'},
472         tables     => \%table_params,
473         message_transport_type => $params->{message_transport_type},
474     );
475 }
476
477 =head2 get_branch_info
478
479 =cut
480
481 sub get_branch_info {
482     my ( $borrowernumber ) = @_;
483
484     ## Get branch info for borrowers home library.
485     my $patron = Koha::Patrons->find( $borrowernumber );
486     my $branch = $patron->library->unblessed;
487     my %branch_info;
488     foreach my $key( keys %$branch ) {
489         $branch_info{"branches.$key"} = $branch->{$key};
490     }
491
492     return %branch_info;
493 }
494
495 =head2 send_digests
496
497     send_digests({
498         digests => ...,
499         sth => ...,
500         letter_code => ...,
501         get_item_info => ...,
502     })
503
504 Enqueue digested letters (or print them if -n was passed at command line).
505
506 Parameters:
507
508 =over 4
509
510 =item C<$digests>
511
512 Reference to the array of digested messages.
513
514 =item C<$sth>
515
516 Prepared statement handle for fetching overdue issues.
517
518 =item C<$letter_code>
519
520 String that denote the letter code.
521
522 =item C<$get_item_info>
523
524 Subroutine for executing prepared statement.  Takes parameters $sth,
525 $borrowernumber and $borrower_parameters and return a generator
526 function that produce the matching rows.
527
528 =back
529
530 =cut
531
532 sub send_digests {
533     my $params = shift;
534
535     PATRON: while ( my ( $borrowernumber, $digest ) = each %{$params->{digests}} ) {
536         @letters = ();
537         my $count = $digest->{count};
538         my $from_address = $digest->{email};
539
540         my %branch_info;
541         my $branchcode;
542
543         if (defined($params->{branchcode})) {
544             %branch_info = ();
545             $branchcode = $params->{branchcode};
546         } else {
547             ## Get branch info for borrowers home library.
548             %branch_info = get_branch_info( $borrowernumber );
549             $branchcode = $branch_info{'branches.branchcode'};
550         }
551
552         my $borrower_preferences =
553             C4::Members::Messaging::GetMessagingPreferences(
554                 {
555                     borrowernumber => $borrowernumber,
556                     message_name   => $params->{message_name}
557                 }
558             );
559
560         next PATRON unless $borrower_preferences; # how could this happen?
561
562         my $next_item_info = $params->{get_item_info}->({
563             sth => $params->{sth},
564             borrowernumber => $borrowernumber,
565             borrower_preferences => $borrower_preferences
566         });
567         my $titles = "";
568         while ( my $item_info = $next_item_info->()) {
569             $titles .= C4::Letters::get_item_content( { item => $item_info, item_content_fields => \@item_content_fields } );
570         }
571
572         foreach my $transport ( keys %{ $borrower_preferences->{'transports'} } ) {
573             my $letter = parse_letter(
574                 {
575                     letter_code    => $params->{letter_code},
576                     borrowernumber => $borrowernumber,
577                     substitute     => {
578                         count           => $count,
579                         'items.content' => $titles,
580                         %branch_info
581                     },
582                     branchcode     => $branchcode,
583                     message_transport_type => $transport
584                 }
585             );
586             unless ( $letter ){
587                 warn "no letter of type '$params->{letter_type}' found for borrowernumber $borrowernumber. Please see sample_notices.sql";
588                 next;
589             }
590             push @letters, $letter if $letter;
591         }
592
593         if ( @letters ) {
594             if ($nomail) {
595                 for my $letter ( @letters ) {
596                     local $, = "\f";
597                     print $letter->{'content'};
598                 }
599             }
600             else {
601                 for my $letter ( @letters ) {
602                     C4::Letters::EnqueueLetter( { letter                 => $letter,
603                                                   borrowernumber         => $borrowernumber,
604                                                   from_address           => $from_address,
605                                                   message_transport_type => $letter->{message_transport_type} } );
606                 }
607             }
608         }
609     }
610 }
611
612
613 1;
614
615 __END__