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
51 [ -n ][ -library <branchcode> ][ -library <branchcode> ... ]
52 [ -max <number of days> ][ -csv [<filename>] ][ -itemscontent <field list> ]
53 [ -email <email_type> ... ]
56 -help brief help message
57 -man full documentation
58 -n No email will be sent
59 -max <days> maximum days overdue to deal with
60 -library <branchname> only deal with overdues from this library (repeatable : several libraries can be given)
61 -csv <filename> populate CSV file
62 -html <filename> Output html to file
63 -itemscontent <list of fields> item information in templates
64 -borcat <categorycode> category code that must be included
65 -borcatout <categorycode> category code that must be excluded
66 -email <email_type> type of email that will be used. Can be 'email', 'emailpro' or 'B_email'. Repeatable.
74 Print a brief help message and exits.
78 Prints the manual page and exits.
82 Verbose. Without this flag set, only fatal errors are reported.
86 Do not send any email. Overdue notices that would have been sent to
87 the patrons or to the admin are printed to standard out. CSV data (if
88 the -csv flag is set) is written to standard out or to any csv
93 Items older than max days are assumed to be handled somewhere else,
94 probably the F<longoverdues.pl> script. They are therefore ignored by
95 this program. No notices are sent for them, and they are not added to
96 any CSV files. Defaults to 90 to match F<longoverdues.pl>.
100 select overdues for one specific library. Use the value in the
101 branches.branchcode table. This option can be repeated in order
102 to select overdues for a group of libraries.
106 Produces CSV data. if -n (no mail) flag is set, then this CSV data is
107 sent to standard out or to a filename if provided. Otherwise, only
108 overdues that could not be emailed are sent in CSV format to the admin.
112 Produces html data. if patron does not have a mail address or
113 -n (no mail) flag is set, an html file is generated in the specified
114 directory. This can be downloaded or futher processed by library staff.
116 =item B<-itemscontent>
118 comma separated list of fields that get substituted into templates in
119 places of the E<lt>E<lt>items.contentE<gt>E<gt> placeholder. This
120 defaults to due date,title,barcode,author
122 Other possible values come from fields in the biblios, items and
127 Repetable field, that permit to select only few of patrons categories.
131 Repetable field, permis to exclude some patrons categories.
133 =item B<-t> | B<--triggered>
135 This option causes a notice to be generated if and only if
136 an item is overdue by the number of days defined in a notice trigger.
138 By default, a notice is sent each time the script runs, which is suitable for
139 less frequent run cron script, but requires syncing notice triggers with
140 the cron schedule to ensure proper behavior.
141 Add the --triggered option for daily cron, at the risk of no notice
142 being generated if the cron fails to run on time.
146 Default items.content lists only those items that fall in the
147 range of the currently processing notice.
148 Choose list-all to include all overdue items in the list (limited by B<-max> setting).
152 use it in order to send overdues on a specific date and not Now.
156 Allows to specify which type of email will be used. Can be email, emailpro or B_email. Repeatable.
162 This script is designed to alert patrons and administrators of overdue
167 This script pays attention to the overdue notice configuration
168 performed in the "Overdue notice/status triggers" section of the
169 "Tools" area of the staff interface to Koha. There, you can choose
170 which letter templates are sent out after a configurable number of
171 days to patrons of each library. More information about the use of this
172 section of Koha is available in the Koha manual.
174 The templates used to craft the emails are defined in the "Tools:
175 Notices" section of the staff interface to Koha.
177 =head2 Outgoing emails
179 Typically, messages are prepared for each patron with overdue
180 items. Messages for whom there is no email address on file are
181 collected and sent as attachments in a single email to each library
182 administrator, or if that is not set, then to the email address in the
183 C<KohaAdminEmailAddress> system preference.
185 These emails are staged in the outgoing message queue, as are messages
186 produced by other features of Koha. This message queue must be
187 processed regularly by the
188 F<misc/cronjobs/process_message_queue.pl> program.
190 In the event that the C<-n> flag is passed to this program, no emails
191 are sent. Instead, messages are sent on standard output from this
192 program. They may be redirected to a file if desired.
196 Templates can contain variables enclosed in double angle brackets like
197 E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
198 specific to the overdue items or relevant patron. Available variables
203 =item E<lt>E<lt>bibE<gt>E<gt>
205 the name of the library
207 =item E<lt>E<lt>items.contentE<gt>E<gt>
209 one line for each item, each line containing a tab separated list of
210 title, author, barcode, issuedate
212 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
214 any field from the borrowers table
216 =item E<lt>E<lt>branches.*E<gt>E<gt>
218 any field from the branches table
224 The C<-csv> command line option lets you specify a file to which
225 overdues data should be output in CSV format.
227 With the C<-n> flag set, data about all overdues is written to the
228 file. Without that flag, only information about overdues that were
229 unable to be sent directly to the patrons will be written. In other
230 words, this CSV file replaces the data that is typically sent to the
231 administrator email address.
233 =head1 USAGE EXAMPLES
235 C<overdue_notices.pl> - In this most basic usage, with no command line
236 arguments, all libraries are procesed individually, and notices are
237 prepared for all patrons with overdue items for whom we have email
238 addresses. Messages for those patrons for whom we have no email
239 address are sent in a single attachment to the library administrator's
240 email address, or to the address in the KohaAdminEmailAddress system
243 C<overdue_notices.pl -n -csv /tmp/overdues.csv> - sends no email and
244 populates F</tmp/overdues.csv> with information about all overdue
247 C<overdue_notices.pl -library MAIN max 14> - prepare notices of
248 overdues in the last 2 weeks for the MAIN library.
252 The F<misc/cronjobs/advance_notices.pl> program allows you to send
253 messages to patrons in advance of thier items becoming due, or to
254 alert them of items that have just become due.
258 # These variables are set by command line options.
259 # They are initially set to default values.
260 my $dbh = C4::Context->dbh();
266 my @branchcodes; # Branch(es) passed as parameter
267 my @emails_to_use; # Emails to use for messaging
268 my @emails; # Emails given in command-line parameters
273 my $itemscontent = join( ',', qw( date_due title barcode author itemnumber ) );
284 'library=s' => \@branchcodes,
285 'csv:s' => \$csvfilename, # this optional argument gets '' if not supplied.
286 'html:s' => \$htmlfilename, # this optional argument gets '' if not supplied.
287 'itemscontent=s' => \$itemscontent,
288 'list-all' => \$listall,
289 't|triggered' => \$triggered,
291 'borcat=s' => \@myborcat,
292 'borcatout=s' => \@myborcatout,
293 'email=s' => \@emails,
295 pod2usage(1) if $help;
296 pod2usage( -verbose => 2 ) if $man;
298 if ( defined $csvfilename && $csvfilename =~ /^-/ ) {
299 warn qq(using "$csvfilename" as filename, that seems odd);
302 my @overduebranches = C4::Overdues::GetBranchcodesWithOverdueRules(); # Branches with overdue rules
303 my @branches; # Branches passed as parameter with overdue rules
304 my $branchcount = scalar(@overduebranches);
306 my $overduebranch_word = scalar @overduebranches > 1 ? 'branches' : 'branch';
307 my $branchcodes_word = scalar @branchcodes > 1 ? 'branches' : 'branch';
309 my $PrintNoticesMaxLines = C4::Context->preference('PrintNoticesMaxLines');
312 $verbose and warn "Found $branchcount $overduebranch_word with first message enabled: " . join( ', ', map { "'$_'" } @overduebranches ), "\n";
314 die 'No branches with active overduerules';
318 $verbose and warn "$branchcodes_word @branchcodes passed on parameter\n";
320 # Getting libraries which have overdue rules
321 my %seen = map { $_ => 1 } @branchcodes;
322 @branches = grep { $seen{$_} } @overduebranches;
327 my $branch_word = scalar @branches > 1 ? 'branches' : 'branch';
328 $verbose and warn "$branch_word @branches have overdue rules\n";
332 $verbose and warn "No active overduerules for $branchcodes_word '@branchcodes'\n";
333 ( scalar grep { '' eq $_ } @branches )
334 or die "No active overduerules for DEFAULT either!";
335 $verbose and warn "Falling back on default rules for @branchcodes\n";
341 $date=$dbh->quote($date);
347 # these are the fields that will be substituted into <<item.content>>
348 my @item_content_fields = split( /,/, $itemscontent );
350 binmode( STDOUT, ':encoding(UTF-8)' );
353 our $csv; # the Text::CSV_XS object
354 our $csv_fh; # the filehandle to the CSV file.
355 if ( defined $csvfilename ) {
356 my $sep_char = C4::Context->preference('delimiter') || ',';
357 $sep_char = "\t" if ($sep_char eq 'tabulation');
358 $csv = Text::CSV_XS->new( { binary => 1 , sep_char => $sep_char } );
359 if ( $csvfilename eq '' ) {
362 open $csv_fh, ">", $csvfilename or die "unable to open $csvfilename: $!";
364 if ( $csv->combine(qw(name surname address1 address2 zipcode city country email itemcount itemsinfo)) ) {
365 print $csv_fh $csv->string, "\n";
367 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
371 @branches = @overduebranches unless @branches;
373 if ( defined $htmlfilename ) {
374 if ( $htmlfilename eq '' ) {
377 my $today = DateTime->now(time_zone => C4::Context->tz );
378 open $html_fh, ">",File::Spec->catdir ($htmlfilename,"notices-".$today->ymd().".html");
381 print $html_fh "<html>\n";
382 print $html_fh "<head>\n";
383 print $html_fh "<style type='text/css'>\n";
384 print $html_fh "pre {page-break-after: always;}\n";
385 print $html_fh "pre {white-space: pre-wrap;}\n";
386 print $html_fh "pre {white-space: -moz-pre-wrap;}\n";
387 print $html_fh "pre {white-space: -o-pre-wrap;}\n";
388 print $html_fh "pre {word-wrap: break-work;}\n";
389 print $html_fh "</style>\n";
390 print $html_fh "</head>\n";
391 print $html_fh "<body>\n";
394 foreach my $branchcode (@branches) {
396 my $branch_details = C4::Branch::GetBranchDetail($branchcode);
397 my $admin_email_address = $branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
398 my @output_chunks; # may be sent to mail or stdout or csv file.
400 $verbose and warn sprintf "branchcode : '%s' using %s\n", $branchcode, $admin_email_address;
402 my $sth2 = $dbh->prepare( <<"END_SQL" );
403 SELECT biblio.*, items.*, issues.*, biblioitems.itemtype, TO_DAYS($date)-TO_DAYS(date_due) AS days_overdue
404 FROM issues,items,biblio, biblioitems
405 WHERE items.itemnumber=issues.itemnumber
406 AND biblio.biblionumber = items.biblionumber
407 AND biblio.biblionumber = biblioitems.biblionumber
408 AND issues.borrowernumber = ?
409 AND TO_DAYS($date)-TO_DAYS(date_due) BETWEEN ? and ?
412 my $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = ? ";
413 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
414 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
416 my $rqoverduerules = $dbh->prepare($query);
417 $rqoverduerules->execute($branchcode, @myborcat, @myborcatout);
419 # We get default rules is there is no rule for this branch
420 if($rqoverduerules->rows == 0){
421 $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = '' ";
422 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
423 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
425 $rqoverduerules = $dbh->prepare($query);
426 $rqoverduerules->execute(@myborcat, @myborcatout);
429 # my $outfile = 'overdues_' . ( $mybranch || $branchcode || 'default' );
430 while ( my $overdue_rules = $rqoverduerules->fetchrow_hashref ) {
431 PERIOD: foreach my $i ( 1 .. 3 ) {
433 $verbose and warn "branch '$branchcode', pass $i\n";
434 my $mindays = $overdue_rules->{"delay$i"}; # the notice will be sent after mindays days (grace period)
436 $overdue_rules->{ "delay" . ( $i + 1 ) }
437 ? $overdue_rules->{ "delay" . ( $i + 1 ) } - 1
439 ); # issues being more than maxdays late are managed somewhere else. (borrower probably suspended)
441 if ( !$overdue_rules->{"letter$i"} ) {
442 $verbose and warn "No letter$i code for branch '$branchcode'";
446 # $letter->{'content'} is the text of the mail that is sent.
447 # this text contains fields that are replaced by their value. Those fields must be written between brackets
448 # The following fields are available :
449 # 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).
450 # <date> <itemcount> <firstname> <lastname> <address1> <address2> <address3> <city> <postcode> <country>
452 my $borrower_sql = <<'END_SQL';
453 SELECT distinct(issues.borrowernumber), firstname, surname, address, address2, city, zipcode, country, email
454 FROM issues,borrowers,categories
455 WHERE issues.borrowernumber=borrowers.borrowernumber
456 AND borrowers.categorycode=categories.categorycode
458 my @borrower_parameters;
460 $borrower_sql .= ' AND issues.branchcode=? ';
461 push @borrower_parameters, $branchcode;
463 if ( $overdue_rules->{categorycode} ) {
464 $borrower_sql .= ' AND borrowers.categorycode=? ';
465 push @borrower_parameters, $overdue_rules->{categorycode};
467 $borrower_sql .= ' AND categories.overduenoticerequired=1 ';
469 $borrower_sql .= " AND TO_DAYS($date)-TO_DAYS(date_due) = ?";
470 push @borrower_parameters, $mindays;
472 $borrower_sql .= " AND TO_DAYS($date)-TO_DAYS(date_due) BETWEEN ? and ? " ;
473 push @borrower_parameters, $mindays, $maxdays;
476 # $sth gets borrower info iff at least one overdue item has triggered the overdue action.
477 my $sth = $dbh->prepare($borrower_sql);
478 $sth->execute(@borrower_parameters);
479 $verbose and warn $borrower_sql . "\n $branchcode | " . $overdue_rules->{'categorycode'} . "\n ($mindays, $maxdays)\nreturns " . $sth->rows . " rows";
481 while ( my ( $borrowernumber, $firstname, $lastname,
482 $address1, $address2, $city, $postcode, $country, $email
485 $verbose and warn "borrower $firstname, $lastname ($borrowernumber) has items triggering level $i.";
489 my $memberinfos = C4::Members::GetMember(borrowernumber => $borrowernumber);
491 push @emails_to_use, $memberinfos->{$_}
492 if ($memberinfos->{$_} ne '');
497 C4::Members::GetFirstValidEmailAddress($borrowernumber);
498 push @emails_to_use, $email if ($email ne '');
502 my $letter = C4::Letters::getletter( 'circulation', $overdue_rules->{"letter$i"}, $branchcode );
505 $verbose and warn "Message '$overdue_rules->{letter$i}' content not found";
507 # might as well skip while PERIOD, no other borrowers are going to work.
508 # FIXME : Does this mean a letter must be defined in order to trigger a debar ?
512 if ( $overdue_rules->{"debarred$i"} ) {
514 #action taken is debarring
515 C4::Members::DebarMember($borrowernumber, '9999-12-31');
516 $verbose and warn "debarring $borrowernumber $firstname $lastname\n";
518 my @params = ($listall ? ( $borrowernumber , 1 , $MAX ) : ( $borrowernumber, $mindays, $maxdays ));
519 $verbose and warn "STH2 PARAMS: borrowernumber = $borrowernumber, mindays = $mindays, maxdays = $maxdays";
520 $sth2->execute(@params);
526 my $exceededPrintNoticesMaxLines = 0;
527 while ( my $item_info = $sth2->fetchrow_hashref() ) {
528 if ( ( scalar(@emails_to_use) == 0 || $nomail ) && $PrintNoticesMaxLines && $j >= $PrintNoticesMaxLines ) {
529 $exceededPrintNoticesMaxLines = 1;
533 my @item_info = map { $_ =~ /^date|date$/ ? format_date( $item_info->{$_} ) : $item_info->{$_} || '' } @item_content_fields;
534 $titles .= join("\t", @item_info) . "\n";
536 push @items, $item_info;
540 $letter = parse_letter(
541 { letter_code => $overdue_rules->{"letter$i"},
542 borrowernumber => $borrowernumber,
543 branchcode => $branchcode,
545 substitute => { # this appears to be a hack to overcome incomplete features in this code.
546 bib => $branch_details->{'branchname'}, # maybe 'bib' is a typo for 'lib<rary>'?
547 'items.content' => $titles,
548 'count' => $itemcount,
553 $verbose and warn "Message '$overdue_rules->{letter$i}' content not found";
555 # might as well skip while PERIOD, no other borrowers are going to work.
556 # FIXME : Does this mean a letter must be defined in order to trigger a debar ?
560 if ( $exceededPrintNoticesMaxLines ) {
561 $letter->{'content'} .= "List too long for form; please check your account online for a complete list of your overdue items.";
564 my @misses = grep { /./ } map { /^([^>]*)[>]+/; ( $1 || '' ); } split /\</, $letter->{'content'};
566 $verbose and warn "The following terms were not matched and replaced: \n\t" . join "\n\t", @misses;
568 $letter->{'content'} =~ s/\<[^<>]*?\>//g; # Now that we've warned about them, remove them.
569 $letter->{'content'} =~ s/\<[^<>]*?\>//g; # 2nd pass for the double nesting.
574 prepare_letter_for_printing(
576 borrowernumber => $borrowernumber,
577 firstname => $firstname,
578 lastname => $lastname,
579 address1 => $address1,
580 address2 => $address2,
582 postcode => $postcode,
585 itemcount => $itemcount,
587 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : '',
591 if (scalar(@emails_to_use) > 0 ) {
592 C4::Letters::EnqueueLetter(
594 borrowernumber => $borrowernumber,
595 message_transport_type => 'email',
596 from_address => $admin_email_address,
597 to_address => join(',', @emails_to_use),
602 # If we don't have an email address for this patron, send it to the admin to deal with.
604 prepare_letter_for_printing(
606 borrowernumber => $borrowernumber,
607 firstname => $firstname,
608 lastname => $lastname,
609 address1 => $address1,
610 address2 => $address2,
612 postcode => $postcode,
615 itemcount => $itemcount,
617 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : '',
627 if (@output_chunks) {
628 if ( defined $csvfilename ) {
629 print $csv_fh @output_chunks;
631 elsif ( defined $htmlfilename ) {
632 print $html_fh @output_chunks;
635 local $, = "\f"; # pagebreak
636 print @output_chunks;
638 # Generate the content of the csv with headers
639 my $content = join(";", qw(title name surname address1 address2 zipcode city country email itemcount itemsinfo due_date issue_date)) . "\n";
640 $content .= join( "\n", @output_chunks );
643 filename => defined $csvfilename ? 'attachment.csv' : 'attachment.txt',
644 type => 'text/plain',
649 title => 'Overdue Notices',
650 content => 'These messages were not sent directly to the patrons.',
652 C4::Letters::EnqueueLetter(
654 borrowernumber => undef,
655 message_transport_type => 'email',
656 attachments => [$attachment],
657 to_address => $admin_email_address,
664 # note that we're not testing on $csv_fh to prevent closing
669 if ( defined $htmlfilename ) {
670 print $html_fh "</body>\n";
671 print $html_fh "</html>\n";
675 =head1 INTERNAL METHODS
677 These methods are internal to the operation of overdue_notices.pl.
681 parses the letter template, replacing the placeholders with data
682 specific to this patron, biblio, or item
685 letter - required hashref
686 borrowernumber - required integer
687 substitute - optional hashref of other key/value pairs that should
688 be substituted in the letter content
690 returns the C<letter> hashref, with the content updated to reflect the
691 substituted keys and values.
698 foreach my $required (qw( letter_code borrowernumber )) {
699 return unless ( exists $params->{$required} && $params->{$required} );
702 my $substitute = $params->{'substitute'} || {};
703 $substitute->{today} ||= C4::Dates->new()->output("syspref");
705 my %tables = ( 'borrowers' => $params->{'borrowernumber'} );
706 if ( my $p = $params->{'branchcode'} ) {
707 $tables{'branches'} = $p;
711 if ( defined $params->{'letter'}->{'content'}
712 and $params->{'letter'}->{'content'} =~ m/<fine>(.*)<\/fine>/o )
713 { # process any fine tags...
714 $currency_format = $1;
715 $params->{'letter'}->{'content'} =~ s/<fine>.*<\/fine>/<<item.fine>>/o;
719 if ( my $i = $params->{'items'} ) {
720 my $item_format = '';
721 foreach my $item (@$i) {
722 my $fine = GetFine($item->{'itemnumber'}, $params->{'borrowernumber'});
723 if ( !$item_format and defined $params->{'letter'}->{'content'} ) {
724 $params->{'letter'}->{'content'} =~ m/(<item>.*<\/item>)/;
728 $item->{'fine'} = currency_format($currency_format, "$fine", FMT_SYMBOL)
732 'biblio' => $item->{'biblionumber'},
733 'biblioitems' => $item->{'biblionumber'},
735 'issues' => $item->{'itemnumber'},
740 return C4::Letters::GetPreparedLetter (
741 module => 'circulation',
742 letter_code => $params->{'letter_code'},
743 branchcode => $params->{'branchcode'},
745 substitute => $substitute,
746 repeat => { item => \@item_tables },
750 =head2 prepare_letter_for_printing
752 returns a string of text appropriate for printing in the event that an
753 overdue notice will not be sent to the patron's email
754 address. Depending on the desired output format, this may be a CSV
755 string, or a human-readable representation of the notice.
766 sub prepare_letter_for_printing {
769 return unless ref $params eq 'HASH';
771 foreach my $required_parameter (qw( letter borrowernumber )) {
772 return unless defined $params->{$required_parameter};
776 if ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'csv' ) {
778 $params->{'firstname'}, $params->{'lastname'}, $params->{'address1'}, $params->{'address2'}, $params->{'postcode'},
779 $params->{'city'}, $params->{'country'}, $params->{'email'}, $params->{'itemcount'}, $params->{'titles'}
782 return $csv->string, "\n";
784 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
786 } elsif ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'html' ) {
788 $return .= "$params->{'letter'}->{'content'}\n";
789 $return .= "\n</pre>\n";
791 $return .= "$params->{'letter'}->{'content'}\n";
793 # $return .= Data::Dumper->Dump( [ $params->{'borrowernumber'}, $params->{'letter'} ], [qw( borrowernumber letter )] );