3 # Copyright 2008 LibLime
5 # This file is part of Koha.
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 advance_notices.pl - cron script to put item due reminders into message queue
26 ./advance_notices.pl -c
29 0 1 * * * advance_notices.pl -c
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
47 # find Koha's Perl modules
48 # test carefully before changing this
50 eval { require "$FindBin::Bin/../kohalib.pl" };
52 use Koha::Script -cron;
57 use C4::Members::Messaging;
67 advance_notices.pl - prepare messages to be sent to patrons for nearly due, or due, items
72 [ -n ][ -m <number of days> ][ --itemscontent <comma separated field list> ][ -c ]
80 Print a brief help message and exits.
84 Prints the manual page and exits.
88 Verbose. Without this flag set, only fatal errors are reported.
92 Do not send any email. Advanced or due notices that would have been sent to
93 the patrons are printed to standard out.
97 Defines the maximum number of days in advance to send advance notices.
101 Confirm flag: Add this option. The script will only print a usage
104 =item B<--itemscontent>
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
110 Other possible values come from fields in the biblios, items and
113 =item B<--digest-per-branch>
115 Flag to indicate that generation of message digests should be
116 performed separately for each branch.
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.
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.
130 select notices for one specific library. Use the value in the
131 branches.branchcode table. This option can be repeated in order
132 to select notices for a group of libraries.
136 Use the address information from the item homebranch library instead of the issuing library.
142 This script is designed to alert patrons when items are due, or coming due
146 This script pays attention to the advanced notice configuration
147 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
148 section of Koha is available in the Koha manual.
150 =head2 Outgoing emails
152 Typically, messages are prepared for each patron with due
153 items, and who have selected (or the library has elected for them) Advance or Due notices.
155 These emails are staged in the outgoing message queue, as are messages
156 produced by other features of Koha. This message queue must be
157 processed regularly by the
158 F<misc/cronjobs/process_message_queue.pl> program.
160 In the event that the C<-n> flag is passed to this program, no emails
161 are sent. Instead, messages are sent on standard output from this
162 program. They may be redirected to a file if desired.
166 Templates can contain variables enclosed in double angle brackets like
167 E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
168 specific to the overdue items or relevant patron. Available variables
173 =item E<lt>E<lt>items.contentE<gt>E<gt>
175 one line for each item, each line containing a tab separated list of
176 date due, title, author, barcode
178 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
180 any field from the borrowers table
182 =item E<lt>E<lt>branches.*E<gt>E<gt>
184 any field from the branches table
190 The F<misc/cronjobs/overdue_notices.pl> program allows you to send
191 messages to patrons when their messages are overdue.
195 binmode( STDOUT, ':encoding(UTF-8)' );
197 # These are defaults for command line options.
198 my $confirm; # -c: Confirm that the user has read and configured this script.
199 my $nomail; # -n: No mail. Will not send any emails.
200 my $mindays = 0; # -m: Maximum number of days in advance to send notices
201 my $maxdays = 30; # -e: the End of the time period
202 my $verbose = 0; # -v: verbose
203 my $digest_per_branch = 0; # -digest-per-branch: Prepare and send digests per branch
204 my @branchcodes; # Branch(es) passed as parameter
205 my $owning_library = 0;
206 my $itemscontent = join(',',qw( date_due title author barcode ));
214 'library=s' => \@branchcodes,
215 'owning' => \$owning_library,
220 'digest-per-branch' => \$digest_per_branch,
221 'itemscontent=s' => \$itemscontent,
223 pod2usage(1) if $help;
224 pod2usage( -verbose => 2 ) if $man;
226 # Since advance notice options are not visible in the web-interface
227 # unless EnhancedMessagingPreferences is on, let the user know that
228 # this script probably isn't going to do much
229 if ( ! C4::Context->preference('EnhancedMessagingPreferences') ) {
232 The "EnhancedMessagingPreferences" syspref is off.
233 Therefore, it is unlikely that this script will actually produce any messages to be sent.
234 To change this, edit the "EnhancedMessagingPreferences" syspref.
245 %branches = map { $_ => 1 } @branchcodes;
248 # The fields that will be substituted into <<items.content>>
249 my @item_content_fields = split(/,/,$itemscontent);
251 warn 'getting upcoming due issues' if $verbose;
252 my $upcoming_dues = C4::Circulation::GetUpcomingDueIssues( {
253 days_in_advance => $maxdays,
254 owning_library => $owning_library
256 warn 'found ' . scalar( @$upcoming_dues ) . ' issues' if $verbose;
258 # hash of borrowernumber to number of items upcoming
259 # for patrons wishing digests only.
260 my $upcoming_digest = {};
263 my $dbh = C4::Context->dbh();
264 my $sth = $dbh->prepare(<<'END_SQL');
265 SELECT biblio.*, items.*, issues.*
266 FROM issues,items,biblio
267 WHERE items.itemnumber=issues.itemnumber
268 AND biblio.biblionumber=items.biblionumber
269 AND issues.borrowernumber = ?
270 AND issues.itemnumber = ?
271 AND (TO_DAYS(date_due)-TO_DAYS(NOW()) = ?)
274 my $admin_adress = C4::Context->preference('KohaAdminEmailAddress');
277 UPCOMINGITEM: foreach my $upcoming ( @$upcoming_dues ) {
279 warn 'examining ' . $upcoming->{'itemnumber'} . ' upcoming due items' if $verbose;
281 my $from_address = $upcoming->{branchemail} || $admin_adress;
283 my $borrower_preferences;
284 if ( 0 == $upcoming->{'days_until_due'} ) {
285 # This item is due today. Send an 'item due' message.
286 $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $upcoming->{'borrowernumber'},
287 message_name => 'item_due' } );
288 next unless $borrower_preferences;
290 if ( $borrower_preferences->{'wants_digest'} ) {
291 # cache this one to process after we've run through all of the items.
292 if ($digest_per_branch) {
293 $due_digest->{ $upcoming->{branchcode} }->{ $upcoming->{borrowernumber} }->{email} = $from_address;
294 $due_digest->{ $upcoming->{branchcode} }->{ $upcoming->{borrowernumber} }->{count}++;
296 $due_digest->{ $upcoming->{borrowernumber} }->{email} = $from_address;
297 $due_digest->{ $upcoming->{borrowernumber} }->{count}++;
301 if($owning_library) {
302 $branchcode = $upcoming->{'homebranch'};
304 $branchcode = $upcoming->{'branchcode'};
306 # Skip this DUE if we specify list of libraries and this one is not part of it
307 next if (@branchcodes && !$branches{$branchcode});
309 my $item = Koha::Items->find( $upcoming->{itemnumber} );
310 my $letter_type = 'DUE';
311 $sth->execute($upcoming->{'borrowernumber'},$upcoming->{'itemnumber'},'0');
313 while ( my $item_info = $sth->fetchrow_hashref()) {
314 $titles .= C4::Letters::get_item_content( { item => $item_info, item_content_fields => \@item_content_fields } );
317 ## Get branch info for borrowers home library.
318 foreach my $transport ( keys %{$borrower_preferences->{'transports'}} ) {
319 my $letter = parse_letter( { letter_code => $letter_type,
320 borrowernumber => $upcoming->{'borrowernumber'},
321 branchcode => $branchcode,
322 biblionumber => $item->biblionumber,
323 itemnumber => $upcoming->{'itemnumber'},
324 substitute => { 'items.content' => $titles },
325 message_transport_type => $transport,
327 or warn "no letter of type '$letter_type' found for borrowernumber ".$upcoming->{'borrowernumber'}.". Please see sample_notices.sql";
328 push @letters, $letter if $letter;
332 $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $upcoming->{'borrowernumber'},
333 message_name => 'advance_notice' } );
334 next UPCOMINGITEM unless $borrower_preferences && exists $borrower_preferences->{'days_in_advance'};
335 next UPCOMINGITEM unless $borrower_preferences->{'days_in_advance'} == $upcoming->{'days_until_due'};
337 if ( $borrower_preferences->{'wants_digest'} ) {
338 # cache this one to process after we've run through all of the items.
339 if ($digest_per_branch) {
340 $upcoming_digest->{ $upcoming->{branchcode} }->{ $upcoming->{borrowernumber} }->{email} = $from_address;
341 $upcoming_digest->{ $upcoming->{branchcode} }->{ $upcoming->{borrowernumber} }->{count}++;
343 $upcoming_digest->{ $upcoming->{borrowernumber} }->{email} = $from_address;
344 $upcoming_digest->{ $upcoming->{borrowernumber} }->{count}++;
348 if($owning_library) {
349 $branchcode = $upcoming->{'homebranch'};
351 $branchcode = $upcoming->{'branchcode'};
353 # Skip this PREDUE if we specify list of libraries and this one is not part of it
354 next if (@branchcodes && !$branches{$branchcode});
356 my $item = Koha::Items->find( $upcoming->{itemnumber} );
357 my $letter_type = 'PREDUE';
358 $sth->execute($upcoming->{'borrowernumber'},$upcoming->{'itemnumber'},$borrower_preferences->{'days_in_advance'});
360 while ( my $item_info = $sth->fetchrow_hashref()) {
361 $titles .= C4::Letters::get_item_content( { item => $item_info, item_content_fields => \@item_content_fields } );
364 ## Get branch info for borrowers home library.
365 foreach my $transport ( keys %{$borrower_preferences->{'transports'}} ) {
366 my $letter = parse_letter( { letter_code => $letter_type,
367 borrowernumber => $upcoming->{'borrowernumber'},
368 branchcode => $branchcode,
369 biblionumber => $item->biblionumber,
370 itemnumber => $upcoming->{'itemnumber'},
371 substitute => { 'items.content' => $titles },
372 message_transport_type => $transport,
374 or warn "no letter of type '$letter_type' found for borrowernumber ".$upcoming->{'borrowernumber'}.". Please see sample_notices.sql";
375 push @letters, $letter if $letter;
380 # If we have prepared a letter, send it.
383 for my $letter ( @letters ) {
385 print $letter->{'content'};
389 for my $letter ( @letters ) {
390 C4::Letters::EnqueueLetter( { letter => $letter,
391 borrowernumber => $upcoming->{'borrowernumber'},
392 from_address => $from_address,
393 message_transport_type => $letter->{message_transport_type} } );
401 # Now, run through all the people that want digests and send them
403 my $sth_digest = $dbh->prepare(<<'END_SQL');
404 SELECT biblio.*, items.*, issues.*
405 FROM issues,items,biblio
406 WHERE items.itemnumber=issues.itemnumber
407 AND biblio.biblionumber=items.biblionumber
408 AND issues.borrowernumber = ?
409 AND (TO_DAYS(date_due)-TO_DAYS(NOW()) = ?)
412 if ($digest_per_branch) {
413 while (my ($branchcode, $digests) = each %$upcoming_digest) {
417 letter_code => 'PREDUEDGST',
418 message_name => 'advance_notice',
419 branchcode => $branchcode,
420 get_item_info => sub {
422 $params->{sth}->execute($params->{borrowernumber},
423 $params->{borrower_preferences}->{'days_in_advance'});
425 $params->{sth}->fetchrow_hashref;
431 while (my ($branchcode, $digests) = each %$due_digest) {
434 digests => $due_digest,
435 letter_code => 'DUEDGST',
436 branchcode => $branchcode,
437 message_name => 'item_due',
438 get_item_info => sub {
440 $params->{sth}->execute($params->{borrowernumber}, 0);
442 $params->{sth}->fetchrow_hashref;
450 digests => $upcoming_digest,
451 letter_code => 'PREDUEDGST',
452 message_name => 'advance_notice',
453 get_item_info => sub {
455 $params->{sth}->execute($params->{borrowernumber},
456 $params->{borrower_preferences}->{'days_in_advance'});
458 $params->{sth}->fetchrow_hashref;
465 digests => $due_digest,
466 letter_code => 'DUEDGST',
467 message_name => 'item_due',
468 get_item_info => sub {
470 $params->{sth}->execute($params->{borrowernumber}, 0);
472 $params->{sth}->fetchrow_hashref;
487 foreach my $required ( qw( letter_code borrowernumber ) ) {
488 return unless exists $params->{$required};
490 my $patron = Koha::Patrons->find( $params->{borrowernumber} );
492 my %table_params = ( 'borrowers' => $params->{'borrowernumber'} );
494 if ( my $p = $params->{'branchcode'} ) {
495 $table_params{'branches'} = $p;
497 if ( my $p = $params->{'itemnumber'} ) {
498 $table_params{'issues'} = $p;
499 $table_params{'items'} = $p;
501 if ( my $p = $params->{'biblionumber'} ) {
502 $table_params{'biblio'} = $p;
503 $table_params{'biblioitems'} = $p;
506 return C4::Letters::GetPreparedLetter (
507 module => 'circulation',
508 letter_code => $params->{'letter_code'},
509 branchcode => $table_params{'branches'},
510 lang => $patron->lang,
511 substitute => $params->{'substitute'},
512 tables => \%table_params,
513 message_transport_type => $params->{message_transport_type},
517 =head2 get_branch_info
521 sub get_branch_info {
522 my ( $borrowernumber ) = @_;
524 ## Get branch info for borrowers home library.
525 my $patron = Koha::Patrons->find( $borrowernumber );
526 my $branch = $patron->library->unblessed;
528 foreach my $key( keys %$branch ) {
529 $branch_info{"branches.$key"} = $branch->{$key};
541 get_item_info => ...,
544 Enqueue digested letters (or print them if -n was passed at command line).
552 Reference to the array of digested messages.
556 Prepared statement handle for fetching overdue issues.
558 =item C<$letter_code>
560 String that denote the letter code.
562 =item C<$get_item_info>
564 Subroutine for executing prepared statement. Takes parameters $sth,
565 $borrowernumber and $borrower_parameters and return a generator
566 function that produce the matching rows.
575 PATRON: while ( my ( $borrowernumber, $digest ) = each %{$params->{digests}} ) {
577 my $count = $digest->{count};
578 my $from_address = $digest->{email};
583 if (defined($params->{branchcode})) {
585 $branchcode = $params->{branchcode};
587 ## Get branch info for borrowers home library.
588 %branch_info = get_branch_info( $borrowernumber );
589 $branchcode = $branch_info{'branches.branchcode'};
592 my $borrower_preferences =
593 C4::Members::Messaging::GetMessagingPreferences(
595 borrowernumber => $borrowernumber,
596 message_name => $params->{message_name}
600 next PATRON unless $borrower_preferences; # how could this happen?
602 my $next_item_info = $params->{get_item_info}->({
603 sth => $params->{sth},
604 borrowernumber => $borrowernumber,
605 borrower_preferences => $borrower_preferences
608 while ( my $item_info = $next_item_info->()) {
609 $titles .= C4::Letters::get_item_content( { item => $item_info, item_content_fields => \@item_content_fields } );
612 foreach my $transport ( keys %{ $borrower_preferences->{'transports'} } ) {
613 my $letter = parse_letter(
615 letter_code => $params->{letter_code},
616 borrowernumber => $borrowernumber,
619 'items.content' => $titles,
622 branchcode => $branchcode,
623 message_transport_type => $transport
627 warn "no letter of type '$params->{letter_type}' found for borrowernumber $borrowernumber. Please see sample_notices.sql";
630 push @letters, $letter if $letter;
635 for my $letter ( @letters ) {
637 print $letter->{'content'};
641 for my $letter ( @letters ) {
642 C4::Letters::EnqueueLetter( { letter => $letter,
643 borrowernumber => $borrowernumber,
644 from_address => $from_address,
645 message_transport_type => $letter->{message_transport_type} } );