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
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
25 # find Koha's Perl modules
26 # test carefully before changing this
28 eval { require "$FindBin::Bin/../kohalib.pl" };
35 use DateTime::Duration;
37 use Koha::Script -cron;
40 use C4::Overdues qw(GetFine GetOverdueMessageTransportTypes parse_overdues_letter);
42 use Koha::Patron::Debarments qw(AddUniqueDebarment);
46 use Koha::Acquisition::Currencies;
51 overdue_notices.pl - prepare messages to be sent to patrons for overdue items
56 [ -n ][ -library <branchcode> ][ -library <branchcode> ... ]
57 [ -max <number of days> ][ -csv [<filename>] ][ -itemscontent <field list> ]
58 [ -email <email_type> ... ]
61 -help Brief help message.
62 -man Full documentation.
64 -n No email will be sent.
65 -max <days> Maximum days overdue to deal with.
66 -library <branchcode> Only deal with overdues from this library.
67 (repeatable : several libraries can be given)
68 -csv <filename> Populate CSV file.
69 -html <directory> Output html to a file in the given directory.
70 -text <directory> Output plain text to a file in the given directory.
71 -itemscontent <list of fields> Item information in templates.
72 -borcat <categorycode> Category code that must be included.
73 -borcatout <categorycode> Category code that must be excluded.
74 -t Only include triggered overdues.
75 --test Run in test mode. No changes will be made on the DB.
76 -list-all List all overdues.
77 -date <yyyy-mm-dd> Emulate overdues run for this date.
78 -email <email_type> Type of email that will be used.
79 Can be 'email', 'emailpro' or 'B_email'. Repeatable.
87 Print a brief help message and exits.
91 Prints the manual page and exits.
95 Verbose. Without this flag set, only fatal errors are reported.
99 Do not send any email. Overdue notices that would have been sent to
100 the patrons or to the admin are printed to standard out. CSV data (if
101 the -csv flag is set) is written to standard out or to any csv
106 Items older than max days are assumed to be handled somewhere else,
107 probably the F<longoverdues.pl> script. They are therefore ignored by
108 this program. No notices are sent for them, and they are not added to
109 any CSV files. Defaults to 90 to match F<longoverdues.pl>.
113 select overdues for one specific library. Use the value in the
114 branches.branchcode table. This option can be repeated in order
115 to select overdues for a group of libraries.
119 Produces CSV data. if -n (no mail) flag is set, then this CSV data is
120 sent to standard out or to a filename if provided. Otherwise, only
121 overdues that could not be emailed are sent in CSV format to the admin.
125 Produces html data. If patron does not have an email address or
126 -n (no mail) flag is set, an HTML file is generated in the specified
127 directory. This can be downloaded or further processed by library staff.
128 The file will be called notices-YYYY-MM-DD.html and placed in the directory
133 Produces plain text data. If patron does not have an email address or
134 -n (no mail) flag is set, a text file is generated in the specified
135 directory. This can be downloaded or further processed by library staff.
136 The file will be called notices-YYYY-MM-DD.txt and placed in the directory
139 =item B<-itemscontent>
141 comma separated list of fields that get substituted into templates in
142 places of the E<lt>E<lt>items.contentE<gt>E<gt> placeholder. This
143 defaults to due date,title,barcode,author
145 Other possible values come from fields in the biblios, items and
150 Repeatable field, that permits to select only some patron categories.
154 Repeatable field, that permits to exclude some patron categories.
156 =item B<-t> | B<--triggered>
158 This option causes a notice to be generated if and only if
159 an item is overdue by the number of days defined in a notice trigger.
161 By default, a notice is sent each time the script runs, which is suitable for
162 less frequent run cron script, but requires syncing notice triggers with
163 the cron schedule to ensure proper behavior.
164 Add the --triggered option for daily cron, at the risk of no notice
165 being generated if the cron fails to run on time.
169 This option makes the script run in test mode.
171 In test mode, the script won't make any changes on the DB. This is useful
172 for debugging configuration.
176 Default items.content lists only those items that fall in the
177 range of the currently processing notice.
178 Choose list-all to include all overdue items in the list (limited by B<-max> setting).
182 use it in order to send overdues on a specific date and not Now. Format: YYYY-MM-DD.
186 Allows to specify which type of email will be used. Can be email, emailpro or B_email. Repeatable.
192 This script is designed to alert patrons and administrators of overdue
197 This script pays attention to the overdue notice configuration
198 performed in the "Overdue notice/status triggers" section of the
199 "Tools" area of the staff interface to Koha. There, you can choose
200 which letter templates are sent out after a configurable number of
201 days to patrons of each library. More information about the use of this
202 section of Koha is available in the Koha manual.
204 The templates used to craft the emails are defined in the "Tools:
205 Notices" section of the staff interface to Koha.
207 =head2 Outgoing emails
209 Typically, messages are prepared for each patron with overdue
210 items. Messages for whom there is no email address on file are
211 collected and sent as attachments in a single email to each library
212 administrator, or if that is not set, then to the email address in the
213 C<KohaAdminEmailAddress> system preference.
215 These emails are staged in the outgoing message queue, as are messages
216 produced by other features of Koha. This message queue must be
217 processed regularly by the
218 F<misc/cronjobs/process_message_queue.pl> program.
220 In the event that the C<-n> flag is passed to this program, no emails
221 are sent. Instead, messages are sent on standard output from this
222 program. They may be redirected to a file if desired.
226 Templates can contain variables enclosed in double angle brackets like
227 E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
228 specific to the overdue items or relevant patron. Available variables
233 =item E<lt>E<lt>bibE<gt>E<gt>
235 the name of the library
237 =item E<lt>E<lt>items.contentE<gt>E<gt>
239 one line for each item, each line containing a tab separated list of
240 title, author, barcode, issuedate
242 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
244 any field from the borrowers table
246 =item E<lt>E<lt>branches.*E<gt>E<gt>
248 any field from the branches table
254 The C<-csv> command line option lets you specify a file to which
255 overdues data should be output in CSV format.
257 With the C<-n> flag set, data about all overdues is written to the
258 file. Without that flag, only information about overdues that were
259 unable to be sent directly to the patrons will be written. In other
260 words, this CSV file replaces the data that is typically sent to the
261 administrator email address.
263 =head1 USAGE EXAMPLES
265 C<overdue_notices.pl> - In this most basic usage, with no command line
266 arguments, all libraries are processed individually, and notices are
267 prepared for all patrons with overdue items for whom we have email
268 addresses. Messages for those patrons for whom we have no email
269 address are sent in a single attachment to the library administrator's
270 email address, or to the address in the KohaAdminEmailAddress system
273 C<overdue_notices.pl -n -csv /tmp/overdues.csv> - sends no email and
274 populates F</tmp/overdues.csv> with information about all overdue
277 C<overdue_notices.pl -library MAIN max 14> - prepare notices of
278 overdues in the last 2 weeks for the MAIN library.
282 The F<misc/cronjobs/advance_notices.pl> program allows you to send
283 messages to patrons in advance of their items becoming due, or to
284 alert them of items that have just become due.
288 # These variables are set by command line options.
289 # They are initially set to default values.
290 my $dbh = C4::Context->dbh();
297 my @branchcodes; # Branch(es) passed as parameter
298 my @emails_to_use; # Emails to use for messaging
299 my @emails; # Emails given in command-line parameters
305 my $itemscontent = join( ',', qw( date_due title barcode author itemnumber ) );
308 my ( $date_input, $today );
316 'library=s' => \@branchcodes,
317 'csv:s' => \$csvfilename, # this optional argument gets '' if not supplied.
318 'html:s' => \$htmlfilename, # this optional argument gets '' if not supplied.
319 'text:s' => \$text_filename, # this optional argument gets '' if not supplied.
320 'itemscontent=s' => \$itemscontent,
321 'list-all' => \$listall,
322 't|triggered' => \$triggered,
323 'test' => \$test_mode,
324 'date=s' => \$date_input,
325 'borcat=s' => \@myborcat,
326 'borcatout=s' => \@myborcatout,
327 'email=s' => \@emails,
329 pod2usage(1) if $help;
330 pod2usage( -verbose => 2 ) if $man;
331 cronlogaction() unless $test_mode;
333 if ( defined $csvfilename && $csvfilename =~ /^-/ ) {
334 warn qq(using "$csvfilename" as filename, that seems odd);
337 my @overduebranches = C4::Overdues::GetBranchcodesWithOverdueRules(); # Branches with overdue rules
338 my @branches; # Branches passed as parameter with overdue rules
339 my $branchcount = scalar(@overduebranches);
341 my $overduebranch_word = scalar @overduebranches > 1 ? 'branches' : 'branch';
342 my $branchcodes_word = scalar @branchcodes > 1 ? 'branches' : 'branch';
344 my $PrintNoticesMaxLines = C4::Context->preference('PrintNoticesMaxLines');
347 $verbose and warn "Found $branchcount $overduebranch_word with first message enabled: " . join( ', ', map { "'$_'" } @overduebranches ), "\n";
349 die 'No branches with active overduerules';
353 $verbose and warn "$branchcodes_word @branchcodes passed on parameter\n";
355 # Getting libraries which have overdue rules
356 my %seen = map { $_ => 1 } @branchcodes;
357 @branches = grep { $seen{$_} } @overduebranches;
362 my $branch_word = scalar @branches > 1 ? 'branches' : 'branch';
363 $verbose and warn "$branch_word @branches have overdue rules\n";
367 $verbose and warn "No active overduerules for $branchcodes_word '@branchcodes'\n";
368 ( scalar grep { '' eq $_ } @branches )
369 or die "No active overduerules for DEFAULT either!";
370 $verbose and warn "Falling back on default rules for @branchcodes\n";
378 $date_to_run = dt_from_string( $date_input, 'iso' );
380 die "$date_input is not a valid date, aborting! Use a date in format YYYY-MM-DD."
381 if $@ or not $date_to_run;
383 # It's certainly useless to escape $date_input
384 # dt_from_string should not return something if $date_input is not correctly set.
385 $date = $dbh->quote( $date_input );
389 $date_to_run = dt_from_string();
392 # these are the fields that will be substituted into <<item.content>>
393 my @item_content_fields = split( /,/, $itemscontent );
395 binmode( STDOUT, ':encoding(UTF-8)' );
398 our $csv; # the Text::CSV_XS object
399 our $csv_fh; # the filehandle to the CSV file.
400 if ( defined $csvfilename ) {
401 my $sep_char = C4::Context->preference('delimiter') || ';';
402 $sep_char = "\t" if ($sep_char eq 'tabulation');
403 $csv = Text::CSV_XS->new( { binary => 1 , sep_char => $sep_char } );
404 if ( $csvfilename eq '' ) {
407 open $csv_fh, ">", $csvfilename or die "unable to open $csvfilename: $!";
409 if ( $csv->combine(qw(name surname address1 address2 zipcode city country email phone cardnumber itemcount itemsinfo branchname letternumber)) ) {
410 print $csv_fh $csv->string, "\n";
412 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
416 @branches = @overduebranches unless @branches;
418 if ( defined $htmlfilename ) {
419 if ( $htmlfilename eq '' ) {
422 my $today = dt_from_string();
423 open $fh, ">:encoding(UTF-8)",File::Spec->catdir ($htmlfilename,"notices-".$today->ymd().".html");
426 print $fh "<html>\n";
427 print $fh "<head>\n";
428 print $fh "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
429 print $fh "<style type='text/css'>\n";
430 print $fh "pre {page-break-after: always;}\n";
431 print $fh "pre {white-space: pre-wrap;}\n";
432 print $fh "pre {white-space: -moz-pre-wrap;}\n";
433 print $fh "pre {white-space: -o-pre-wrap;}\n";
434 print $fh "pre {word-wrap: break-work;}\n";
435 print $fh "</style>\n";
436 print $fh "</head>\n";
437 print $fh "<body>\n";
439 elsif ( defined $text_filename ) {
440 if ( $text_filename eq '' ) {
443 my $today = dt_from_string();
444 open $fh, ">:encoding(UTF-8)",File::Spec->catdir ($text_filename,"notices-".$today->ymd().".txt");
448 foreach my $branchcode (@branches) {
450 if ( C4::Context->preference('OverdueNoticeCalendar') ) {
451 $calendar = Koha::Calendar->new( branchcode => $branchcode );
452 if ( $calendar->is_holiday($date_to_run) ) {
457 my $library = Koha::Libraries->find($branchcode);
458 my $admin_email_address = $library->branchemail
459 || C4::Context->preference('KohaAdminEmailAddress');
460 my $branch_email_address = C4::Context->preference('AddressForFailedOverdueNotices')
461 || $library->inbound_email_address;
462 my @output_chunks; # may be sent to mail or stdout or csv file.
464 $verbose and warn sprintf "branchcode : '%s' using %s\n", $branchcode, $branch_email_address;
466 my $sth2 = $dbh->prepare( <<"END_SQL" );
467 SELECT biblio.*, items.*, issues.*, biblioitems.itemtype, branchname
468 FROM issues,items,biblio, biblioitems, branches b
469 WHERE items.itemnumber=issues.itemnumber
470 AND biblio.biblionumber = items.biblionumber
471 AND b.branchcode = items.homebranch
472 AND biblio.biblionumber = biblioitems.biblionumber
473 AND issues.borrowernumber = ?
474 AND issues.branchcode = ?
475 AND items.itemlost = 0
476 AND TO_DAYS($date)-TO_DAYS(issues.date_due) >= 0
479 my $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = ? ";
480 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
481 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
483 my $rqoverduerules = $dbh->prepare($query);
484 $rqoverduerules->execute($branchcode, @myborcat, @myborcatout);
486 # We get default rules is there is no rule for this branch
487 if($rqoverduerules->rows == 0){
488 $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = '' ";
489 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
490 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
492 $rqoverduerules = $dbh->prepare($query);
493 $rqoverduerules->execute(@myborcat, @myborcatout);
496 # my $outfile = 'overdues_' . ( $mybranch || $branchcode || 'default' );
497 while ( my $overdue_rules = $rqoverduerules->fetchrow_hashref ) {
498 PERIOD: foreach my $i ( 1 .. 3 ) {
500 $verbose and warn "branch '$branchcode', categorycode = $overdue_rules->{categorycode} pass $i\n";
502 my $mindays = $overdue_rules->{"delay$i"}; # the notice will be sent after mindays days (grace period)
504 $overdue_rules->{ "delay" . ( $i + 1 ) }
505 ? $overdue_rules->{ "delay" . ( $i + 1 ) } - 1
507 ); # issues being more than maxdays late are managed somewhere else. (borrower probably suspended)
509 next unless defined $mindays;
511 if ( !$overdue_rules->{"letter$i"} ) {
512 $verbose and warn "No letter$i code for branch '$branchcode'";
516 # $letter->{'content'} is the text of the mail that is sent.
517 # this text contains fields that are replaced by their value. Those fields must be written between brackets
518 # The following fields are available :
519 # 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).
520 # <date> <itemcount> <firstname> <lastname> <address1> <address2> <address3> <city> <postcode> <country>
522 my $borrower_sql = <<"END_SQL";
523 SELECT issues.borrowernumber, firstname, surname, address, address2, city, zipcode, country, email, emailpro, B_email, smsalertnumber, phone, cardnumber, date_due
524 FROM issues,borrowers,categories,items
525 WHERE issues.borrowernumber=borrowers.borrowernumber
526 AND borrowers.categorycode=categories.categorycode
527 AND issues.itemnumber = items.itemnumber
528 AND items.itemlost = 0
529 AND TO_DAYS($date)-TO_DAYS(issues.date_due) >= 0
531 my @borrower_parameters;
533 $borrower_sql .= ' AND issues.branchcode=? ';
534 push @borrower_parameters, $branchcode;
536 if ( $overdue_rules->{categorycode} ) {
537 $borrower_sql .= ' AND borrowers.categorycode=? ';
538 push @borrower_parameters, $overdue_rules->{categorycode};
540 $borrower_sql .= ' AND categories.overduenoticerequired=1 ORDER BY issues.borrowernumber';
542 # $sth gets borrower info iff at least one overdue item has triggered the overdue action.
543 my $sth = $dbh->prepare($borrower_sql);
544 $sth->execute(@borrower_parameters);
546 $verbose and warn $borrower_sql . "\n $branchcode | " . $overdue_rules->{'categorycode'} . "\n ($mindays, $maxdays, ". $date_to_run->datetime() .")\nreturns " . $sth->rows . " rows";
548 while ( my $data = $sth->fetchrow_hashref ) {
550 # check the borrower has at least one item that matches
552 if ( C4::Context->preference('OverdueNoticeCalendar') )
555 $calendar->days_between( dt_from_string($data->{date_due}),
560 $date_to_run->delta_days( dt_from_string($data->{date_due}) );
562 $days_between = $days_between->in_units('days');
564 if ( $mindays != $days_between ) {
569 unless ( $days_between >= $mindays
570 && $days_between <= $maxdays )
575 if (defined $borrowernumber && $borrowernumber eq $data->{'borrowernumber'}){
576 # we have already dealt with this borrower
577 $verbose and warn "already dealt with this borrower $borrowernumber";
580 $borrowernumber = $data->{'borrowernumber'};
581 my $borr = sprintf( "%s%s%s (%s)",
582 $data->{'surname'} || '',
583 $data->{'firstname'} && $data->{'surname'} ? ', ' : '',
584 $data->{'firstname'} || '',
587 and warn "borrower $borr has items triggering level $i.";
589 my $patron = Koha::Patrons->find( $borrowernumber );
591 my $notice_email = $patron->notice_email_address;
595 push @emails_to_use, $data->{$_} if ( $data->{$_} );
599 push @emails_to_use, $notice_email if ($notice_email);
603 my $letter = C4::Letters::getletter( 'circulation', $overdue_rules->{"letter$i"}, $branchcode, undef, $patron->lang )
604 || C4::Letters::getletter( 'circulation', $overdue_rules->{"letter$i"}, $branchcode, undef, "default");
607 $verbose and warn qq|Message '$overdue_rules->{"letter$i"}' content not found|;
609 # might as well skip while PERIOD, no other borrowers are going to work.
610 # FIXME : Does this mean a letter must be defined in order to trigger a debar ?
614 if ( $overdue_rules->{"debarred$i"} ) {
616 #action taken is debarring
619 borrowernumber => $borrowernumber,
621 comment => "OVERDUES_PROCESS " . output_pref( dt_from_string() ),
624 $verbose and warn "debarring $borr\n";
626 my @params = ($borrowernumber,$branchcode);
627 $verbose and warn "STH2 PARAMS: borrowernumber = $borrowernumber";
629 $sth2->execute(@params);
635 my $exceededPrintNoticesMaxLines = 0;
636 while ( my $item_info = $sth2->fetchrow_hashref() ) {
637 if ( C4::Context->preference('OverdueNoticeCalendar') ) {
639 $calendar->days_between(
640 dt_from_string( $item_info->{date_due} ), $date_to_run );
644 $date_to_run->delta_days(
645 dt_from_string( $item_info->{date_due} ) );
647 $days_between = $days_between->in_units('days');
649 unless ($days_between >= 1 and $days_between <= $MAX){
655 if ( $mindays != $days_between ) {
660 unless ( $days_between >= $mindays
661 && $days_between <= $maxdays )
668 if ( ( scalar(@emails_to_use) == 0 || $nomail ) && $PrintNoticesMaxLines && $j >= $PrintNoticesMaxLines ) {
669 $exceededPrintNoticesMaxLines = 1;
674 $titles .= C4::Letters::get_item_content( { item => $item_info, item_content_fields => \@item_content_fields, dateonly => 1 } );
676 push @items, $item_info;
680 my @message_transport_types = @{ GetOverdueMessageTransportTypes( $branchcode, $overdue_rules->{categorycode}, $i) };
681 @message_transport_types = @{ GetOverdueMessageTransportTypes( q{}, $overdue_rules->{categorycode}, $i) }
682 unless @message_transport_types;
685 my $print_sent = 0; # A print notice is not yet sent for this patron
686 for my $mtt ( @message_transport_types ) {
687 my $effective_mtt = $mtt;
688 if ( ($mtt eq 'email' and not scalar @emails_to_use) or ($mtt eq 'sms' and not $data->{smsalertnumber}) ) {
689 # email or sms is requested but not exist, do a print.
690 $effective_mtt = 'print';
692 splice @items, $PrintNoticesMaxLines if $effective_mtt eq 'print' && $PrintNoticesMaxLines && scalar @items > $PrintNoticesMaxLines;
693 #catch the case where we are sending a print to someone with an email
695 my $letter_exists = ( C4::Letters::getletter( 'circulation', $overdue_rules->{"letter$i"}, $branchcode, $effective_mtt, $patron->lang )
696 || C4::Letters::getletter( 'circulation', $overdue_rules->{"letter$i"}, $branchcode, $effective_mtt, "default") ) ? 1 : 0;
697 my $letter = parse_overdues_letter(
698 { letter_code => $overdue_rules->{"letter$i"},
699 borrowernumber => $borrowernumber,
700 branchcode => $branchcode,
702 substitute => { # this appears to be a hack to overcome incomplete features in this code.
703 bib => $library->branchname, # maybe 'bib' is a typo for 'lib<rary>'?
704 'items.content' => $titles,
705 'count' => $itemcount,
707 # If there is no template defined for the requested letter
708 # Fallback on the original type
709 message_transport_type => $letter_exists ? $effective_mtt : $mtt,
712 unless ($letter && $letter->{content}) {
713 $verbose and warn qq|Message '$overdue_rules->{"letter$i"}' content not found|;
714 # this transport doesn't have a configured notice, so try another
718 if ( $exceededPrintNoticesMaxLines ) {
719 $letter->{'content'} .= "List too long for form; please check your account online for a complete list of your overdue items.";
722 my @misses = grep { /./ } map { /^([^>]*)[>]+/; ( $1 || '' ); } split /\</, $letter->{'content'};
724 $verbose and warn "The following terms were not matched and replaced: \n\t" . join "\n\t", @misses;
729 prepare_letter_for_printing(
731 borrowernumber => $borrowernumber,
732 firstname => $data->{'firstname'},
733 lastname => $data->{'surname'},
734 address1 => $data->{'address'},
735 address2 => $data->{'address2'},
736 city => $data->{'city'},
737 phone => $data->{'phone'},
738 cardnumber => $data->{'cardnumber'},
739 branchname => $library->branchname,
741 postcode => $data->{'zipcode'},
742 country => $data->{'country'},
743 email => $notice_email,
744 itemcount => $itemcount,
746 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : defined $text_filename ? 'text' : '',
750 if ( ($mtt eq 'email' and not scalar @emails_to_use) or ($mtt eq 'sms' and not $data->{smsalertnumber}) ) {
752 prepare_letter_for_printing(
754 borrowernumber => $borrowernumber,
755 firstname => $data->{'firstname'},
756 lastname => $data->{'surname'},
757 address1 => $data->{'address'},
758 address2 => $data->{'address2'},
759 city => $data->{'city'},
760 postcode => $data->{'zipcode'},
761 country => $data->{'country'},
762 email => $notice_email,
763 itemcount => $itemcount,
765 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : defined $text_filename ? 'text' : '',
769 unless ( $effective_mtt eq 'print' and $print_sent == 1 ) {
770 # Just sent a print if not already done.
771 C4::Letters::EnqueueLetter(
773 borrowernumber => $borrowernumber,
774 message_transport_type => $effective_mtt,
775 from_address => $admin_email_address,
776 to_address => join(',', @emails_to_use),
779 # A print notice should be sent only once per overdue level.
780 # Without this check, a print could be sent twice or more if the library checks sms and email and print and the patron has no email or sms number.
781 $print_sent = 1 if $effective_mtt eq 'print';
790 if (@output_chunks) {
791 if ( defined $csvfilename ) {
792 print $csv_fh @output_chunks;
794 elsif ( defined $htmlfilename ) {
795 print $fh @output_chunks;
797 elsif ( defined $text_filename ) {
798 print $fh @output_chunks;
801 local $, = "\f"; # pagebreak
802 print @output_chunks;
804 # Generate the content of the csv with headers
806 if ( defined $csvfilename ) {
807 my $delimiter = C4::Context->preference('delimiter') || ';';
808 $content = join($delimiter, qw(title name surname address1 address2 zipcode city country email itemcount itemsinfo due_date issue_date)) . "\n";
813 $content .= join( "\n", @output_chunks );
816 filename => defined $csvfilename ? 'attachment.csv' : 'attachment.txt',
817 type => 'text/plain',
822 title => 'Overdue Notices',
823 content => 'These messages were not sent directly to the patrons.',
826 C4::Letters::EnqueueLetter(
828 borrowernumber => undef,
829 message_transport_type => 'email',
830 attachments => [$attachment],
831 to_address => $branch_email_address,
838 # note that we're not testing on $csv_fh to prevent closing
843 if ( defined $htmlfilename ) {
844 print $fh "</body>\n";
845 print $fh "</html>\n";
847 } elsif ( defined $text_filename ) {
851 =head1 INTERNAL METHODS
853 These methods are internal to the operation of overdue_notices.pl.
855 =head2 prepare_letter_for_printing
857 returns a string of text appropriate for printing in the event that an
858 overdue notice will not be sent to the patron's email
859 address. Depending on the desired output format, this may be a CSV
860 string, or a human-readable representation of the notice.
871 sub prepare_letter_for_printing {
874 return unless ref $params eq 'HASH';
876 foreach my $required_parameter (qw( letter borrowernumber )) {
877 return unless defined $params->{$required_parameter};
881 chomp $params->{titles};
882 if ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'csv' ) {
884 $params->{'firstname'}, $params->{'lastname'}, $params->{'address1'}, $params->{'address2'}, $params->{'postcode'},
885 $params->{'city'}, $params->{'country'}, $params->{'email'}, $params->{'phone'}, $params->{'cardnumber'},
886 $params->{'itemcount'}, $params->{'titles'}, $params->{'branchname'}, $params->{'letternumber'}
889 return $csv->string, "\n";
891 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
893 } elsif ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'html' ) {
895 $return .= "$params->{'letter'}->{'content'}\n";
896 $return .= "\n</pre>\n";
898 $return .= "$params->{'letter'}->{'content'}\n";
900 # $return .= Data::Dumper->Dump( [ $params->{'borrowernumber'}, $params->{'letter'} ], [qw( borrowernumber letter )] );