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.
132 This script is designed to alert patrons when items are due, or coming due
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.
140 =head2 Outgoing emails
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.
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.
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.
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
163 =item E<lt>E<lt>items.contentE<gt>E<gt>
165 one line for each item, each line containing a tab separated list of
166 date due, title, author, barcode
168 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
170 any field from the borrowers table
172 =item E<lt>E<lt>branches.*E<gt>E<gt>
174 any field from the branches table
180 The F<misc/cronjobs/overdue_notices.pl> program allows you to send
181 messages to patrons when their messages are overdue.
185 binmode( STDOUT, ':encoding(UTF-8)' );
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 ));
206 'digest-per-branch' => \$digest_per_branch,
207 'itemscontent=s' => \$itemscontent,
209 pod2usage(1) if $help;
210 pod2usage( -verbose => 2 ) if $man;
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') ) {
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.
229 # The fields that will be substituted into <<items.content>>
230 my @item_content_fields = split(/,/,$itemscontent);
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;
236 # hash of borrowernumber to number of items upcoming
237 # for patrons wishing digests only.
238 my $upcoming_digest = {};
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()) = ?)
252 my $admin_adress = C4::Context->preference('KohaAdminEmailAddress');
255 UPCOMINGITEM: foreach my $upcoming ( @$upcoming_dues ) {
257 warn 'examining ' . $upcoming->{'itemnumber'} . ' upcoming due items' if $verbose;
259 my $from_address = $upcoming->{branchemail} || $admin_adress;
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;
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}++;
274 $due_digest->{ $upcoming->{borrowernumber} }->{email} = $from_address;
275 $due_digest->{ $upcoming->{borrowernumber} }->{count}++;
278 my $item = Koha::Items->find( $upcoming->{itemnumber} );
279 my $letter_type = 'DUE';
280 $sth->execute($upcoming->{'borrowernumber'},$upcoming->{'itemnumber'},'0');
282 while ( my $item_info = $sth->fetchrow_hashref()) {
283 $titles .= C4::Letters::get_item_content( { item => $item_info, item_content_fields => \@item_content_fields } );
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,
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;
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'};
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}++;
312 $upcoming_digest->{ $upcoming->{borrowernumber} }->{email} = $from_address;
313 $upcoming_digest->{ $upcoming->{borrowernumber} }->{count}++;
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'});
320 while ( my $item_info = $sth->fetchrow_hashref()) {
321 $titles .= C4::Letters::get_item_content( { item => $item_info, item_content_fields => \@item_content_fields } );
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,
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;
340 # If we have prepared a letter, send it.
343 for my $letter ( @letters ) {
345 print $letter->{'content'};
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} } );
361 # Now, run through all the people that want digests and send them
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()) = ?)
372 if ($digest_per_branch) {
373 while (my ($branchcode, $digests) = each %$upcoming_digest) {
377 letter_code => 'PREDUEDGST',
378 branchcode => $branchcode,
379 get_item_info => sub {
381 $params->{sth}->execute($params->{borrowernumber},
382 $params->{borrower_preferences}->{'days_in_advance'});
384 $params->{sth}->fetchrow_hashref;
390 while (my ($branchcode, $digests) = each %$due_digest) {
393 digests => $due_digest,
394 letter_code => 'DUEDGST',
395 branchcode => $branchcode,
396 get_item_info => sub {
398 $params->{sth}->execute($params->{borrowernumber}, 0);
400 $params->{sth}->fetchrow_hashref;
408 digests => $upcoming_digest,
409 letter_code => 'PREDUEDGST',
410 get_item_info => sub {
412 $params->{sth}->execute($params->{borrowernumber},
413 $params->{borrower_preferences}->{'days_in_advance'});
415 $params->{sth}->fetchrow_hashref;
422 digests => $due_digest,
423 letter_code => 'DUEDGST',
424 get_item_info => sub {
426 $params->{sth}->execute($params->{borrowernumber}, 0);
428 $params->{sth}->fetchrow_hashref;
443 foreach my $required ( qw( letter_code borrowernumber ) ) {
444 return unless exists $params->{$required};
446 my $patron = Koha::Patrons->find( $params->{borrowernumber} );
448 my %table_params = ( 'borrowers' => $params->{'borrowernumber'} );
450 if ( my $p = $params->{'branchcode'} ) {
451 $table_params{'branches'} = $p;
453 if ( my $p = $params->{'itemnumber'} ) {
454 $table_params{'issues'} = $p;
455 $table_params{'items'} = $p;
457 if ( my $p = $params->{'biblionumber'} ) {
458 $table_params{'biblio'} = $p;
459 $table_params{'biblioitems'} = $p;
462 return C4::Letters::GetPreparedLetter (
463 module => 'circulation',
464 letter_code => $params->{'letter_code'},
465 branchcode => $table_params{'branches'},
466 lang => $patron->lang,
467 substitute => $params->{'substitute'},
468 tables => \%table_params,
469 message_transport_type => $params->{message_transport_type},
473 =head2 get_branch_info
477 sub get_branch_info {
478 my ( $borrowernumber ) = @_;
480 ## Get branch info for borrowers home library.
481 my $patron = Koha::Patrons->find( $borrowernumber );
482 my $branch = $patron->library->unblessed;
484 foreach my $key( keys %$branch ) {
485 $branch_info{"branches.$key"} = $branch->{$key};
497 get_item_info => ...,
500 Enqueue digested letters (or print them if -n was passed at command line).
508 Reference to the array of digested messages.
512 Prepared statement handle for fetching overdue issues.
514 =item C<$letter_code>
516 String that denote the letter code.
518 =item C<$get_item_info>
520 Subroutine for executing prepared statement. Takes parameters $sth,
521 $borrowernumber and $borrower_parameters and return a generator
522 function that produce the matching rows.
531 PATRON: while ( my ( $borrowernumber, $digest ) = each %{$params->{digests}} ) {
533 my $count = $digest->{count};
534 my $from_address = $digest->{email};
539 if (defined($params->{branchcode})) {
541 $branchcode = $params->{branchcode};
543 ## Get branch info for borrowers home library.
544 %branch_info = get_branch_info( $borrowernumber );
545 $branchcode = $branch_info{'branches.branchcode'};
548 my $borrower_preferences =
549 C4::Members::Messaging::GetMessagingPreferences(
551 borrowernumber => $borrowernumber,
552 message_name => 'advance_notice'
556 next PATRON unless $borrower_preferences; # how could this happen?
558 my $next_item_info = $params->{get_item_info}->({
559 sth => $params->{sth},
560 borrowernumber => $borrowernumber,
561 borrower_preferences => $borrower_preferences
564 while ( my $item_info = $next_item_info->()) {
565 $titles .= C4::Letters::get_item_content( { item => $item_info, item_content_fields => \@item_content_fields } );
568 foreach my $transport ( keys %{ $borrower_preferences->{'transports'} } ) {
569 my $letter = parse_letter(
571 letter_code => $params->{letter_code},
572 borrowernumber => $borrowernumber,
575 'items.content' => $titles,
578 branchcode => $branchcode,
579 message_transport_type => $transport
581 ) || warn "no letter of type '$params->{letter_type}' found for borrowernumber $borrowernumber. Please see sample_notices.sql";
582 push @letters, $letter if $letter;
587 for my $letter ( @letters ) {
589 print $letter->{'content'};
593 for my $letter ( @letters ) {
594 C4::Letters::EnqueueLetter( { letter => $letter,
595 borrowernumber => $borrowernumber,
596 from_address => $from_address,
597 message_transport_type => $letter->{message_transport_type} } );