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" };
56 use C4::Members::Messaging;
63 advance_notices.pl - prepare messages to be sent to patrons for nearly due, or due, items
68 [ -n ][ -m <number of days> ][ --itemscontent <comma separated field list> ][ -c ]
76 Print a brief help message and exits.
80 Prints the manual page and exits.
84 Verbose. Without this flag set, only fatal errors are reported.
88 Do not send any email. Advanced or due notices that would have been sent to
89 the patrons are printed to standard out.
93 Defines the maximum number of days in advance to send advance notices.
97 Confirm flag: Add this option. The script will only print a usage
100 =item B<--itemscontent>
102 comma separated list of fields that get substituted into templates in
103 places of the E<lt>E<lt>items.contentE<gt>E<gt> placeholder. This
104 defaults to due date,title,author,barcode
106 Other possible values come from fields in the biblios, items and
113 This script is designed to alert patrons when items are due, or coming due
117 This script pays attention to the advanced notice configuration
118 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
119 section of Koha is available in the Koha manual.
121 =head2 Outgoing emails
123 Typically, messages are prepared for each patron with due
124 items, and who have selected (or the library has elected for them) Advance or Due notices.
126 These emails are staged in the outgoing message queue, as are messages
127 produced by other features of Koha. This message queue must be
128 processed regularly by the
129 F<misc/cronjobs/process_message_queue.pl> program.
131 In the event that the C<-n> flag is passed to this program, no emails
132 are sent. Instead, messages are sent on standard output from this
133 program. They may be redirected to a file if desired.
137 Templates can contain variables enclosed in double angle brackets like
138 E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
139 specific to the overdue items or relevant patron. Available variables
144 =item E<lt>E<lt>items.contentE<gt>E<gt>
146 one line for each item, each line containing a tab separated list of
147 title, author, barcode, issuedate
149 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
151 any field from the borrowers table
153 =item E<lt>E<lt>branches.*E<gt>E<gt>
155 any field from the branches table
161 The F<misc/cronjobs/overdue_notices.pl> program allows you to send
162 messages to patrons when their messages are overdue.
165 # These are defaults for command line options.
166 my $confirm; # -c: Confirm that the user has read and configured this script.
167 my $nomail; # -n: No mail. Will not send any emails.
168 my $mindays = 0; # -m: Maximum number of days in advance to send notices
169 my $maxdays = 30; # -e: the End of the time period
170 my $verbose = 0; # -v: verbose
171 my $itemscontent = join(',',qw( date_due title author barcode ));
183 'itemscontent=s' => \$itemscontent,
185 pod2usage(1) if $help;
186 pod2usage( -verbose => 2 ) if $man;;
188 # Since advance notice options are not visible in the web-interface
189 # unless EnhancedMessagingPreferences is on, let the user know that
190 # this script probably isn't going to do much
191 if ( ! C4::Context->preference('EnhancedMessagingPreferences') ) {
194 The "EnhancedMessagingPreferences" syspref is off.
195 Therefore, it is unlikely that this script will actually produce any messages to be sent.
196 To change this, edit the "EnhancedMessagingPreferences" syspref.
206 # The fields that will be substituted into <<items.content>>
207 my @item_content_fields = split(/,/,$itemscontent);
209 warn 'getting upcoming due issues' if $verbose;
210 my $upcoming_dues = C4::Circulation::GetUpcomingDueIssues( { days_in_advance => $maxdays } );
211 warn 'found ' . scalar( @$upcoming_dues ) . ' issues' if $verbose;
213 # hash of borrowernumber to number of items upcoming
214 # for patrons wishing digests only.
218 my $dbh = C4::Context->dbh();
219 my $sth = $dbh->prepare(<<'END_SQL');
220 SELECT biblio.*, items.*, issues.*
221 FROM issues,items,biblio
222 WHERE items.itemnumber=issues.itemnumber
223 AND biblio.biblionumber=items.biblionumber
224 AND issues.borrowernumber = ?
225 AND issues.itemnumber = ?
226 AND (TO_DAYS(date_due)-TO_DAYS(NOW()) = ?)
229 my $admin_adress = C4::Context->preference('KohaAdminEmailAddress');
232 UPCOMINGITEM: foreach my $upcoming ( @$upcoming_dues ) {
234 warn 'examining ' . $upcoming->{'itemnumber'} . ' upcoming due items' if $verbose;
236 my $from_address = $upcoming->{branchemail} || $admin_adress;
238 my $borrower_preferences;
239 if ( 0 == $upcoming->{'days_until_due'} ) {
240 # This item is due today. Send an 'item due' message.
241 $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $upcoming->{'borrowernumber'},
242 message_name => 'item_due' } );
243 next unless $borrower_preferences;
245 if ( $borrower_preferences->{'wants_digest'} ) {
246 # cache this one to process after we've run through all of the items.
247 $due_digest->{ $upcoming->{borrowernumber} }->{email} = $from_address;
248 $due_digest->{ $upcoming->{borrowernumber} }->{count}++;
250 my $biblio = C4::Biblio::GetBiblioFromItemNumber( $upcoming->{'itemnumber'} );
251 my $letter_type = 'DUE';
252 $sth->execute($upcoming->{'borrowernumber'},$upcoming->{'itemnumber'},'0');
254 while ( my $item_info = $sth->fetchrow_hashref()) {
255 my @item_info = map { $_ =~ /^date|date$/ ? format_date($item_info->{$_}) : $item_info->{$_} || '' } @item_content_fields;
256 $titles .= join("\t",@item_info) . "\n";
259 ## Get branch info for borrowers home library.
260 foreach my $transport ( keys %{$borrower_preferences->{'transports'}} ) {
261 my $letter = parse_letter( { letter_code => $letter_type,
262 borrowernumber => $upcoming->{'borrowernumber'},
263 branchcode => $upcoming->{'branchcode'},
264 biblionumber => $biblio->{'biblionumber'},
265 itemnumber => $upcoming->{'itemnumber'},
266 substitute => { 'items.content' => $titles },
267 message_transport_type => $transport,
269 or warn "no letter of type '$letter_type' found. Please see sample_notices.sql";
270 push @letters, $letter if $letter;
274 $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $upcoming->{'borrowernumber'},
275 message_name => 'advance_notice' } );
276 next UPCOMINGITEM unless $borrower_preferences && exists $borrower_preferences->{'days_in_advance'};
277 next UPCOMINGITEM unless $borrower_preferences->{'days_in_advance'} == $upcoming->{'days_until_due'};
279 if ( $borrower_preferences->{'wants_digest'} ) {
280 # cache this one to process after we've run through all of the items.
281 $upcoming_digest->{ $upcoming->{borrowernumber} }->{email} = $from_address;
282 $upcoming_digest->{ $upcoming->{borrowernumber} }->{count}++;
284 my $biblio = C4::Biblio::GetBiblioFromItemNumber( $upcoming->{'itemnumber'} );
285 my $letter_type = 'PREDUE';
286 $sth->execute($upcoming->{'borrowernumber'},$upcoming->{'itemnumber'},$borrower_preferences->{'days_in_advance'});
288 while ( my $item_info = $sth->fetchrow_hashref()) {
289 my @item_info = map { $_ =~ /^date|date$/ ? format_date($item_info->{$_}) : $item_info->{$_} || '' } @item_content_fields;
290 $titles .= join("\t",@item_info) . "\n";
293 ## Get branch info for borrowers home library.
294 foreach my $transport ( keys %{$borrower_preferences->{'transports'}} ) {
295 my $letter = parse_letter( { letter_code => $letter_type,
296 borrowernumber => $upcoming->{'borrowernumber'},
297 branchcode => $upcoming->{'branchcode'},
298 biblionumber => $biblio->{'biblionumber'},
299 itemnumber => $upcoming->{'itemnumber'},
300 substitute => { 'items.content' => $titles },
301 message_transport_type => $transport,
303 or warn "no letter of type '$letter_type' found. Please see sample_notices.sql";
304 push @letters, $letter if $letter;
309 # If we have prepared a letter, send it.
312 for my $letter ( @letters ) {
314 print $letter->{'content'};
318 for my $letter ( @letters ) {
319 C4::Letters::EnqueueLetter( { letter => $letter,
320 borrowernumber => $upcoming->{'borrowernumber'},
321 from_address => $from_address,
322 message_transport_type => $letter->{message_transport_type} } );
330 # Now, run through all the people that want digests and send them
332 $sth = $dbh->prepare(<<'END_SQL');
333 SELECT biblio.*, items.*, issues.*
334 FROM issues,items,biblio
335 WHERE items.itemnumber=issues.itemnumber
336 AND biblio.biblionumber=items.biblionumber
337 AND issues.borrowernumber = ?
338 AND (TO_DAYS(date_due)-TO_DAYS(NOW()) = ?)
340 PATRON: while ( my ( $borrowernumber, $digest ) = each %$upcoming_digest ) {
342 my $count = $digest->{count};
343 my $from_address = $digest->{email};
345 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $borrowernumber,
346 message_name => 'advance_notice' } );
347 next PATRON unless $borrower_preferences; # how could this happen?
350 my $letter_type = 'PREDUEDGST';
352 $sth->execute($borrowernumber,$borrower_preferences->{'days_in_advance'});
354 while ( my $item_info = $sth->fetchrow_hashref()) {
355 my @item_info = map { $_ =~ /^date|date$/ ? format_date($item_info->{$_}) : $item_info->{$_} || '' } @item_content_fields;
356 $titles .= join("\t",@item_info) . "\n";
359 ## Get branch info for borrowers home library.
360 my %branch_info = get_branch_info( $borrowernumber );
362 foreach my $transport ( keys %{ $borrower_preferences->{'transports'} } ) {
363 my $letter = parse_letter(
365 letter_code => $letter_type,
366 borrowernumber => $borrowernumber,
369 'items.content' => $titles,
372 branchcode => $branch_info{"branches.branchcode"},
373 message_transport_type => $transport,
376 or warn "no letter of type '$letter_type' found. Please see sample_notices.sql";
377 push @letters, $letter if $letter;
382 for my $letter ( @letters ) {
384 print $letter->{'content'};
388 for my $letter ( @letters ) {
389 C4::Letters::EnqueueLetter( { letter => $letter,
390 borrowernumber => $borrowernumber,
391 from_address => $from_address,
392 message_transport_type => $letter->{message_transport_type} } );
398 # Now, run through all the people that want digests and send them
399 PATRON: while ( my ( $borrowernumber, $digest ) = each %$due_digest ) {
401 my $count = $digest->{count};
402 my $from_address = $digest->{email};
404 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $borrowernumber,
405 message_name => 'item_due' } );
406 next PATRON unless $borrower_preferences; # how could this happen?
408 my $letter_type = 'DUEDGST';
409 $sth->execute($borrowernumber,'0');
411 while ( my $item_info = $sth->fetchrow_hashref()) {
412 my @item_info = map { $_ =~ /^date|date$/ ? format_date($item_info->{$_}) : $item_info->{$_} || '' } @item_content_fields;
413 $titles .= join("\t",@item_info) . "\n";
416 ## Get branch info for borrowers home library.
417 my %branch_info = get_branch_info( $borrowernumber );
419 for my $transport ( keys %{ $borrower_preferences->{'transports'} } ) {
420 my $letter = parse_letter(
422 letter_code => $letter_type,
423 borrowernumber => $borrowernumber,
426 'items.content' => $titles,
429 branchcode => $branch_info{"branches.branchcode"},
430 message_transport_type => $transport,
433 or warn "no letter of type '$letter_type' found. Please see sample_notices.sql";
434 push @letters, $letter if $letter;
439 for my $letter ( @letters ) {
441 print $letter->{'content'};
445 for my $letter ( @letters ) {
446 C4::Letters::EnqueueLetter( { letter => $letter,
447 borrowernumber => $borrowernumber,
448 from_address => $from_address,
449 message_transport_type => $letter->{message_transport_type} } );
464 foreach my $required ( qw( letter_code borrowernumber ) ) {
465 return unless exists $params->{$required};
468 my %table_params = ( 'borrowers' => $params->{'borrowernumber'} );
470 if ( my $p = $params->{'branchcode'} ) {
471 $table_params{'branches'} = $p;
473 if ( my $p = $params->{'itemnumber'} ) {
474 $table_params{'issues'} = $p;
475 $table_params{'items'} = $p;
477 if ( my $p = $params->{'biblionumber'} ) {
478 $table_params{'biblio'} = $p;
479 $table_params{'biblioitems'} = $p;
482 return C4::Letters::GetPreparedLetter (
483 module => 'circulation',
484 letter_code => $params->{'letter_code'},
485 branchcode => $table_params{'branches'},
486 substitute => $params->{'substitute'},
487 tables => \%table_params,
488 message_transport_type => $params->{message_transport_type},
493 my $date_string = shift;
494 my $dt=dt_from_string($date_string);
495 return output_pref($dt);
498 =head2 get_branch_info
502 sub get_branch_info {
503 my ( $borrowernumber ) = @_;
505 ## Get branch info for borrowers home library.
506 my $borrower_details = C4::Members::GetMember( borrowernumber => $borrowernumber );
507 my $borrower_branchcode = $borrower_details->{'branchcode'};
508 my $branch = C4::Branch::GetBranchDetail( $borrower_branchcode );
510 foreach my $key( keys %$branch ) {
511 $branch_info{"branches.$key"} = $branch->{$key};