3 # Copyright 2008 Liblime
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 # find Koha's Perl modules
26 # test carefully before changing this
28 eval { require "$FindBin::Bin/../kohalib.pl" };
34 use Locale::Currency::Format 1.28;
38 use C4::Dates qw/format_date/;
41 use C4::Overdues qw(GetFine);
45 overdue_notices.pl - prepare messages to be sent to patrons for overdue items
49 overdue_notices.pl [ -n ] [ -library <branchcode> ] [ -library <branchcode>...] [ -max <number of days> ] [ -csv [ <filename> ] ] [ -itemscontent <field list> ]
52 -help brief help message
53 -man full documentation
54 -n No email will be sent
55 -max <days> maximum days overdue to deal with
56 -library <branchname> only deal with overdues from this library (repeatable : several libraries can be given)
57 -csv <filename> populate CSV file
58 -html <filename> Output html to file
59 -itemscontent <list of fields> item information in templates
60 -borcat <categorycode> category code that must be included
61 -borcatout <categorycode> category code that must be excluded
69 Print a brief help message and exits.
73 Prints the manual page and exits.
77 Verbose. Without this flag set, only fatal errors are reported.
81 Do not send any email. Overdue notices that would have been sent to
82 the patrons or to the admin are printed to standard out. CSV data (if
83 the -csv flag is set) is written to standard out or to any csv
88 Items older than max days are assumed to be handled somewhere else,
89 probably the F<longoverdues.pl> script. They are therefore ignored by
90 this program. No notices are sent for them, and they are not added to
91 any CSV files. Defaults to 90 to match F<longoverdues.pl>.
95 select overdues for one specific library. Use the value in the
96 branches.branchcode table. This option can be repeated in order
97 to select overdues for a group of libraries.
101 Produces CSV data. if -n (no mail) flag is set, then this CSV data is
102 sent to standard out or to a filename if provided. Otherwise, only
103 overdues that could not be emailed are sent in CSV format to the admin.
107 Produces html data. if patron does not have a mail address or
108 -n (no mail) flag is set, an html file is generated in the specified
109 directory. This can be downloaded or futher processed by library staff.
111 =item B<-itemscontent>
113 comma separated list of fields that get substituted into templates in
114 places of the E<lt>E<lt>items.contentE<gt>E<gt> placeholder. This
115 defaults to issuedate,title,barcode,author
117 Other possible values come from fields in the biblios, items, and
122 Repetable field, that permit to select only few of patrons categories.
126 Repetable field, permis to exclude some patrons categories.
128 =item B<-t> | B<--triggered>
130 This option causes a notice to be generated if and only if
131 an item is overdue by the number of days defined in a notice trigger.
133 By default, a notice is sent each time the script runs, which is suitable for
134 less frequent run cron script, but requires syncing notice triggers with
135 the cron schedule to ensure proper behavior.
136 Add the --triggered option for daily cron, at the risk of no notice
137 being generated if the cron fails to run on time.
141 Default items.content lists only those items that fall in the
142 range of the currently processing notice.
143 Choose list-all to include all overdue items in the list (limited by B<-max> setting).
149 This script is designed to alert patrons and administrators of overdue
154 This script pays attention to the overdue notice configuration
155 performed in the "Overdue notice/status triggers" section of the
156 "Tools" area of the staff interface to Koha. There, you can choose
157 which letter templates are sent out after a configurable number of
158 days to patrons of each library. More information about the use of this
159 section of Koha is available in the Koha manual.
161 The templates used to craft the emails are defined in the "Tools:
162 Notices" section of the staff interface to Koha.
164 =head2 Outgoing emails
166 Typically, messages are prepared for each patron with overdue
167 items. Messages for whom there is no email address on file are
168 collected and sent as attachments in a single email to each library
169 administrator, or if that is not set, then to the email address in the
170 C<KohaAdminEmailAddress> system preference.
172 These emails are staged in the outgoing message queue, as are messages
173 produced by other features of Koha. This message queue must be
174 processed regularly by the
175 F<misc/cronjobs/process_message_queue.pl> program.
177 In the event that the C<-n> flag is passed to this program, no emails
178 are sent. Instead, messages are sent on standard output from this
179 program. They may be redirected to a file if desired.
183 Templates can contain variables enclosed in double angle brackets like
184 E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
185 specific to the overdue items or relevant patron. Available variables
190 =item E<lt>E<lt>bibE<gt>E<gt>
192 the name of the library
194 =item E<lt>E<lt>items.contentE<gt>E<gt>
196 one line for each item, each line containing a tab separated list of
197 title, author, barcode, issuedate
199 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
201 any field from the borrowers table
203 =item E<lt>E<lt>branches.*E<gt>E<gt>
205 any field from the branches table
211 The C<-csv> command line option lets you specify a file to which
212 overdues data should be output in CSV format.
214 With the C<-n> flag set, data about all overdues is written to the
215 file. Without that flag, only information about overdues that were
216 unable to be sent directly to the patrons will be written. In other
217 words, this CSV file replaces the data that is typically sent to the
218 administrator email address.
220 =head1 USAGE EXAMPLES
222 C<overdue_notices.pl> - In this most basic usage, with no command line
223 arguments, all libraries are procesed individually, and notices are
224 prepared for all patrons with overdue items for whom we have email
225 addresses. Messages for those patrons for whom we have no email
226 address are sent in a single attachment to the library administrator's
227 email address, or to the address in the KohaAdminEmailAddress system
230 C<overdue_notices.pl -n -csv /tmp/overdues.csv> - sends no email and
231 populates F</tmp/overdues.csv> with information about all overdue
234 C<overdue_notices.pl -library MAIN max 14> - prepare notices of
235 overdues in the last 2 weeks for the MAIN library.
239 The F<misc/cronjobs/advance_notices.pl> program allows you to send
240 messages to patrons in advance of thier items becoming due, or to
241 alert them of items that have just become due.
245 # These variables are set by command line options.
246 # They are initially set to default values.
247 my $dbh = C4::Context->dbh();
253 my @branchcodes; # Branch(es) passed as parameter
258 my $itemscontent = join( ',', qw( issuedate title barcode author itemnumber ) );
268 'library=s' => \@branchcodes,
269 'csv:s' => \$csvfilename, # this optional argument gets '' if not supplied.
270 'html:s' => \$htmlfilename, # this optional argument gets '' if not supplied.
271 'itemscontent=s' => \$itemscontent,
272 'list-all' => \$listall,
273 't|triggered' => \$triggered,
274 'borcat=s' => \@myborcat,
275 'borcatout=s' => \@myborcatout,
277 pod2usage(1) if $help;
278 pod2usage( -verbose => 2 ) if $man;
280 if ( defined $csvfilename && $csvfilename =~ /^-/ ) {
281 warn qq(using "$csvfilename" as filename, that seems odd);
284 my @overduebranches = C4::Overdues::GetBranchcodesWithOverdueRules(); # Branches with overdue rules
285 my @branches; # Branches passed as parameter with overdue rules
286 my $branchcount = scalar(@overduebranches);
288 my $overduebranch_word = scalar @overduebranches > 1 ? 'branches' : 'branch';
289 my $branchcodes_word = scalar @branchcodes > 1 ? 'branches' : 'branch';
291 my $PrintNoticesMaxLines = C4::Context->preference('PrintNoticesMaxLines');
294 $verbose and warn "Found $branchcount $overduebranch_word with first message enabled: " . join( ', ', map { "'$_'" } @overduebranches ), "\n";
296 die 'No branches with active overduerules';
300 $verbose and warn "$branchcodes_word @branchcodes passed on parameter\n";
302 # Getting libraries which have overdue rules
303 my %seen = map { $_ => 1 } @branchcodes;
304 @branches = grep { $seen{$_} } @overduebranches;
307 if (@overduebranches) {
309 my $branch_word = scalar @branches > 1 ? 'branches' : 'branch';
310 $verbose and warn "$branch_word @branches have overdue rules\n";
314 $verbose and warn "No active overduerules for $branchcodes_word '@branchcodes'\n";
315 ( scalar grep { '' eq $_ } @branches )
316 or die "No active overduerules for DEFAULT either!";
317 $verbose and warn "Falling back on default rules for @branchcodes\n";
322 # these are the fields that will be substituted into <<item.content>>
323 my @item_content_fields = split( /,/, $itemscontent );
325 binmode( STDOUT, ":utf8" );
328 our $csv; # the Text::CSV_XS object
329 our $csv_fh; # the filehandle to the CSV file.
330 if ( defined $csvfilename ) {
331 my $sep_char = C4::Context->preference('delimiter') || ',';
332 $csv = Text::CSV_XS->new( { binary => 1 , sep_char => $sep_char } );
333 if ( $csvfilename eq '' ) {
336 open $csv_fh, ">", $csvfilename or die "unable to open $csvfilename: $!";
338 if ( $csv->combine(qw(name surname address1 address2 zipcode city country email itemcount itemsinfo)) ) {
339 print $csv_fh $csv->string, "\n";
341 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
345 @branches = @overduebranches unless @branches;
347 if ( defined $htmlfilename ) {
348 if ( $htmlfilename eq '' ) {
351 my $today = C4::Dates->new();
352 open $html_fh, ">",File::Spec->catdir ($htmlfilename,"notices-".$today->output('iso').".html");
355 print $html_fh "<html>\n";
356 print $html_fh "<head>\n";
357 print $html_fh "<style type='text/css'>\n";
358 print $html_fh "pre {page-break-after: always;}\n";
359 print $html_fh "pre {white-space: pre-wrap;}\n";
360 print $html_fh "pre {white-space: -moz-pre-wrap;}\n";
361 print $html_fh "pre {white-space: -o-pre-wrap;}\n";
362 print $html_fh "pre {word-wrap: break-work;}\n";
363 print $html_fh "</style>\n";
364 print $html_fh "</head>\n";
365 print $html_fh "<body>\n";
368 foreach my $branchcode (@branches) {
370 my $branch_details = C4::Branch::GetBranchDetail($branchcode);
371 my $admin_email_address = $branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
372 my @output_chunks; # may be sent to mail or stdout or csv file.
374 $verbose and warn sprintf "branchcode : '%s' using %s\n", $branchcode, $admin_email_address;
376 my $sth2 = $dbh->prepare( <<'END_SQL' );
377 SELECT biblio.*, items.*, issues.*, TO_DAYS(NOW())-TO_DAYS(date_due) AS days_overdue
378 FROM issues,items,biblio
379 WHERE items.itemnumber=issues.itemnumber
380 AND biblio.biblionumber = items.biblionumber
381 AND issues.borrowernumber = ?
382 AND TO_DAYS(NOW())-TO_DAYS(date_due) BETWEEN ? and ?
385 my $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = ? ";
386 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
387 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
389 my $rqoverduerules = $dbh->prepare($query);
390 $rqoverduerules->execute($branchcode, @myborcat, @myborcatout);
392 # We get default rules is there is no rule for this branch
393 if($rqoverduerules->rows == 0){
394 $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = '' ";
395 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
396 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
398 $rqoverduerules = $dbh->prepare($query);
399 $rqoverduerules->execute(@myborcat, @myborcatout);
402 # my $outfile = 'overdues_' . ( $mybranch || $branchcode || 'default' );
403 while ( my $overdue_rules = $rqoverduerules->fetchrow_hashref ) {
404 PERIOD: foreach my $i ( 1 .. 3 ) {
406 $verbose and warn "branch '$branchcode', pass $i\n";
407 my $mindays = $overdue_rules->{"delay$i"}; # the notice will be sent after mindays days (grace period)
409 $overdue_rules->{ "delay" . ( $i + 1 ) }
410 ? $overdue_rules->{ "delay" . ( $i + 1 ) }
412 ); # issues being more than maxdays late are managed somewhere else. (borrower probably suspended)
414 if ( !$overdue_rules->{"letter$i"} ) {
415 $verbose and warn "No letter$i code for branch '$branchcode'";
419 # $letter->{'content'} is the text of the mail that is sent.
420 # this text contains fields that are replaced by their value. Those fields must be written between brackets
421 # The following fields are available :
422 # itemcount is interpreted here as the number of items in the overdue range defined by the current notice or all overdues < max if(-list-all).
423 # <date> <itemcount> <firstname> <lastname> <address1> <address2> <address3> <city> <postcode>
425 my $borrower_sql = <<'END_SQL';
426 SELECT COUNT(*), issues.borrowernumber, firstname, surname, address, address2, city, zipcode, country, email, MIN(date_due) as longest_issue
427 FROM issues,borrowers,categories
428 WHERE issues.borrowernumber=borrowers.borrowernumber
429 AND borrowers.categorycode=categories.categorycode
431 my @borrower_parameters;
433 $borrower_sql .= ' AND issues.branchcode=? ';
434 push @borrower_parameters, $branchcode;
436 if ( $overdue_rules->{categorycode} ) {
437 $borrower_sql .= ' AND borrowers.categorycode=? ';
438 push @borrower_parameters, $overdue_rules->{categorycode};
440 $borrower_sql .= ' AND categories.overduenoticerequired=1
441 GROUP BY issues.borrowernumber ';
443 $borrower_sql .= ' HAVING TO_DAYS(NOW())-TO_DAYS(longest_issue) = ?';
444 push @borrower_parameters, $mindays;
446 $borrower_sql .= ' HAVING TO_DAYS(NOW())-TO_DAYS(longest_issue) BETWEEN ? and ? ' ;
447 push @borrower_parameters, $mindays, $maxdays;
450 # $sth gets borrower info iff at least one overdue item has triggered the overdue action.
451 my $sth = $dbh->prepare($borrower_sql);
452 $sth->execute(@borrower_parameters);
453 $verbose and warn $borrower_sql . "\n $branchcode | " . $overdue_rules->{'categorycode'} . "\n ($mindays, $maxdays)\nreturns " . $sth->rows . " rows";
455 while ( my ($itemcount, $borrowernumber, $firstname, $lastname,
456 $address1, $address2, $city, $postcode, $country, $email,
457 $longest_issue ) = $sth->fetchrow )
459 $verbose and warn "borrower $firstname, $lastname ($borrowernumber) has $itemcount items triggering level $i.";
461 my $letter = C4::Letters::getletter( 'circulation', $overdue_rules->{"letter$i"} );
464 $verbose and warn "Message '$overdue_rules->{letter$i}' content not found";
466 # might as well skip while PERIOD, no other borrowers are going to work.
467 # FIXME : Does this mean a letter must be defined in order to trigger a debar ?
471 if ( $overdue_rules->{"debarred$i"} ) {
473 #action taken is debarring
474 C4::Members::DebarMember($borrowernumber);
475 $verbose and warn "debarring $borrowernumber $firstname $lastname\n";
477 my @params = ($listall ? ( $borrowernumber , 1 , $MAX ) : ( $borrowernumber, $mindays, $maxdays ));
478 $verbose and warn "STH2 PARAMS: borrowernumber = $borrowernumber, mindays = $mindays, maxdays = $maxdays";
479 $sth2->execute(@params);
485 my $exceededPrintNoticesMaxLines = 0;
486 while ( my $item_info = $sth2->fetchrow_hashref() ) {
487 if ( ( !$email || $nomail ) && $PrintNoticesMaxLines && $i >= $PrintNoticesMaxLines ) {
488 $exceededPrintNoticesMaxLines = 1;
492 my @item_info = map { $_ =~ /^date|date$/ ? format_date( $item_info->{$_} ) : $item_info->{$_} || '' } @item_content_fields;
493 $titles .= join("\t", @item_info) . "\n";
495 push @items, { itemnumber => $item_info->{'itemnumber'}, biblionumber => $item_info->{'biblionumber'} };
498 $letter = parse_letter(
500 borrowernumber => $borrowernumber,
501 branchcode => $branchcode,
503 substitute => { # this appears to be a hack to overcome incomplete features in this code.
504 bib => $branch_details->{'branchname'}, # maybe 'bib' is a typo for 'lib<rary>'?
505 'items.content' => $titles
510 if ( $exceededPrintNoticesMaxLines ) {
511 $letter->{'content'} .= "List too long for form; please check your account online for a complete list of your overdue items.";
514 my @misses = grep { /./ } map { /^([^>]*)[>]+/; ( $1 || '' ); } split /\</, $letter->{'content'};
516 $verbose and warn "The following terms were not matched and replaced: \n\t" . join "\n\t", @misses;
518 $letter->{'content'} =~ s/\<[^<>]*?\>//g; # Now that we've warned about them, remove them.
519 $letter->{'content'} =~ s/\<[^<>]*?\>//g; # 2nd pass for the double nesting.
524 prepare_letter_for_printing(
526 borrowernumber => $borrowernumber,
527 firstname => $firstname,
528 lastname => $lastname,
529 address1 => $address1,
530 address2 => $address2,
532 postcode => $postcode,
534 itemcount => $itemcount,
536 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : '',
541 C4::Letters::EnqueueLetter(
543 borrowernumber => $borrowernumber,
544 message_transport_type => 'email',
545 from_address => $admin_email_address,
550 # If we don't have an email address for this patron, send it to the admin to deal with.
552 prepare_letter_for_printing(
554 borrowernumber => $borrowernumber,
555 firstname => $firstname,
556 lastname => $lastname,
557 address1 => $address1,
558 address2 => $address2,
560 postcode => $postcode,
562 itemcount => $itemcount,
564 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : '',
574 if (@output_chunks) {
575 if ( defined $csvfilename ) {
576 print $csv_fh @output_chunks;
578 elsif ( defined $htmlfilename ) {
579 print $html_fh @output_chunks;
582 local $, = "\f"; # pagebreak
583 print @output_chunks;
586 filename => defined $csvfilename ? 'attachment.csv' : 'attachment.txt',
587 type => 'text/plain',
588 content => join( "\n", @output_chunks )
592 title => 'Overdue Notices',
593 content => 'These messages were not sent directly to the patrons.',
595 C4::Letters::EnqueueLetter(
597 borrowernumber => undef,
598 message_transport_type => 'email',
599 attachments => [$attachment],
600 to_address => $admin_email_address,
607 # note that we're not testing on $csv_fh to prevent closing
612 if ( defined $htmlfilename ) {
613 print $html_fh "</body>\n";
614 print $html_fh "</html>\n";
618 =head1 INTERNAL METHODS
620 These methods are internal to the operation of overdue_notices.pl.
624 parses the letter template, replacing the placeholders with data
625 specific to this patron, biblio, or item
628 letter - required hashref
629 borrowernumber - required integer
630 substitute - optional hashref of other key/value pairs that should
631 be substituted in the letter content
633 returns the C<letter> hashref, with the content updated to reflect the
634 substituted keys and values.
639 sub parse_letter { # FIXME: this code should probably be moved to C4::Letters:parseletter
641 foreach my $required (qw( letter borrowernumber )) {
642 return unless exists $params->{$required};
646 if ( $params->{'substitute'} ) {
647 while ( my ( $key, $replacedby ) = each %{ $params->{'substitute'} } ) {
648 my $replacefield = "<<$key>>";
649 $params->{'letter'}->{title} =~ s/$replacefield/$replacedby/g;
650 $params->{'letter'}->{content} =~ s/$replacefield/$replacedby/g;
654 $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'borrowers', $params->{'borrowernumber'} );
656 if ( $params->{'branchcode'} ) {
657 $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'branches', $params->{'branchcode'} );
660 if ( $params->{'items'} ) {
661 my $item_format = '';
663 while (scalar(@{$params->{'items'}}) > 0) {
664 my $item = shift @{$params->{'items'}};
665 my $fine = GetFine($item->{'itemnumber'}, $params->{'borrowernumber'});
667 $params->{'letter'}->{'content'} =~ m/(<item>.*<\/item>)/;
670 if ($params->{'letter'}->{'content'} =~ m/<fine>(.*)<\/fine>/) { # process any fine tags...
671 my $formatted_fine = currency_format("$1", "$fine", FMT_SYMBOL);
672 $params->{'letter'}->{'content'} =~ s/<fine>.*<\/fine>/$formatted_fine/;
674 $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'biblio', $item->{'biblionumber'} );
675 $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'biblioitems', $item->{'biblionumber'} );
676 $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'items', $item->{'itemnumber'} );
677 $params->{'letter'}->{'content'} =~ s/(<item>.*<\/item>)/$1\n$item_format/ if scalar(@{$params->{'items'}} > 0);
681 $params->{'letter'}->{'content'} =~ s/<\/{0,1}?item>//g; # strip all remaining item tags...
682 return $params->{'letter'};
685 =head2 prepare_letter_for_printing
687 returns a string of text appropriate for printing in the event that an
688 overdue notice will not be sent to the patron's email
689 address. Depending on the desired output format, this may be a CSV
690 string, or a human-readable representation of the notice.
701 sub prepare_letter_for_printing {
704 return unless ref $params eq 'HASH';
706 foreach my $required_parameter (qw( letter borrowernumber )) {
707 return unless defined $params->{$required_parameter};
711 if ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'csv' ) {
713 $params->{'firstname'}, $params->{'lastname'}, $params->{'address1'}, $params->{'address2'}, $params->{'postcode'},
714 $params->{'city'}, $params->{'email'}, $params->{'itemcount'}, $params->{'titles'}
717 return $csv->string, "\n";
719 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
721 } elsif ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'html' ) {
723 $return .= "$params->{'letter'}->{'content'}\n";
724 $return .= "\n</pre>\n";
726 $return .= "$params->{'letter'}->{'content'}\n";
728 # $return .= Data::Dumper->Dump( [ $params->{'borrowernumber'}, $params->{'letter'} ], [qw( borrowernumber letter )] );