3 # Copyright 2008 Liblime
4 # Copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 2 of the License, or (at your option) any later
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License along
18 # with Koha; if not, write to the Free Software Foundation, Inc.,
19 # 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.
108 Produces html data. if patron does not have a mail address or
109 -n (no mail) flag is set, an html file is generated in the specified
110 directory. This can be downloaded or futher processed by library staff.
112 =item B<-itemscontent>
114 comma separated list of fields that get substituted into templates in
115 places of the E<lt>E<lt>items.contentE<gt>E<gt> placeholder. This
116 defaults to due date,title,barcode,author
118 Other possible values come from fields in the biblios, items and
123 Repetable field, that permit to select only few of patrons categories.
127 Repetable field, permis to exclude some patrons categories.
129 =item B<-t> | B<--triggered>
131 This option causes a notice to be generated if and only if
132 an item is overdue by the number of days defined in a notice trigger.
134 By default, a notice is sent each time the script runs, which is suitable for
135 less frequent run cron script, but requires syncing notice triggers with
136 the cron schedule to ensure proper behavior.
137 Add the --triggered option for daily cron, at the risk of no notice
138 being generated if the cron fails to run on time.
142 Default items.content lists only those items that fall in the
143 range of the currently processing notice.
144 Choose list-all to include all overdue items in the list (limited by B<-max> setting).
150 This script is designed to alert patrons and administrators of overdue
155 This script pays attention to the overdue notice configuration
156 performed in the "Overdue notice/status triggers" section of the
157 "Tools" area of the staff interface to Koha. There, you can choose
158 which letter templates are sent out after a configurable number of
159 days to patrons of each library. More information about the use of this
160 section of Koha is available in the Koha manual.
162 The templates used to craft the emails are defined in the "Tools:
163 Notices" section of the staff interface to Koha.
165 =head2 Outgoing emails
167 Typically, messages are prepared for each patron with overdue
168 items. Messages for whom there is no email address on file are
169 collected and sent as attachments in a single email to each library
170 administrator, or if that is not set, then to the email address in the
171 C<KohaAdminEmailAddress> system preference.
173 These emails are staged in the outgoing message queue, as are messages
174 produced by other features of Koha. This message queue must be
175 processed regularly by the
176 F<misc/cronjobs/process_message_queue.pl> program.
178 In the event that the C<-n> flag is passed to this program, no emails
179 are sent. Instead, messages are sent on standard output from this
180 program. They may be redirected to a file if desired.
184 Templates can contain variables enclosed in double angle brackets like
185 E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
186 specific to the overdue items or relevant patron. Available variables
191 =item E<lt>E<lt>bibE<gt>E<gt>
193 the name of the library
195 =item E<lt>E<lt>items.contentE<gt>E<gt>
197 one line for each item, each line containing a tab separated list of
198 title, author, barcode, issuedate
200 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
202 any field from the borrowers table
204 =item E<lt>E<lt>branches.*E<gt>E<gt>
206 any field from the branches table
212 The C<-csv> command line option lets you specify a file to which
213 overdues data should be output in CSV format.
215 With the C<-n> flag set, data about all overdues is written to the
216 file. Without that flag, only information about overdues that were
217 unable to be sent directly to the patrons will be written. In other
218 words, this CSV file replaces the data that is typically sent to the
219 administrator email address.
221 =head1 USAGE EXAMPLES
223 C<overdue_notices.pl> - In this most basic usage, with no command line
224 arguments, all libraries are procesed individually, and notices are
225 prepared for all patrons with overdue items for whom we have email
226 addresses. Messages for those patrons for whom we have no email
227 address are sent in a single attachment to the library administrator's
228 email address, or to the address in the KohaAdminEmailAddress system
231 C<overdue_notices.pl -n -csv /tmp/overdues.csv> - sends no email and
232 populates F</tmp/overdues.csv> with information about all overdue
235 C<overdue_notices.pl -library MAIN max 14> - prepare notices of
236 overdues in the last 2 weeks for the MAIN library.
240 The F<misc/cronjobs/advance_notices.pl> program allows you to send
241 messages to patrons in advance of thier items becoming due, or to
242 alert them of items that have just become due.
246 # These variables are set by command line options.
247 # They are initially set to default values.
248 my $dbh = C4::Context->dbh();
254 my @branchcodes; # Branch(es) passed as parameter
259 my $itemscontent = join( ',', qw( date_due title barcode author itemnumber ) );
269 'library=s' => \@branchcodes,
270 'csv:s' => \$csvfilename, # this optional argument gets '' if not supplied.
271 'html:s' => \$htmlfilename, # this optional argument gets '' if not supplied.
272 'itemscontent=s' => \$itemscontent,
273 'list-all' => \$listall,
274 't|triggered' => \$triggered,
275 'borcat=s' => \@myborcat,
276 'borcatout=s' => \@myborcatout,
278 pod2usage(1) if $help;
279 pod2usage( -verbose => 2 ) if $man;
281 if ( defined $csvfilename && $csvfilename =~ /^-/ ) {
282 warn qq(using "$csvfilename" as filename, that seems odd);
285 my @overduebranches = C4::Overdues::GetBranchcodesWithOverdueRules(); # Branches with overdue rules
286 my @branches; # Branches passed as parameter with overdue rules
287 my $branchcount = scalar(@overduebranches);
289 my $overduebranch_word = scalar @overduebranches > 1 ? 'branches' : 'branch';
290 my $branchcodes_word = scalar @branchcodes > 1 ? 'branches' : 'branch';
292 my $PrintNoticesMaxLines = C4::Context->preference('PrintNoticesMaxLines');
295 $verbose and warn "Found $branchcount $overduebranch_word with first message enabled: " . join( ', ', map { "'$_'" } @overduebranches ), "\n";
297 die 'No branches with active overduerules';
301 $verbose and warn "$branchcodes_word @branchcodes passed on parameter\n";
303 # Getting libraries which have overdue rules
304 my %seen = map { $_ => 1 } @branchcodes;
305 @branches = grep { $seen{$_} } @overduebranches;
308 if (@overduebranches) {
310 my $branch_word = scalar @branches > 1 ? 'branches' : 'branch';
311 $verbose and warn "$branch_word @branches have overdue rules\n";
315 $verbose and warn "No active overduerules for $branchcodes_word '@branchcodes'\n";
316 ( scalar grep { '' eq $_ } @branches )
317 or die "No active overduerules for DEFAULT either!";
318 $verbose and warn "Falling back on default rules for @branchcodes\n";
323 # these are the fields that will be substituted into <<item.content>>
324 my @item_content_fields = split( /,/, $itemscontent );
326 binmode( STDOUT, ":utf8" );
329 our $csv; # the Text::CSV_XS object
330 our $csv_fh; # the filehandle to the CSV file.
331 if ( defined $csvfilename ) {
332 my $sep_char = C4::Context->preference('delimiter') || ',';
333 $csv = Text::CSV_XS->new( { binary => 1 , sep_char => $sep_char } );
334 if ( $csvfilename eq '' ) {
337 open $csv_fh, ">", $csvfilename or die "unable to open $csvfilename: $!";
339 if ( $csv->combine(qw(name surname address1 address2 zipcode city country email itemcount itemsinfo)) ) {
340 print $csv_fh $csv->string, "\n";
342 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
346 @branches = @overduebranches unless @branches;
348 if ( defined $htmlfilename ) {
349 if ( $htmlfilename eq '' ) {
352 my $today = C4::Dates->new();
353 open $html_fh, ">",File::Spec->catdir ($htmlfilename,"notices-".$today->output('iso').".html");
356 print $html_fh "<html>\n";
357 print $html_fh "<head>\n";
358 print $html_fh "<style type='text/css'>\n";
359 print $html_fh "pre {page-break-after: always;}\n";
360 print $html_fh "pre {white-space: pre-wrap;}\n";
361 print $html_fh "pre {white-space: -moz-pre-wrap;}\n";
362 print $html_fh "pre {white-space: -o-pre-wrap;}\n";
363 print $html_fh "pre {word-wrap: break-work;}\n";
364 print $html_fh "</style>\n";
365 print $html_fh "</head>\n";
366 print $html_fh "<body>\n";
369 foreach my $branchcode (@branches) {
371 my $branch_details = C4::Branch::GetBranchDetail($branchcode);
372 my $admin_email_address = $branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
373 my @output_chunks; # may be sent to mail or stdout or csv file.
375 $verbose and warn sprintf "branchcode : '%s' using %s\n", $branchcode, $admin_email_address;
377 my $sth2 = $dbh->prepare( <<'END_SQL' );
378 SELECT biblio.*, items.*, issues.*, TO_DAYS(NOW())-TO_DAYS(date_due) AS days_overdue
379 FROM issues,items,biblio
380 WHERE items.itemnumber=issues.itemnumber
381 AND biblio.biblionumber = items.biblionumber
382 AND issues.borrowernumber = ?
383 AND TO_DAYS(NOW())-TO_DAYS(date_due) BETWEEN ? and ?
386 my $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = ? ";
387 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
388 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
390 my $rqoverduerules = $dbh->prepare($query);
391 $rqoverduerules->execute($branchcode, @myborcat, @myborcatout);
393 # We get default rules is there is no rule for this branch
394 if($rqoverduerules->rows == 0){
395 $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = '' ";
396 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
397 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
399 $rqoverduerules = $dbh->prepare($query);
400 $rqoverduerules->execute(@myborcat, @myborcatout);
403 # my $outfile = 'overdues_' . ( $mybranch || $branchcode || 'default' );
404 while ( my $overdue_rules = $rqoverduerules->fetchrow_hashref ) {
405 PERIOD: foreach my $i ( 1 .. 3 ) {
407 $verbose and warn "branch '$branchcode', pass $i\n";
408 my $mindays = $overdue_rules->{"delay$i"}; # the notice will be sent after mindays days (grace period)
410 $overdue_rules->{ "delay" . ( $i + 1 ) }
411 ? $overdue_rules->{ "delay" . ( $i + 1 ) }
413 ); # issues being more than maxdays late are managed somewhere else. (borrower probably suspended)
415 if ( !$overdue_rules->{"letter$i"} ) {
416 $verbose and warn "No letter$i code for branch '$branchcode'";
420 # $letter->{'content'} is the text of the mail that is sent.
421 # this text contains fields that are replaced by their value. Those fields must be written between brackets
422 # The following fields are available :
423 # 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).
424 # <date> <itemcount> <firstname> <lastname> <address1> <address2> <address3> <city> <postcode>
426 my $borrower_sql = <<'END_SQL';
427 SELECT COUNT(*), issues.borrowernumber, firstname, surname, address, address2, city, zipcode, country, email, MIN(date_due) as longest_issue
428 FROM issues,borrowers,categories
429 WHERE issues.borrowernumber=borrowers.borrowernumber
430 AND borrowers.categorycode=categories.categorycode
432 my @borrower_parameters;
434 $borrower_sql .= ' AND issues.branchcode=? ';
435 push @borrower_parameters, $branchcode;
437 if ( $overdue_rules->{categorycode} ) {
438 $borrower_sql .= ' AND borrowers.categorycode=? ';
439 push @borrower_parameters, $overdue_rules->{categorycode};
441 $borrower_sql .= ' AND categories.overduenoticerequired=1
442 GROUP BY issues.borrowernumber ';
444 $borrower_sql .= ' HAVING TO_DAYS(NOW())-TO_DAYS(longest_issue) = ?';
445 push @borrower_parameters, $mindays;
447 $borrower_sql .= ' HAVING TO_DAYS(NOW())-TO_DAYS(longest_issue) BETWEEN ? and ? ' ;
448 push @borrower_parameters, $mindays, $maxdays;
451 # $sth gets borrower info iff at least one overdue item has triggered the overdue action.
452 my $sth = $dbh->prepare($borrower_sql);
453 $sth->execute(@borrower_parameters);
454 $verbose and warn $borrower_sql . "\n $branchcode | " . $overdue_rules->{'categorycode'} . "\n ($mindays, $maxdays)\nreturns " . $sth->rows . " rows";
456 while ( my ($itemcount, $borrowernumber, $firstname, $lastname,
457 $address1, $address2, $city, $postcode, $country, $email,
458 $longest_issue ) = $sth->fetchrow )
460 $verbose and warn "borrower $firstname, $lastname ($borrowernumber) has $itemcount items triggering level $i.";
462 my $letter = C4::Letters::getletter( 'circulation', $overdue_rules->{"letter$i"} );
465 $verbose and warn "Message '$overdue_rules->{letter$i}' content not found";
467 # might as well skip while PERIOD, no other borrowers are going to work.
468 # FIXME : Does this mean a letter must be defined in order to trigger a debar ?
472 if ( $overdue_rules->{"debarred$i"} ) {
474 #action taken is debarring
475 C4::Members::DebarMember($borrowernumber);
476 $verbose and warn "debarring $borrowernumber $firstname $lastname\n";
478 my @params = ($listall ? ( $borrowernumber , 1 , $MAX ) : ( $borrowernumber, $mindays, $maxdays ));
479 $verbose and warn "STH2 PARAMS: borrowernumber = $borrowernumber, mindays = $mindays, maxdays = $maxdays";
480 $sth2->execute(@params);
486 my $exceededPrintNoticesMaxLines = 0;
487 while ( my $item_info = $sth2->fetchrow_hashref() ) {
488 if ( ( !$email || $nomail ) && $PrintNoticesMaxLines && $i >= $PrintNoticesMaxLines ) {
489 $exceededPrintNoticesMaxLines = 1;
493 my @item_info = map { $_ =~ /^date|date$/ ? format_date( $item_info->{$_} ) : $item_info->{$_} || '' } @item_content_fields;
494 $titles .= join("\t", @item_info) . "\n";
496 push @items, { itemnumber => $item_info->{'itemnumber'}, biblionumber => $item_info->{'biblionumber'} };
499 $letter = parse_letter(
501 borrowernumber => $borrowernumber,
502 branchcode => $branchcode,
504 substitute => { # this appears to be a hack to overcome incomplete features in this code.
505 bib => $branch_details->{'branchname'}, # maybe 'bib' is a typo for 'lib<rary>'?
506 'items.content' => $titles
511 if ( $exceededPrintNoticesMaxLines ) {
512 $letter->{'content'} .= "List too long for form; please check your account online for a complete list of your overdue items.";
515 my @misses = grep { /./ } map { /^([^>]*)[>]+/; ( $1 || '' ); } split /\</, $letter->{'content'};
517 $verbose and warn "The following terms were not matched and replaced: \n\t" . join "\n\t", @misses;
519 $letter->{'content'} =~ s/\<[^<>]*?\>//g; # Now that we've warned about them, remove them.
520 $letter->{'content'} =~ s/\<[^<>]*?\>//g; # 2nd pass for the double nesting.
525 prepare_letter_for_printing(
527 borrowernumber => $borrowernumber,
528 firstname => $firstname,
529 lastname => $lastname,
530 address1 => $address1,
531 address2 => $address2,
533 postcode => $postcode,
535 itemcount => $itemcount,
537 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : '',
542 C4::Letters::EnqueueLetter(
544 borrowernumber => $borrowernumber,
545 message_transport_type => 'email',
546 from_address => $admin_email_address,
551 # If we don't have an email address for this patron, send it to the admin to deal with.
553 prepare_letter_for_printing(
555 borrowernumber => $borrowernumber,
556 firstname => $firstname,
557 lastname => $lastname,
558 address1 => $address1,
559 address2 => $address2,
561 postcode => $postcode,
563 itemcount => $itemcount,
565 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : '',
575 if (@output_chunks) {
576 if ( defined $csvfilename ) {
577 print $csv_fh @output_chunks;
579 elsif ( defined $htmlfilename ) {
580 print $html_fh @output_chunks;
583 local $, = "\f"; # pagebreak
584 print @output_chunks;
587 filename => defined $csvfilename ? 'attachment.csv' : 'attachment.txt',
588 type => 'text/plain',
589 content => join( "\n", @output_chunks )
593 title => 'Overdue Notices',
594 content => 'These messages were not sent directly to the patrons.',
596 C4::Letters::EnqueueLetter(
598 borrowernumber => undef,
599 message_transport_type => 'email',
600 attachments => [$attachment],
601 to_address => $admin_email_address,
608 # note that we're not testing on $csv_fh to prevent closing
613 if ( defined $htmlfilename ) {
614 print $html_fh "</body>\n";
615 print $html_fh "</html>\n";
619 =head1 INTERNAL METHODS
621 These methods are internal to the operation of overdue_notices.pl.
625 parses the letter template, replacing the placeholders with data
626 specific to this patron, biblio, or item
629 letter - required hashref
630 borrowernumber - required integer
631 substitute - optional hashref of other key/value pairs that should
632 be substituted in the letter content
634 returns the C<letter> hashref, with the content updated to reflect the
635 substituted keys and values.
640 sub parse_letter { # FIXME: this code should probably be moved to C4::Letters:parseletter
642 foreach my $required (qw( letter borrowernumber )) {
643 return unless exists $params->{$required};
647 if ( $params->{'substitute'} ) {
648 while ( my ( $key, $replacedby ) = each %{ $params->{'substitute'} } ) {
649 my $replacefield = "<<$key>>";
650 $params->{'letter'}->{title} =~ s/$replacefield/$replacedby/g;
651 $params->{'letter'}->{content} =~ s/$replacefield/$replacedby/g;
655 $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'borrowers', $params->{'borrowernumber'} );
657 if ( $params->{'branchcode'} ) {
658 $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'branches', $params->{'branchcode'} );
661 if ( $params->{'items'} ) {
662 my $item_format = '';
664 while (scalar(@{$params->{'items'}}) > 0) {
665 my $item = shift @{$params->{'items'}};
666 my $fine = GetFine($item->{'itemnumber'}, $params->{'borrowernumber'});
668 $params->{'letter'}->{'content'} =~ m/(<item>.*<\/item>)/;
671 if ($params->{'letter'}->{'content'} =~ m/<fine>(.*)<\/fine>/) { # process any fine tags...
672 my $formatted_fine = currency_format("$1", "$fine", FMT_SYMBOL);
673 $params->{'letter'}->{'content'} =~ s/<fine>.*<\/fine>/$formatted_fine/;
675 $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'biblio', $item->{'biblionumber'} );
676 $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'biblioitems', $item->{'biblionumber'} );
677 $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'items', $item->{'itemnumber'} );
678 $params->{'letter'}->{'content'} =~ s/(<item>.*<\/item>)/$1\n$item_format/ if scalar(@{$params->{'items'}} > 0);
682 $params->{'letter'}->{'content'} =~ s/<\/{0,1}?item>//g; # strip all remaining item tags...
683 return $params->{'letter'};
686 =head2 prepare_letter_for_printing
688 returns a string of text appropriate for printing in the event that an
689 overdue notice will not be sent to the patron's email
690 address. Depending on the desired output format, this may be a CSV
691 string, or a human-readable representation of the notice.
702 sub prepare_letter_for_printing {
705 return unless ref $params eq 'HASH';
707 foreach my $required_parameter (qw( letter borrowernumber )) {
708 return unless defined $params->{$required_parameter};
712 if ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'csv' ) {
714 $params->{'firstname'}, $params->{'lastname'}, $params->{'address1'}, $params->{'address2'}, $params->{'postcode'},
715 $params->{'city'}, $params->{'email'}, $params->{'itemcount'}, $params->{'titles'}
718 return $csv->string, "\n";
720 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
722 } elsif ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'html' ) {
724 $return .= "$params->{'letter'}->{'content'}\n";
725 $return .= "\n</pre>\n";
727 $return .= "$params->{'letter'}->{'content'}\n";
729 # $return .= Data::Dumper->Dump( [ $params->{'borrowernumber'}, $params->{'letter'} ], [qw( borrowernumber letter )] );