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.
26 # find Koha's Perl modules
27 # test carefully before changing this
29 eval { require "$FindBin::Bin/../kohalib.pl" };
35 use Locale::Currency::Format 1.28;
39 use C4::Dates qw/format_date/;
42 use C4::Overdues qw(GetFine);
46 overdue_notices.pl - prepare messages to be sent to patrons for overdue items
50 overdue_notices.pl [ -n ] [ -library <branchcode> ] [ -library <branchcode>...] [ -max <number of days> ] [ -csv [ <filename> ] ] [ -itemscontent <field list> ]
53 -help brief help message
54 -man full documentation
55 -n No email will be sent
56 -max <days> maximum days overdue to deal with
57 -library <branchname> only deal with overdues from this library (repeatable : several libraries can be given)
58 -csv <filename> populate CSV file
59 -html <filename> Output html to file
60 -itemscontent <list of fields> item information in templates
61 -borcat <categorycode> category code that must be included
62 -borcatout <categorycode> category code that must be excluded
70 Print a brief help message and exits.
74 Prints the manual page and exits.
78 Verbose. Without this flag set, only fatal errors are reported.
82 Do not send any email. Overdue notices that would have been sent to
83 the patrons or to the admin are printed to standard out. CSV data (if
84 the -csv flag is set) is written to standard out or to any csv
89 Items older than max days are assumed to be handled somewhere else,
90 probably the F<longoverdues.pl> script. They are therefore ignored by
91 this program. No notices are sent for them, and they are not added to
92 any CSV files. Defaults to 90 to match F<longoverdues.pl>.
96 select overdues for one specific library. Use the value in the
97 branches.branchcode table. This option can be repeated in order
98 to select overdues for a group of libraries.
102 Produces CSV data. if -n (no mail) flag is set, then this CSV data is
103 sent to standard out or to a filename if provided. Otherwise, only
104 overdues that could not be emailed are sent in CSV format to the admin.
106 =item B<-itemscontent>
108 comma separated list of fields that get substituted into templates in
109 places of the E<lt>E<lt>items.contentE<gt>E<gt> placeholder. This
110 defaults to issuedate,title,barcode,author
112 Other possible values come from fields in the biblios, items, and
117 Repetable field, that permit to select only few of patrons categories.
121 Repetable field, permis to exclude some patrons categories.
123 =item B<-t> | B<--triggered>
125 This option causes a notice to be generated if and only if
126 an item is overdue by the number of days defined in a notice trigger.
128 By default, a notice is sent each time the script runs, which is suitable for
129 less frequent run cron script, but requires syncing notice triggers with
130 the cron schedule to ensure proper behavior.
131 Add the --triggered option for daily cron, at the risk of no notice
132 being generated if the cron fails to run on time.
136 Default items.content lists only those items that fall in the
137 range of the currently processing notice.
138 Choose list-all to include all overdue items in the list (limited by B<-max> setting).
144 This script is designed to alert patrons and administrators of overdue
149 This script pays attention to the overdue notice configuration
150 performed in the "Overdue notice/status triggers" section of the
151 "Tools" area of the staff interface to Koha. There, you can choose
152 which letter templates are sent out after a configurable number of
153 days to patrons of each library. More information about the use of this
154 section of Koha is available in the Koha manual.
156 The templates used to craft the emails are defined in the "Tools:
157 Notices" section of the staff interface to Koha.
159 =head2 Outgoing emails
161 Typically, messages are prepared for each patron with overdue
162 items. Messages for whom there is no email address on file are
163 collected and sent as attachments in a single email to each library
164 administrator, or if that is not set, then to the email address in the
165 C<KohaAdminEmailAddress> system preference.
167 These emails are staged in the outgoing message queue, as are messages
168 produced by other features of Koha. This message queue must be
169 processed regularly by the
170 F<misc/cronjobs/process_message_queue.pl> program.
172 In the event that the C<-n> flag is passed to this program, no emails
173 are sent. Instead, messages are sent on standard output from this
174 program. They may be redirected to a file if desired.
178 Templates can contain variables enclosed in double angle brackets like
179 E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
180 specific to the overdue items or relevant patron. Available variables
185 =item E<lt>E<lt>bibE<gt>E<gt>
187 the name of the library
189 =item E<lt>E<lt>items.contentE<gt>E<gt>
191 one line for each item, each line containing a tab separated list of
192 title, author, barcode, issuedate
194 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
196 any field from the borrowers table
198 =item E<lt>E<lt>branches.*E<gt>E<gt>
200 any field from the branches table
206 The C<-csv> command line option lets you specify a file to which
207 overdues data should be output in CSV format.
209 With the C<-n> flag set, data about all overdues is written to the
210 file. Without that flag, only information about overdues that were
211 unable to be sent directly to the patrons will be written. In other
212 words, this CSV file replaces the data that is typically sent to the
213 administrator email address.
215 =head1 USAGE EXAMPLES
217 C<overdue_notices.pl> - In this most basic usage, with no command line
218 arguments, all libraries are procesed individually, and notices are
219 prepared for all patrons with overdue items for whom we have email
220 addresses. Messages for those patrons for whom we have no email
221 address are sent in a single attachment to the library administrator's
222 email address, or to the address in the KohaAdminEmailAddress system
225 C<overdue_notices.pl -n -csv /tmp/overdues.csv> - sends no email and
226 populates F</tmp/overdues.csv> with information about all overdue
229 C<overdue_notices.pl -library MAIN max 14> - prepare notices of
230 overdues in the last 2 weeks for the MAIN library.
234 The F<misc/cronjobs/advance_notices.pl> program allows you to send
235 messages to patrons in advance of thier items becoming due, or to
236 alert them of items that have just become due.
240 # These variables are set by command line options.
241 # They are initially set to default values.
242 my $dbh = C4::Context->dbh();
248 my @branchcodes; # Branch(es) passed as parameter
253 my $itemscontent = join( ',', qw( issuedate title barcode author biblionumber ) );
263 'library=s' => \@branchcodes,
264 'csv:s' => \$csvfilename, # this optional argument gets '' if not supplied.
265 'html:s' => \$htmlfilename, # this optional argument gets '' if not supplied.
266 'itemscontent=s' => \$itemscontent,
267 'list-all' => \$listall,
268 't|triggered' => \$triggered,
269 'borcat=s' => \@myborcat,
270 'borcatout=s' => \@myborcatout,
272 pod2usage(1) if $help;
273 pod2usage( -verbose => 2 ) if $man;
275 if ( defined $csvfilename && $csvfilename =~ /^-/ ) {
276 warn qq(using "$csvfilename" as filename, that seems odd);
279 my @overduebranches = C4::Overdues::GetBranchcodesWithOverdueRules(); # Branches with overdue rules
280 my @branches; # Branches passed as parameter with overdue rules
281 my $branchcount = scalar(@overduebranches);
283 my $overduebranch_word = scalar @overduebranches > 1 ? 'branches' : 'branch';
284 my $branchcodes_word = scalar @branchcodes > 1 ? 'branches' : 'branch';
286 my $PrintNoticesMaxLines = C4::Context->preference('PrintNoticesMaxLines');
289 $verbose and warn "Found $branchcount $overduebranch_word with first message enabled: " . join( ', ', map { "'$_'" } @overduebranches ), "\n";
291 die 'No branches with active overduerules';
295 $verbose and warn "$branchcodes_word @branchcodes passed on parameter\n";
297 # Getting libraries which have overdue rules
298 my %seen = map { $_ => 1 } @branchcodes;
299 @branches = grep { $seen{$_} } @overduebranches;
302 if (@overduebranches) {
304 my $branch_word = scalar @branches > 1 ? 'branches' : 'branch';
305 $verbose and warn "$branch_word @branches have overdue rules\n";
309 $verbose and warn "No active overduerules for $branchcodes_word '@branchcodes'\n";
310 ( scalar grep { '' eq $_ } @branches )
311 or die "No active overduerules for DEFAULT either!";
312 $verbose and warn "Falling back on default rules for @branchcodes\n";
317 # these are the fields that will be substituted into <<item.content>>
318 my @item_content_fields = split( /,/, $itemscontent );
320 binmode( STDOUT, ":utf8" );
323 our $csv; # the Text::CSV_XS object
324 our $csv_fh; # the filehandle to the CSV file.
325 if ( defined $csvfilename ) {
326 my $sep_char = C4::Context->preference('delimiter') || ',';
327 $csv = Text::CSV_XS->new( { binary => 1 , sep_char => $sep_char } );
328 if ( $csvfilename eq '' ) {
331 open $csv_fh, ">", $csvfilename or die "unable to open $csvfilename: $!";
333 if ( $csv->combine(qw(name surname address1 address2 zipcode city country email itemcount itemsinfo)) ) {
334 print $csv_fh $csv->string, "\n";
336 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
340 @branches = @overduebranches unless @branches;
342 if ( defined $htmlfilename ) {
343 if ( $htmlfilename eq '' ) {
346 my $today = C4::Dates->new();
347 open $html_fh, ">",File::Spec->catdir ($htmlfilename,"notices-".$today->output('iso').".html");
350 print $html_fh "<html>\n";
351 print $html_fh "<head>\n";
352 print $html_fh "<style type='text/css'>\n";
353 print $html_fh "pre {page-break-after: always;}\n";
354 print $html_fh "pre {white-space: pre-wrap;}\n";
355 print $html_fh "pre {white-space: -moz-pre-wrap;}\n";
356 print $html_fh "pre {white-space: -o-pre-wrap;}\n";
357 print $html_fh "pre {word-wrap: break-work;}\n";
358 print $html_fh "</style>\n";
359 print $html_fh "</head>\n";
360 print $html_fh "<body>\n";
363 foreach my $branchcode (@branches) {
365 my $branch_details = C4::Branch::GetBranchDetail($branchcode);
366 my $admin_email_address = $branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
367 my @output_chunks; # may be sent to mail or stdout or csv file.
369 $verbose and warn sprintf "branchcode : '%s' using %s\n", $branchcode, $admin_email_address;
371 my $sth2 = $dbh->prepare( <<'END_SQL' );
372 SELECT biblio.*, items.*, issues.*, TO_DAYS(NOW())-TO_DAYS(date_due) AS days_overdue
373 FROM issues,items,biblio
374 WHERE items.itemnumber=issues.itemnumber
375 AND biblio.biblionumber = items.biblionumber
376 AND issues.borrowernumber = ?
377 AND TO_DAYS(NOW())-TO_DAYS(date_due) BETWEEN ? and ?
380 my $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = ? ";
381 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
382 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
384 my $rqoverduerules = $dbh->prepare($query);
385 $rqoverduerules->execute($branchcode, @myborcat, @myborcatout);
387 # We get default rules is there is no rule for this branch
388 if($rqoverduerules->rows == 0){
389 $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = '' ";
390 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
391 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
393 $rqoverduerules = $dbh->prepare($query);
394 $rqoverduerules->execute(@myborcat, @myborcatout);
397 # my $outfile = 'overdues_' . ( $mybranch || $branchcode || 'default' );
398 while ( my $overdue_rules = $rqoverduerules->fetchrow_hashref ) {
399 PERIOD: foreach my $i ( 1 .. 3 ) {
401 $verbose and warn "branch '$branchcode', pass $i\n";
402 my $mindays = $overdue_rules->{"delay$i"}; # the notice will be sent after mindays days (grace period)
404 $overdue_rules->{ "delay" . ( $i + 1 ) }
405 ? $overdue_rules->{ "delay" . ( $i + 1 ) }
407 ); # issues being more than maxdays late are managed somewhere else. (borrower probably suspended)
409 if ( !$overdue_rules->{"letter$i"} ) {
410 $verbose and warn "No letter$i code for branch '$branchcode'";
414 # $letter->{'content'} is the text of the mail that is sent.
415 # this text contains fields that are replaced by their value. Those fields must be written between brackets
416 # The following fields are available :
417 # 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).
418 # <date> <itemcount> <firstname> <lastname> <address1> <address2> <address3> <city> <postcode>
420 my $borrower_sql = <<'END_SQL';
421 SELECT COUNT(*), issues.borrowernumber, firstname, surname, address, address2, city, zipcode, country, email, MIN(date_due) as longest_issue
422 FROM issues,borrowers,categories
423 WHERE issues.borrowernumber=borrowers.borrowernumber
424 AND borrowers.categorycode=categories.categorycode
426 my @borrower_parameters;
428 $borrower_sql .= ' AND issues.branchcode=? ';
429 push @borrower_parameters, $branchcode;
431 if ( $overdue_rules->{categorycode} ) {
432 $borrower_sql .= ' AND borrowers.categorycode=? ';
433 push @borrower_parameters, $overdue_rules->{categorycode};
435 $borrower_sql .= ' AND categories.overduenoticerequired=1
436 GROUP BY issues.borrowernumber ';
438 $borrower_sql .= ' HAVING TO_DAYS(NOW())-TO_DAYS(longest_issue) = ?';
439 push @borrower_parameters, $mindays;
441 $borrower_sql .= ' HAVING TO_DAYS(NOW())-TO_DAYS(longest_issue) BETWEEN ? and ? ' ;
442 push @borrower_parameters, $mindays, $maxdays;
445 # $sth gets borrower info iff at least one overdue item has triggered the overdue action.
446 my $sth = $dbh->prepare($borrower_sql);
447 $sth->execute(@borrower_parameters);
448 $verbose and warn $borrower_sql . "\n $branchcode | " . $overdue_rules->{'categorycode'} . "\n ($mindays, $maxdays)\nreturns " . $sth->rows . " rows";
450 while ( my ($itemcount, $borrowernumber, $firstname, $lastname,
451 $address1, $address2, $city, $postcode, $country, $email,
452 $longest_issue ) = $sth->fetchrow )
454 $verbose and warn "borrower $firstname, $lastname ($borrowernumber) has $itemcount items triggering level $i.";
456 my $letter = C4::Letters::getletter( 'circulation', $overdue_rules->{"letter$i"} );
459 $verbose and warn "Message '$overdue_rules->{letter$i}' content not found";
461 # might as well skip while PERIOD, no other borrowers are going to work.
462 # FIXME : Does this mean a letter must be defined in order to trigger a debar ?
466 if ( $overdue_rules->{"debarred$i"} ) {
468 #action taken is debarring
469 C4::Members::DebarMember($borrowernumber);
470 $verbose and warn "debarring $borrowernumber $firstname $lastname\n";
472 my @params = ($listall ? ( $borrowernumber , 1 , $MAX ) : ( $borrowernumber, $mindays, $maxdays ));
473 $sth2->execute(@params);
479 my $exceededPrintNoticesMaxLines = 0;
480 while ( my $item_info = $sth2->fetchrow_hashref() ) {
481 if ( ( !$email || $nomail ) && $PrintNoticesMaxLines && $i >= $PrintNoticesMaxLines ) {
482 $exceededPrintNoticesMaxLines = 1;
486 my @item_info = map { $_ =~ /^date|date$/ ? format_date( $item_info->{$_} ) : $item_info->{$_} || '' } @item_content_fields;
487 $titles .= join("\t", @item_info) . "\n";
489 push (@items, $item_info->{'biblionumber'});
492 $letter = parse_letter(
494 borrowernumber => $borrowernumber,
495 branchcode => $branchcode,
496 biblionumber => \@items,
497 substitute => { # this appears to be a hack to overcome incomplete features in this code.
498 bib => $branch_details->{'branchname'}, # maybe 'bib' is a typo for 'lib<rary>'?
499 'items.content' => $titles
504 if ( $exceededPrintNoticesMaxLines ) {
505 $letter->{'content'} .= "List too long for form; please check your account online for a complete list of your overdue items.";
508 my @misses = grep { /./ } map { /^([^>]*)[>]+/; ( $1 || '' ); } split /\</, $letter->{'content'};
510 $verbose and warn "The following terms were not matched and replaced: \n\t" . join "\n\t", @misses;
512 $letter->{'content'} =~ s/\<[^<>]*?\>//g; # Now that we've warned about them, remove them.
513 $letter->{'content'} =~ s/\<[^<>]*?\>//g; # 2nd pass for the double nesting.
518 prepare_letter_for_printing(
520 borrowernumber => $borrowernumber,
521 firstname => $firstname,
522 lastname => $lastname,
523 address1 => $address1,
524 address2 => $address2,
526 postcode => $postcode,
528 itemcount => $itemcount,
530 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : '',
535 C4::Letters::EnqueueLetter(
537 borrowernumber => $borrowernumber,
538 message_transport_type => 'email',
539 from_address => $admin_email_address,
544 # If we don't have an email address for this patron, send it to the admin to deal with.
546 prepare_letter_for_printing(
548 borrowernumber => $borrowernumber,
549 firstname => $firstname,
550 lastname => $lastname,
551 address1 => $address1,
552 address2 => $address2,
554 postcode => $postcode,
556 itemcount => $itemcount,
558 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : '',
568 if (@output_chunks) {
569 if ( defined $csvfilename ) {
570 print $csv_fh @output_chunks;
572 elsif ( defined $htmlfilename ) {
573 print $html_fh @output_chunks;
576 local $, = "\f"; # pagebreak
577 print @output_chunks;
580 filename => defined $csvfilename ? 'attachment.csv' : 'attachment.txt',
581 type => 'text/plain',
582 content => join( "\n", @output_chunks )
586 title => 'Overdue Notices',
587 content => 'These messages were not sent directly to the patrons.',
589 C4::Letters::EnqueueLetter(
591 borrowernumber => undef,
592 message_transport_type => 'email',
593 attachments => [$attachment],
594 to_address => $admin_email_address,
601 # note that we're not testing on $csv_fh to prevent closing
606 if ( defined $htmlfilename ) {
607 print $html_fh "</body>\n";
608 print $html_fh "</html>\n";
612 =head1 INTERNAL METHODS
614 These methods are internal to the operation of overdue_notices.pl.
618 parses the letter template, replacing the placeholders with data
619 specific to this patron, biblio, or item
622 letter - required hashref
623 borrowernumber - required integer
624 substitute - optional hashref of other key/value pairs that should
625 be substituted in the letter content
627 returns the C<letter> hashref, with the content updated to reflect the
628 substituted keys and values.
633 sub parse_letter { # FIXME: this code should probably be moved to C4::Letters:parseletter
635 foreach my $required (qw( letter borrowernumber )) {
636 return unless exists $params->{$required};
640 if ( $params->{'substitute'} ) {
641 while ( my ( $key, $replacedby ) = each %{ $params->{'substitute'} } ) {
642 my $replacefield = "<<$key>>";
643 $params->{'letter'}->{title} =~ s/$replacefield/$replacedby/g;
644 $params->{'letter'}->{content} =~ s/$replacefield/$replacedby/g;
648 $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'borrowers', $params->{'borrowernumber'} );
650 if ( $params->{'branchcode'} ) {
651 $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'branches', $params->{'branchcode'} );
654 if ( $params->{'biblionumber'} ) {
655 my $item_format = '';
657 while (scalar(@{$params->{'biblionumber'}}) > 0) {
658 my $item = shift @{$params->{'biblionumber'}};
659 my $fine = GetFine($item, $params->{'borrowernumber'});
661 $params->{'letter'}->{'content'} =~ m/(<item>.*<\/item>)/;
664 if ($params->{'letter'}->{'content'} =~ m/<fine>(.*)<\/fine>/) { # process any fine tags...
665 my $formatted_fine = currency_format("$1", "$fine", FMT_SYMBOL);
666 $params->{'letter'}->{'content'} =~ s/<fine>.*<\/fine>/$formatted_fine/;
668 $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'biblio', $item );
669 $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'biblioitems', $item );
670 $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'items', $item );
671 $params->{'letter'}->{'content'} =~ s/(<item>.*<\/item>)/$1\n$item_format/ if scalar(@{$params->{'biblionumber'}} > 0);
675 $params->{'letter'}->{'content'} =~ s/<\/{0,1}?item>//g; # strip all remaining item tags...
676 return $params->{'letter'};
679 =head2 prepare_letter_for_printing
681 returns a string of text appropriate for printing in the event that an
682 overdue notice will not be sent to the patron's email
683 address. Depending on the desired output format, this may be a CSV
684 string, or a human-readable representation of the notice.
695 sub prepare_letter_for_printing {
698 return unless ref $params eq 'HASH';
700 foreach my $required_parameter (qw( letter borrowernumber )) {
701 return unless defined $params->{$required_parameter};
705 if ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'csv' ) {
707 $params->{'firstname'}, $params->{'lastname'}, $params->{'address1'}, $params->{'address2'}, $params->{'postcode'},
708 $params->{'city'}, $params->{'email'}, $params->{'itemcount'}, $params->{'titles'}
711 return $csv->string, "\n";
713 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
715 } elsif ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'html' ) {
717 $return .= "$params->{'letter'}->{'content'}\n";
718 $return .= "\n</pre>\n";
720 $return .= "$params->{'letter'}->{'content'}\n";
722 # $return .= Data::Dumper->Dump( [ $params->{'borrowernumber'}, $params->{'letter'} ], [qw( borrowernumber letter )] );