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.
80 --frombranch Set the from address for the notice to one of 'item-homebranch' or 'item-issuebranch'.
88 Print a brief help message and exits.
92 Prints the manual page and exits.
96 Verbose. Without this flag set, only fatal errors are reported.
100 Do not send any email. Overdue notices that would have been sent to
101 the patrons or to the admin are printed to standard out. CSV data (if
102 the -csv flag is set) is written to standard out or to any csv
107 Items older than max days are assumed to be handled somewhere else,
108 probably the F<longoverdues.pl> script. They are therefore ignored by
109 this program. No notices are sent for them, and they are not added to
110 any CSV files. Defaults to 90 to match F<longoverdues.pl>.
114 select overdues for one specific library. Use the value in the
115 branches.branchcode table. This option can be repeated in order
116 to select overdues for a group of libraries.
120 Produces CSV data. if -n (no mail) flag is set, then this CSV data is
121 sent to standard out or to a filename if provided. Otherwise, only
122 overdues that could not be emailed are sent in CSV format to the admin.
126 Produces html data. If patron does not have an email address or
127 -n (no mail) flag is set, an HTML file is generated in the specified
128 directory. This can be downloaded or further processed by library staff.
129 The file will be called notices-YYYY-MM-DD.html and placed in the directory
134 Produces plain text data. If patron does not have an email address or
135 -n (no mail) flag is set, a text file is generated in the specified
136 directory. This can be downloaded or further processed by library staff.
137 The file will be called notices-YYYY-MM-DD.txt and placed in the directory
140 =item B<-itemscontent>
142 comma separated list of fields that get substituted into templates in
143 places of the E<lt>E<lt>items.contentE<gt>E<gt> placeholder. This
144 defaults to due date,title,barcode,author
146 Other possible values come from fields in the biblios, items and
151 Repeatable field, that permits to select only some patron categories.
155 Repeatable field, that permits to exclude some patron categories.
157 =item B<-t> | B<--triggered>
159 This option causes a notice to be generated if and only if
160 an item is overdue by the number of days defined in a notice trigger.
162 By default, a notice is sent each time the script runs, which is suitable for
163 less frequent run cron script, but requires syncing notice triggers with
164 the cron schedule to ensure proper behavior.
165 Add the --triggered option for daily cron, at the risk of no notice
166 being generated if the cron fails to run on time.
170 This option makes the script run in test mode.
172 In test mode, the script won't make any changes on the DB. This is useful
173 for debugging configuration.
177 Default items.content lists only those items that fall in the
178 range of the currently processing notice.
179 Choose list-all to include all overdue items in the list (limited by B<-max> setting).
183 use it in order to send overdues on a specific date and not Now. Format: YYYY-MM-DD.
187 Allows to specify which type of email will be used. Can be email, emailpro or B_email. Repeatable.
189 =item B<--frombranch>
191 Use the address information from the item homebranch library instead of the issuing library.
193 Defaults to 'item-issuebranch'
199 This script is designed to alert patrons and administrators of overdue
204 This script pays attention to the overdue notice configuration
205 performed in the "Overdue notice/status triggers" section of the
206 "Tools" area of the staff interface to Koha. There, you can choose
207 which letter templates are sent out after a configurable number of
208 days to patrons of each library. More information about the use of this
209 section of Koha is available in the Koha manual.
211 The templates used to craft the emails are defined in the "Tools:
212 Notices" section of the staff interface to Koha.
214 =head2 Outgoing emails
216 Typically, messages are prepared for each patron with overdue
217 items. Messages for whom there is no email address on file are
218 collected and sent as attachments in a single email to each library
219 administrator, or if that is not set, then to the email address in the
220 C<KohaAdminEmailAddress> system preference.
222 These emails are staged in the outgoing message queue, as are messages
223 produced by other features of Koha. This message queue must be
224 processed regularly by the
225 F<misc/cronjobs/process_message_queue.pl> program.
227 In the event that the C<-n> flag is passed to this program, no emails
228 are sent. Instead, messages are sent on standard output from this
229 program. They may be redirected to a file if desired.
233 Templates can contain variables enclosed in double angle brackets like
234 E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
235 specific to the overdue items or relevant patron. Available variables
240 =item E<lt>E<lt>bibE<gt>E<gt>
242 the name of the library
244 =item E<lt>E<lt>items.contentE<gt>E<gt>
246 one line for each item, each line containing a tab separated list of
247 title, author, barcode, issuedate
249 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
251 any field from the borrowers table
253 =item E<lt>E<lt>branches.*E<gt>E<gt>
255 any field from the branches table
261 The C<-csv> command line option lets you specify a file to which
262 overdues data should be output in CSV format.
264 With the C<-n> flag set, data about all overdues is written to the
265 file. Without that flag, only information about overdues that were
266 unable to be sent directly to the patrons will be written. In other
267 words, this CSV file replaces the data that is typically sent to the
268 administrator email address.
270 =head1 USAGE EXAMPLES
272 C<overdue_notices.pl> - In this most basic usage, with no command line
273 arguments, all libraries are processed individually, and notices are
274 prepared for all patrons with overdue items for whom we have email
275 addresses. Messages for those patrons for whom we have no email
276 address are sent in a single attachment to the library administrator's
277 email address, or to the address in the KohaAdminEmailAddress system
280 C<overdue_notices.pl -n -csv /tmp/overdues.csv> - sends no email and
281 populates F</tmp/overdues.csv> with information about all overdue
284 C<overdue_notices.pl -library MAIN max 14> - prepare notices of
285 overdues in the last 2 weeks for the MAIN library.
289 The F<misc/cronjobs/advance_notices.pl> program allows you to send
290 messages to patrons in advance of their items becoming due, or to
291 alert them of items that have just become due.
295 # These variables are set by command line options.
296 # They are initially set to default values.
297 my $dbh = C4::Context->dbh();
304 my $frombranch = 'item-issuebranch';
305 my @branchcodes; # Branch(es) passed as parameter
306 my @emails_to_use; # Emails to use for messaging
307 my @emails; # Emails given in command-line parameters
313 my $itemscontent = join( ',', qw( date_due title barcode author itemnumber ) );
316 my ( $date_input, $today );
324 'library=s' => \@branchcodes,
325 'csv:s' => \$csvfilename, # this optional argument gets '' if not supplied.
326 'html:s' => \$htmlfilename, # this optional argument gets '' if not supplied.
327 'text:s' => \$text_filename, # this optional argument gets '' if not supplied.
328 'itemscontent=s' => \$itemscontent,
329 'list-all' => \$listall,
330 't|triggered' => \$triggered,
331 'test' => \$test_mode,
332 'date=s' => \$date_input,
333 'borcat=s' => \@myborcat,
334 'borcatout=s' => \@myborcatout,
335 'email=s' => \@emails,
336 'frombranch=s' => \$frombranch,
338 pod2usage(1) if $help;
339 pod2usage( -verbose => 2 ) if $man;
340 cronlogaction() unless $test_mode;
342 if ( defined $csvfilename && $csvfilename =~ /^-/ ) {
343 warn qq(using "$csvfilename" as filename, that seems odd);
346 die "--frombranch takes item-homebranch or item-issuebranch only"
347 unless ( $frombranch eq 'item-issuebranch'
348 || $frombranch eq 'item-homebranch' );
349 my $owning_library = ( $frombranch eq 'item-homebranch' ) ? 1 : 0;
351 my @overduebranches = C4::Overdues::GetBranchcodesWithOverdueRules(); # Branches with overdue rules
352 my @branches; # Branches passed as parameter with overdue rules
353 my $branchcount = scalar(@overduebranches);
355 my $overduebranch_word = scalar @overduebranches > 1 ? 'branches' : 'branch';
356 my $branchcodes_word = scalar @branchcodes > 1 ? 'branches' : 'branch';
358 my $PrintNoticesMaxLines = C4::Context->preference('PrintNoticesMaxLines');
361 $verbose and warn "Found $branchcount $overduebranch_word with first message enabled: " . join( ', ', map { "'$_'" } @overduebranches ), "\n";
363 die 'No branches with active overduerules';
367 $verbose and warn "$branchcodes_word @branchcodes passed on parameter\n";
369 # Getting libraries which have overdue rules
370 my %seen = map { $_ => 1 } @branchcodes;
371 @branches = grep { $seen{$_} } @overduebranches;
376 my $branch_word = scalar @branches > 1 ? 'branches' : 'branch';
377 $verbose and warn "$branch_word @branches have overdue rules\n";
381 $verbose and warn "No active overduerules for $branchcodes_word '@branchcodes'\n";
382 ( scalar grep { '' eq $_ } @branches )
383 or die "No active overduerules for DEFAULT either!";
384 $verbose and warn "Falling back on default rules for @branchcodes\n";
392 $date_to_run = dt_from_string( $date_input, 'iso' );
394 die "$date_input is not a valid date, aborting! Use a date in format YYYY-MM-DD."
395 if $@ or not $date_to_run;
397 # It's certainly useless to escape $date_input
398 # dt_from_string should not return something if $date_input is not correctly set.
399 $date = $dbh->quote( $date_input );
403 $date_to_run = dt_from_string();
406 # these are the fields that will be substituted into <<item.content>>
407 my @item_content_fields = split( /,/, $itemscontent );
409 binmode( STDOUT, ':encoding(UTF-8)' );
412 our $csv; # the Text::CSV_XS object
413 our $csv_fh; # the filehandle to the CSV file.
414 if ( defined $csvfilename ) {
415 my $sep_char = C4::Context->preference('CSVDelimiter') || ';';
416 $sep_char = "\t" if ($sep_char eq 'tabulation');
417 $csv = Text::CSV_XS->new( { binary => 1 , sep_char => $sep_char } );
418 if ( $csvfilename eq '' ) {
421 open $csv_fh, ">", $csvfilename or die "unable to open $csvfilename: $!";
423 if ( $csv->combine(qw(name surname address1 address2 zipcode city country email phone cardnumber itemcount itemsinfo branchname letternumber)) ) {
424 print $csv_fh $csv->string, "\n";
426 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
430 @branches = @overduebranches unless @branches;
432 if ( defined $htmlfilename ) {
433 if ( $htmlfilename eq '' ) {
436 my $today = dt_from_string();
437 open $fh, ">:encoding(UTF-8)",File::Spec->catdir ($htmlfilename,"notices-".$today->ymd().".html");
440 print $fh "<html>\n";
441 print $fh "<head>\n";
442 print $fh "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
443 print $fh "<style type='text/css'>\n";
444 print $fh "pre {page-break-after: always;}\n";
445 print $fh "pre {white-space: pre-wrap;}\n";
446 print $fh "pre {white-space: -moz-pre-wrap;}\n";
447 print $fh "pre {white-space: -o-pre-wrap;}\n";
448 print $fh "pre {word-wrap: break-work;}\n";
449 print $fh "</style>\n";
450 print $fh "</head>\n";
451 print $fh "<body>\n";
453 elsif ( defined $text_filename ) {
454 if ( $text_filename eq '' ) {
457 my $today = dt_from_string();
458 open $fh, ">:encoding(UTF-8)",File::Spec->catdir ($text_filename,"notices-".$today->ymd().".txt");
462 foreach my $branchcode (@branches) {
464 if ( C4::Context->preference('OverdueNoticeCalendar') ) {
465 $calendar = Koha::Calendar->new( branchcode => $branchcode );
466 if ( $calendar->is_holiday($date_to_run) ) {
471 my $library = Koha::Libraries->find($branchcode);
472 my $admin_email_address = $library->branchemail
473 || C4::Context->preference('KohaAdminEmailAddress');
474 my $branch_email_address = C4::Context->preference('AddressForFailedOverdueNotices')
475 || $library->inbound_email_address;
476 my @output_chunks; # may be sent to mail or stdout or csv file.
478 $verbose and warn sprintf "branchcode : '%s' using %s\n", $branchcode, $branch_email_address;
480 my $sql2 = <<"END_SQL";
481 SELECT biblio.*, items.*, issues.*, biblioitems.itemtype, branchname
482 FROM issues,items,biblio, biblioitems, branches b
483 WHERE items.itemnumber=issues.itemnumber
484 AND biblio.biblionumber = items.biblionumber
485 AND b.branchcode = items.homebranch
486 AND biblio.biblionumber = biblioitems.biblionumber
487 AND issues.borrowernumber = ?
488 AND items.itemlost = 0
489 AND TO_DAYS($date)-TO_DAYS(issues.date_due) >= 0
492 if($owning_library) {
493 $sql2 .= ' AND items.homebranch = ? ';
495 $sql2 .= ' AND issues.branchcode = ? ';
497 my $sth2 = $dbh->prepare($sql2);
499 my $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = ? ";
500 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
501 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
503 my $rqoverduerules = $dbh->prepare($query);
504 $rqoverduerules->execute($branchcode, @myborcat, @myborcatout);
506 # We get default rules is there is no rule for this branch
507 if($rqoverduerules->rows == 0){
508 $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = '' ";
509 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
510 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
512 $rqoverduerules = $dbh->prepare($query);
513 $rqoverduerules->execute(@myborcat, @myborcatout);
516 # my $outfile = 'overdues_' . ( $mybranch || $branchcode || 'default' );
517 while ( my $overdue_rules = $rqoverduerules->fetchrow_hashref ) {
518 PERIOD: foreach my $i ( 1 .. 3 ) {
520 $verbose and warn "branch '$branchcode', categorycode = $overdue_rules->{categorycode} pass $i\n";
522 my $mindays = $overdue_rules->{"delay$i"}; # the notice will be sent after mindays days (grace period)
524 $overdue_rules->{ "delay" . ( $i + 1 ) }
525 ? $overdue_rules->{ "delay" . ( $i + 1 ) } - 1
527 ); # issues being more than maxdays late are managed somewhere else. (borrower probably suspended)
529 next unless defined $mindays;
531 if ( !$overdue_rules->{"letter$i"} ) {
532 $verbose and warn "No letter$i code for branch '$branchcode'";
536 # $letter->{'content'} is the text of the mail that is sent.
537 # this text contains fields that are replaced by their value. Those fields must be written between brackets
538 # The following fields are available :
539 # 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).
540 # <date> <itemcount> <firstname> <lastname> <address1> <address2> <address3> <city> <postcode> <country>
542 my $borrower_sql = <<"END_SQL";
543 SELECT issues.borrowernumber, firstname, surname, address, address2, city, zipcode, country, email, emailpro, B_email, smsalertnumber, phone, cardnumber, date_due
544 FROM issues,borrowers,categories,items
545 WHERE issues.borrowernumber=borrowers.borrowernumber
546 AND borrowers.categorycode=categories.categorycode
547 AND issues.itemnumber = items.itemnumber
548 AND items.itemlost = 0
549 AND TO_DAYS($date)-TO_DAYS(issues.date_due) >= 0
551 my @borrower_parameters;
553 if($owning_library) {
554 $borrower_sql .= ' AND items.homebranch=? ';
556 $borrower_sql .= ' AND issues.branchcode=? ';
558 push @borrower_parameters, $branchcode;
560 if ( $overdue_rules->{categorycode} ) {
561 $borrower_sql .= ' AND borrowers.categorycode=? ';
562 push @borrower_parameters, $overdue_rules->{categorycode};
564 $borrower_sql .= ' AND categories.overduenoticerequired=1 ORDER BY issues.borrowernumber';
566 # $sth gets borrower info iff at least one overdue item has triggered the overdue action.
567 my $sth = $dbh->prepare($borrower_sql);
568 $sth->execute(@borrower_parameters);
570 $verbose and warn $borrower_sql . "\n $branchcode | " . $overdue_rules->{'categorycode'} . "\n ($mindays, $maxdays, ". $date_to_run->datetime() .")\nreturns " . $sth->rows . " rows";
572 while ( my $data = $sth->fetchrow_hashref ) {
574 # check the borrower has at least one item that matches
576 if ( C4::Context->preference('OverdueNoticeCalendar') )
579 $calendar->days_between( dt_from_string($data->{date_due}),
584 $date_to_run->delta_days( dt_from_string($data->{date_due}) );
586 $days_between = $days_between->in_units('days');
588 if ( $mindays != $days_between ) {
593 unless ( $days_between >= $mindays
594 && $days_between <= $maxdays )
599 if (defined $borrowernumber && $borrowernumber eq $data->{'borrowernumber'}){
600 # we have already dealt with this borrower
601 $verbose and warn "already dealt with this borrower $borrowernumber";
604 $borrowernumber = $data->{'borrowernumber'};
605 my $borr = sprintf( "%s%s%s (%s)",
606 $data->{'surname'} || '',
607 $data->{'firstname'} && $data->{'surname'} ? ', ' : '',
608 $data->{'firstname'} || '',
611 and warn "borrower $borr has items triggering level $i.";
613 my $patron = Koha::Patrons->find( $borrowernumber );
615 my $notice_email = $patron->notice_email_address;
619 push @emails_to_use, $data->{$_} if ( $data->{$_} );
623 push @emails_to_use, $notice_email if ($notice_email);
627 my $letter = C4::Letters::getletter( 'circulation', $overdue_rules->{"letter$i"}, $branchcode, undef, $patron->lang );
630 $verbose and warn qq|Message '$overdue_rules->{"letter$i"}' content not found|;
632 # might as well skip while PERIOD, no other borrowers are going to work.
633 # FIXME : Does this mean a letter must be defined in order to trigger a debar ?
637 if ( $overdue_rules->{"debarred$i"} ) {
639 #action taken is debarring
642 borrowernumber => $borrowernumber,
644 comment => "OVERDUES_PROCESS " . output_pref( dt_from_string() ),
647 $verbose and warn "debarring $borr\n";
649 my @params = ($borrowernumber,$branchcode);
650 $verbose and warn "STH2 PARAMS: borrowernumber = $borrowernumber";
652 $sth2->execute(@params);
658 my $exceededPrintNoticesMaxLines = 0;
659 while ( my $item_info = $sth2->fetchrow_hashref() ) {
660 if ( C4::Context->preference('OverdueNoticeCalendar') ) {
662 $calendar->days_between(
663 dt_from_string( $item_info->{date_due} ), $date_to_run );
667 $date_to_run->delta_days(
668 dt_from_string( $item_info->{date_due} ) );
670 $days_between = $days_between->in_units('days');
672 unless ($days_between >= 1 and $days_between <= $MAX){
678 if ( $mindays != $days_between ) {
683 unless ( $days_between >= $mindays
684 && $days_between <= $maxdays )
691 if ( ( scalar(@emails_to_use) == 0 || $nomail ) && $PrintNoticesMaxLines && $j >= $PrintNoticesMaxLines ) {
692 $exceededPrintNoticesMaxLines = 1;
697 $titles .= C4::Letters::get_item_content( { item => $item_info, item_content_fields => \@item_content_fields, dateonly => 1 } );
699 push @items, $item_info;
703 my @message_transport_types = @{ GetOverdueMessageTransportTypes( $branchcode, $overdue_rules->{categorycode}, $i) };
704 @message_transport_types = @{ GetOverdueMessageTransportTypes( q{}, $overdue_rules->{categorycode}, $i) }
705 unless @message_transport_types;
708 my $print_sent = 0; # A print notice is not yet sent for this patron
709 for my $mtt ( @message_transport_types ) {
710 my $effective_mtt = $mtt;
711 if ( ($mtt eq 'email' and not scalar @emails_to_use) or ($mtt eq 'sms' and not $data->{smsalertnumber}) ) {
712 # email or sms is requested but not exist, do a print.
713 $effective_mtt = 'print';
715 splice @items, $PrintNoticesMaxLines if $effective_mtt eq 'print' && $PrintNoticesMaxLines && scalar @items > $PrintNoticesMaxLines;
716 #catch the case where we are sending a print to someone with an email
718 my $letter_exists = C4::Letters::getletter( 'circulation', $overdue_rules->{"letter$i"}, $branchcode, $effective_mtt, $patron->lang ) ? 1 : 0;
719 my $letter = parse_overdues_letter(
720 { letter_code => $overdue_rules->{"letter$i"},
721 borrowernumber => $borrowernumber,
722 branchcode => $branchcode,
724 substitute => { # this appears to be a hack to overcome incomplete features in this code.
725 bib => $library->branchname, # maybe 'bib' is a typo for 'lib<rary>'?
726 'items.content' => $titles,
727 'count' => $itemcount,
729 # If there is no template defined for the requested letter
730 # Fallback on the original type
731 message_transport_type => $letter_exists ? $effective_mtt : $mtt,
734 unless ($letter && $letter->{content}) {
735 $verbose and warn qq|Message '$overdue_rules->{"letter$i"}' content not found|;
736 # this transport doesn't have a configured notice, so try another
740 if ( $exceededPrintNoticesMaxLines ) {
741 $letter->{'content'} .= "List too long for form; please check your account online for a complete list of your overdue items.";
744 my @misses = grep { /./ } map { /^([^>]*)[>]+/; ( $1 || '' ); } split /\</, $letter->{'content'};
746 $verbose and warn "The following terms were not matched and replaced: \n\t" . join "\n\t", @misses;
751 prepare_letter_for_printing(
753 borrowernumber => $borrowernumber,
754 firstname => $data->{'firstname'},
755 lastname => $data->{'surname'},
756 address1 => $data->{'address'},
757 address2 => $data->{'address2'},
758 city => $data->{'city'},
759 phone => $data->{'phone'},
760 cardnumber => $data->{'cardnumber'},
761 branchname => $library->branchname,
763 postcode => $data->{'zipcode'},
764 country => $data->{'country'},
765 email => $notice_email,
766 itemcount => $itemcount,
768 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : defined $text_filename ? 'text' : '',
772 if ( ($mtt eq 'email' and not scalar @emails_to_use) or ($mtt eq 'sms' and not $data->{smsalertnumber}) ) {
774 prepare_letter_for_printing(
776 borrowernumber => $borrowernumber,
777 firstname => $data->{'firstname'},
778 lastname => $data->{'surname'},
779 address1 => $data->{'address'},
780 address2 => $data->{'address2'},
781 city => $data->{'city'},
782 postcode => $data->{'zipcode'},
783 country => $data->{'country'},
784 email => $notice_email,
785 itemcount => $itemcount,
787 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : defined $text_filename ? 'text' : '',
791 unless ( $effective_mtt eq 'print' and $print_sent == 1 ) {
792 # Just sent a print if not already done.
793 C4::Letters::EnqueueLetter(
795 borrowernumber => $borrowernumber,
796 message_transport_type => $effective_mtt,
797 from_address => $admin_email_address,
798 to_address => join(',', @emails_to_use),
801 # A print notice should be sent only once per overdue level.
802 # 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.
803 $print_sent = 1 if $effective_mtt eq 'print';
812 if (@output_chunks) {
813 if ( defined $csvfilename ) {
814 print $csv_fh @output_chunks;
816 elsif ( defined $htmlfilename ) {
817 print $fh @output_chunks;
819 elsif ( defined $text_filename ) {
820 print $fh @output_chunks;
823 local $, = "\f"; # pagebreak
824 print @output_chunks;
826 # Generate the content of the csv with headers
828 if ( defined $csvfilename ) {
829 my $delimiter = C4::Context->preference('CSVDelimiter') || ';';
830 $content = join($delimiter, qw(title name surname address1 address2 zipcode city country email itemcount itemsinfo due_date issue_date)) . "\n";
835 $content .= join( "\n", @output_chunks );
838 filename => defined $csvfilename ? 'attachment.csv' : 'attachment.txt',
839 type => 'text/plain',
844 title => 'Overdue Notices',
845 content => 'These messages were not sent directly to the patrons.',
848 C4::Letters::EnqueueLetter(
850 borrowernumber => undef,
851 message_transport_type => 'email',
852 attachments => [$attachment],
853 to_address => $branch_email_address,
860 # note that we're not testing on $csv_fh to prevent closing
865 if ( defined $htmlfilename ) {
866 print $fh "</body>\n";
867 print $fh "</html>\n";
869 } elsif ( defined $text_filename ) {
873 =head1 INTERNAL METHODS
875 These methods are internal to the operation of overdue_notices.pl.
877 =head2 prepare_letter_for_printing
879 returns a string of text appropriate for printing in the event that an
880 overdue notice will not be sent to the patron's email
881 address. Depending on the desired output format, this may be a CSV
882 string, or a human-readable representation of the notice.
893 sub prepare_letter_for_printing {
896 return unless ref $params eq 'HASH';
898 foreach my $required_parameter (qw( letter borrowernumber )) {
899 return unless defined $params->{$required_parameter};
903 chomp $params->{titles};
904 if ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'csv' ) {
906 $params->{'firstname'}, $params->{'lastname'}, $params->{'address1'}, $params->{'address2'}, $params->{'postcode'},
907 $params->{'city'}, $params->{'country'}, $params->{'email'}, $params->{'phone'}, $params->{'cardnumber'},
908 $params->{'itemcount'}, $params->{'titles'}, $params->{'branchname'}, $params->{'letternumber'}
911 return $csv->string, "\n";
913 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
915 } elsif ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'html' ) {
917 $return .= "$params->{'letter'}->{'content'}\n";
918 $return .= "\n</pre>\n";
920 $return .= "$params->{'letter'}->{'content'}\n";
922 # $return .= Data::Dumper->Dump( [ $params->{'borrowernumber'}, $params->{'letter'} ], [qw( borrowernumber letter )] );