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;
38 use DateTime::Duration;
41 use C4::Dates qw/format_date/;
44 use C4::Overdues qw(GetFine GetOverdueMessageTransportTypes);
45 use C4::Budgets qw(GetCurrency);
48 use Koha::Borrower::Debarments qw(AddUniqueDebarment);
54 overdue_notices.pl - prepare messages to be sent to patrons for overdue items
59 [ -n ][ -library <branchcode> ][ -library <branchcode> ... ]
60 [ -max <number of days> ][ -csv [<filename>] ][ -itemscontent <field list> ]
61 [ -email <email_type> ... ]
64 -help brief help message
65 -man full documentation
66 -n No email will be sent
67 -max <days> maximum days overdue to deal with
68 -library <branchname> only deal with overdues from this library (repeatable : several libraries can be given)
69 -csv <filename> populate CSV file
70 -html <directory> Output html to a file in the given directory
71 -text <directory> Output plain text to a file in the given directory
72 -itemscontent <list of fields> item information in templates
73 -borcat <categorycode> category code that must be included
74 -borcatout <categorycode> category code that must be excluded
75 -email <email_type> type of email that will be used. Can be 'email', 'emailpro' or 'B_email'. Repeatable.
83 Print a brief help message and exits.
87 Prints the manual page and exits.
91 Verbose. Without this flag set, only fatal errors are reported.
95 Do not send any email. Overdue notices that would have been sent to
96 the patrons or to the admin are printed to standard out. CSV data (if
97 the -csv flag is set) is written to standard out or to any csv
102 Items older than max days are assumed to be handled somewhere else,
103 probably the F<longoverdues.pl> script. They are therefore ignored by
104 this program. No notices are sent for them, and they are not added to
105 any CSV files. Defaults to 90 to match F<longoverdues.pl>.
109 select overdues for one specific library. Use the value in the
110 branches.branchcode table. This option can be repeated in order
111 to select overdues for a group of libraries.
115 Produces CSV data. if -n (no mail) flag is set, then this CSV data is
116 sent to standard out or to a filename if provided. Otherwise, only
117 overdues that could not be emailed are sent in CSV format to the admin.
121 Produces html data. If patron does not have an email address or
122 -n (no mail) flag is set, an HTML file is generated in the specified
123 directory. This can be downloaded or futher processed by library staff.
124 The file will be called notices-YYYY-MM-DD.html and placed in the directory
129 Produces plain text data. If patron does not have an email address or
130 -n (no mail) flag is set, a text file is generated in the specified
131 directory. This can be downloaded or futher processed by library staff.
132 The file will be called notices-YYYY-MM-DD.txt and placed in the directory
135 =item B<-itemscontent>
137 comma separated list of fields that get substituted into templates in
138 places of the E<lt>E<lt>items.contentE<gt>E<gt> placeholder. This
139 defaults to due date,title,barcode,author
141 Other possible values come from fields in the biblios, items and
146 Repetable field, that permit to select only few of patrons categories.
150 Repetable field, permis to exclude some patrons categories.
152 =item B<-t> | B<--triggered>
154 This option causes a notice to be generated if and only if
155 an item is overdue by the number of days defined in a notice trigger.
157 By default, a notice is sent each time the script runs, which is suitable for
158 less frequent run cron script, but requires syncing notice triggers with
159 the cron schedule to ensure proper behavior.
160 Add the --triggered option for daily cron, at the risk of no notice
161 being generated if the cron fails to run on time.
165 Default items.content lists only those items that fall in the
166 range of the currently processing notice.
167 Choose list-all to include all overdue items in the list (limited by B<-max> setting).
171 use it in order to send overdues on a specific date and not Now.
175 Allows to specify which type of email will be used. Can be email, emailpro or B_email. Repeatable.
181 This script is designed to alert patrons and administrators of overdue
186 This script pays attention to the overdue notice configuration
187 performed in the "Overdue notice/status triggers" section of the
188 "Tools" area of the staff interface to Koha. There, you can choose
189 which letter templates are sent out after a configurable number of
190 days to patrons of each library. More information about the use of this
191 section of Koha is available in the Koha manual.
193 The templates used to craft the emails are defined in the "Tools:
194 Notices" section of the staff interface to Koha.
196 =head2 Outgoing emails
198 Typically, messages are prepared for each patron with overdue
199 items. Messages for whom there is no email address on file are
200 collected and sent as attachments in a single email to each library
201 administrator, or if that is not set, then to the email address in the
202 C<KohaAdminEmailAddress> system preference.
204 These emails are staged in the outgoing message queue, as are messages
205 produced by other features of Koha. This message queue must be
206 processed regularly by the
207 F<misc/cronjobs/process_message_queue.pl> program.
209 In the event that the C<-n> flag is passed to this program, no emails
210 are sent. Instead, messages are sent on standard output from this
211 program. They may be redirected to a file if desired.
215 Templates can contain variables enclosed in double angle brackets like
216 E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
217 specific to the overdue items or relevant patron. Available variables
222 =item E<lt>E<lt>bibE<gt>E<gt>
224 the name of the library
226 =item E<lt>E<lt>items.contentE<gt>E<gt>
228 one line for each item, each line containing a tab separated list of
229 title, author, barcode, issuedate
231 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
233 any field from the borrowers table
235 =item E<lt>E<lt>branches.*E<gt>E<gt>
237 any field from the branches table
243 The C<-csv> command line option lets you specify a file to which
244 overdues data should be output in CSV format.
246 With the C<-n> flag set, data about all overdues is written to the
247 file. Without that flag, only information about overdues that were
248 unable to be sent directly to the patrons will be written. In other
249 words, this CSV file replaces the data that is typically sent to the
250 administrator email address.
252 =head1 USAGE EXAMPLES
254 C<overdue_notices.pl> - In this most basic usage, with no command line
255 arguments, all libraries are procesed individually, and notices are
256 prepared for all patrons with overdue items for whom we have email
257 addresses. Messages for those patrons for whom we have no email
258 address are sent in a single attachment to the library administrator's
259 email address, or to the address in the KohaAdminEmailAddress system
262 C<overdue_notices.pl -n -csv /tmp/overdues.csv> - sends no email and
263 populates F</tmp/overdues.csv> with information about all overdue
266 C<overdue_notices.pl -library MAIN max 14> - prepare notices of
267 overdues in the last 2 weeks for the MAIN library.
271 The F<misc/cronjobs/advance_notices.pl> program allows you to send
272 messages to patrons in advance of thier items becoming due, or to
273 alert them of items that have just become due.
277 # These variables are set by command line options.
278 # They are initially set to default values.
279 my $dbh = C4::Context->dbh();
285 my @branchcodes; # Branch(es) passed as parameter
286 my @emails_to_use; # Emails to use for messaging
287 my @emails; # Emails given in command-line parameters
293 my $itemscontent = join( ',', qw( date_due title barcode author itemnumber ) );
296 my ( $date_input, $today );
304 'library=s' => \@branchcodes,
305 'csv:s' => \$csvfilename, # this optional argument gets '' if not supplied.
306 'html:s' => \$htmlfilename, # this optional argument gets '' if not supplied.
307 'text:s' => \$text_filename, # this optional argument gets '' if not supplied.
308 'itemscontent=s' => \$itemscontent,
309 'list-all' => \$listall,
310 't|triggered' => \$triggered,
311 'date=s' => \$date_input,
312 'borcat=s' => \@myborcat,
313 'borcatout=s' => \@myborcatout,
314 'email=s' => \@emails,
316 pod2usage(1) if $help;
317 pod2usage( -verbose => 2 ) if $man;
319 if ( defined $csvfilename && $csvfilename =~ /^-/ ) {
320 warn qq(using "$csvfilename" as filename, that seems odd);
323 my @overduebranches = C4::Overdues::GetBranchcodesWithOverdueRules(); # Branches with overdue rules
324 my @branches; # Branches passed as parameter with overdue rules
325 my $branchcount = scalar(@overduebranches);
327 my $overduebranch_word = scalar @overduebranches > 1 ? 'branches' : 'branch';
328 my $branchcodes_word = scalar @branchcodes > 1 ? 'branches' : 'branch';
330 my $PrintNoticesMaxLines = C4::Context->preference('PrintNoticesMaxLines');
333 $verbose and warn "Found $branchcount $overduebranch_word with first message enabled: " . join( ', ', map { "'$_'" } @overduebranches ), "\n";
335 die 'No branches with active overduerules';
339 $verbose and warn "$branchcodes_word @branchcodes passed on parameter\n";
341 # Getting libraries which have overdue rules
342 my %seen = map { $_ => 1 } @branchcodes;
343 @branches = grep { $seen{$_} } @overduebranches;
348 my $branch_word = scalar @branches > 1 ? 'branches' : 'branch';
349 $verbose and warn "$branch_word @branches have overdue rules\n";
353 $verbose and warn "No active overduerules for $branchcodes_word '@branchcodes'\n";
354 ( scalar grep { '' eq $_ } @branches )
355 or die "No active overduerules for DEFAULT either!";
356 $verbose and warn "Falling back on default rules for @branchcodes\n";
363 $date = $dbh->quote($date);
365 $date_to_run = dt_from_string( $date_input );
367 die "$date_input is not a valid date, aborting!"
368 if $@ or not $date_to_run;
373 $date_to_run = dt_from_string();
376 # these are the fields that will be substituted into <<item.content>>
377 my @item_content_fields = split( /,/, $itemscontent );
379 binmode( STDOUT, ':encoding(UTF-8)' );
382 our $csv; # the Text::CSV_XS object
383 our $csv_fh; # the filehandle to the CSV file.
384 if ( defined $csvfilename ) {
385 my $sep_char = C4::Context->preference('delimiter') || ';';
386 $sep_char = "\t" if ($sep_char eq 'tabulation');
387 $csv = Text::CSV_XS->new( { binary => 1 , sep_char => $sep_char } );
388 if ( $csvfilename eq '' ) {
391 open $csv_fh, ">", $csvfilename or die "unable to open $csvfilename: $!";
393 if ( $csv->combine(qw(name surname address1 address2 zipcode city country email phone cardnumber itemcount itemsinfo branchname letternumber)) ) {
394 print $csv_fh $csv->string, "\n";
396 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
400 @branches = @overduebranches unless @branches;
402 if ( defined $htmlfilename ) {
403 if ( $htmlfilename eq '' ) {
406 my $today = DateTime->now(time_zone => C4::Context->tz );
407 open $fh, ">:encoding(UTF-8)",File::Spec->catdir ($htmlfilename,"notices-".$today->ymd().".html");
410 print $fh "<html>\n";
411 print $fh "<head>\n";
412 print $fh "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\n";
413 print $fh "<style type='text/css'>\n";
414 print $fh "pre {page-break-after: always;}\n";
415 print $fh "pre {white-space: pre-wrap;}\n";
416 print $fh "pre {white-space: -moz-pre-wrap;}\n";
417 print $fh "pre {white-space: -o-pre-wrap;}\n";
418 print $fh "pre {word-wrap: break-work;}\n";
419 print $fh "</style>\n";
420 print $fh "</head>\n";
421 print $fh "<body>\n";
423 elsif ( defined $text_filename ) {
424 if ( $text_filename eq '' ) {
427 my $today = DateTime->now(time_zone => C4::Context->tz );
428 open $fh, ">",File::Spec->catdir ($text_filename,"notices-".$today->ymd().".txt");
432 foreach my $branchcode (@branches) {
433 if ( C4::Context->preference('OverdueNoticeCalendar') ) {
434 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
435 if ( $calendar->is_holiday($date_to_run) ) {
440 my $branch_details = C4::Branch::GetBranchDetail($branchcode);
441 my $admin_email_address = $branch_details->{'branchemail'}
442 || C4::Context->preference('KohaAdminEmailAddress');
443 my @output_chunks; # may be sent to mail or stdout or csv file.
445 $verbose and warn sprintf "branchcode : '%s' using %s\n", $branchcode, $admin_email_address;
447 my $sth2 = $dbh->prepare( <<"END_SQL" );
448 SELECT biblio.*, items.*, issues.*, biblioitems.itemtype, TO_DAYS($date)-TO_DAYS(date_due) AS days_overdue, branchname
449 FROM issues,items,biblio, biblioitems, branches b
450 WHERE items.itemnumber=issues.itemnumber
451 AND biblio.biblionumber = items.biblionumber
452 AND b.branchcode = items.homebranch
453 AND biblio.biblionumber = biblioitems.biblionumber
454 AND issues.borrowernumber = ?
457 my $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = ? ";
458 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
459 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
461 my $rqoverduerules = $dbh->prepare($query);
462 $rqoverduerules->execute($branchcode, @myborcat, @myborcatout);
464 # We get default rules is there is no rule for this branch
465 if($rqoverduerules->rows == 0){
466 $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = '' ";
467 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
468 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
470 $rqoverduerules = $dbh->prepare($query);
471 $rqoverduerules->execute(@myborcat, @myborcatout);
474 # my $outfile = 'overdues_' . ( $mybranch || $branchcode || 'default' );
475 while ( my $overdue_rules = $rqoverduerules->fetchrow_hashref ) {
476 PERIOD: foreach my $i ( 1 .. 3 ) {
478 $verbose and warn "branch '$branchcode', categorycode = $overdue_rules->{categorycode} pass $i\n";
480 my $mindays = $overdue_rules->{"delay$i"}; # the notice will be sent after mindays days (grace period)
482 $overdue_rules->{ "delay" . ( $i + 1 ) }
483 ? $overdue_rules->{ "delay" . ( $i + 1 ) } - 1
485 ); # issues being more than maxdays late are managed somewhere else. (borrower probably suspended)
487 next unless defined $mindays;
489 if ( !$overdue_rules->{"letter$i"} ) {
490 $verbose and warn "No letter$i code for branch '$branchcode'";
494 # $letter->{'content'} is the text of the mail that is sent.
495 # this text contains fields that are replaced by their value. Those fields must be written between brackets
496 # The following fields are available :
497 # 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).
498 # <date> <itemcount> <firstname> <lastname> <address1> <address2> <address3> <city> <postcode> <country>
500 my $borrower_sql = <<'END_SQL';
501 SELECT issues.borrowernumber, firstname, surname, address, address2, city, zipcode, country, email, emailpro, B_email, smsalertnumber, phone, cardnumber,
502 TO_DAYS(?)-TO_DAYS(date_due) as difference, date_due
503 FROM issues,borrowers,categories
504 WHERE issues.borrowernumber=borrowers.borrowernumber
505 AND borrowers.categorycode=categories.categorycode
507 my @borrower_parameters;
508 push @borrower_parameters, $date_to_run->datetime();
510 $borrower_sql .= ' AND issues.branchcode=? ';
511 push @borrower_parameters, $branchcode;
513 if ( $overdue_rules->{categorycode} ) {
514 $borrower_sql .= ' AND borrowers.categorycode=? ';
515 push @borrower_parameters, $overdue_rules->{categorycode};
517 $borrower_sql .= ' AND categories.overduenoticerequired=1 ORDER BY issues.borrowernumber';
519 # $sth gets borrower info iff at least one overdue item has triggered the overdue action.
520 my $sth = $dbh->prepare($borrower_sql);
521 $sth->execute(@borrower_parameters);
523 $verbose and warn $borrower_sql . "\n $branchcode | " . $overdue_rules->{'categorycode'} . "\n ($mindays, $maxdays, ". $date_to_run->datetime() .")\nreturns " . $sth->rows . " rows";
525 while ( my $data = $sth->fetchrow_hashref ) {
527 next unless ( DateTime->compare( $date_to_run, dt_from_string($data->{date_due})) ) == 1;
529 # check the borrower has at least one item that matches
531 if ( C4::Context->preference('OverdueNoticeCalendar') )
534 Koha::Calendar->new( branchcode => $branchcode );
536 $calendar->days_between( dt_from_string($data->{date_due}),
541 $date_to_run->delta_days( dt_from_string($data->{date_due}) );
543 $days_between = $days_between->in_units('days');
545 if ( $mindays != $days_between ) {
550 unless ( $days_between >= $mindays
551 && $days_between <= $maxdays )
556 if ($borrowernumber eq $data->{'borrowernumber'}){
557 # we have already dealt with this borrower
558 $verbose and warn "already dealt with this borrower $borrowernumber";
561 $borrowernumber = $data->{'borrowernumber'};
563 $data->{'firstname'} . ', '
564 . $data->{'surname'} . ' ('
565 . $borrowernumber . ')';
567 and warn "borrower $borr has items triggering level $i.";
571 C4::Members::GetNoticeEmailAddress($borrowernumber);
575 push @emails_to_use, $data->{$_} if ( $data->{$_} );
579 push @emails_to_use, $notice_email if ($notice_email);
583 my $letter = C4::Letters::getletter( 'circulation', $overdue_rules->{"letter$i"}, $branchcode );
586 $verbose and warn qq|Message '$overdue_rules->{"letter$i"}' content not found|;
588 # might as well skip while PERIOD, no other borrowers are going to work.
589 # FIXME : Does this mean a letter must be defined in order to trigger a debar ?
593 if ( $overdue_rules->{"debarred$i"} ) {
595 #action taken is debarring
598 borrowernumber => $borrowernumber,
600 comment => "Restriction added by overdues process "
601 . output_pref( dt_from_string() ),
604 $verbose and warn "debarring $borr\n";
606 my @params = ($borrowernumber);
607 $verbose and warn "STH2 PARAMS: borrowernumber = $borrowernumber";
609 $sth2->execute(@params);
615 my $exceededPrintNoticesMaxLines = 0;
616 while ( my $item_info = $sth2->fetchrow_hashref() ) {
617 next unless ( DateTime->compare( $date_to_run, dt_from_string($item_info->{date_due})) ) == 1;
619 if ( C4::Context->preference('OverdueNoticeCalendar') ) {
621 Koha::Calendar->new( branchcode => $branchcode );
623 $calendar->days_between(
624 dt_from_string( $item_info->{date_due} ), $date_to_run );
628 $date_to_run->delta_days(
629 dt_from_string( $item_info->{date_due} ) );
631 $days_between = $days_between->in_units('days');
633 unless ($days_between >= 1 and $days_between <= $MAX){
639 if ( $mindays != $days_between ) {
644 unless ( $days_between >= $mindays
645 && $days_between <= $maxdays )
652 if ( ( scalar(@emails_to_use) == 0 || $nomail ) && $PrintNoticesMaxLines && $j >= $PrintNoticesMaxLines ) {
653 $exceededPrintNoticesMaxLines = 1;
657 my @item_info = map { $_ =~ /^date|date$/ ? format_date( $item_info->{$_} ) : $item_info->{$_} || '' } @item_content_fields;
658 $titles .= join("\t", @item_info) . "\n";
660 push @items, $item_info;
664 my @message_transport_types = @{ GetOverdueMessageTransportTypes( $branchcode, $overdue_rules->{categorycode}, $i) };
665 @message_transport_types = @{ GetOverdueMessageTransportTypes( q{}, $overdue_rules->{categorycode}, $i) }
666 unless @message_transport_types;
669 my $print_sent = 0; # A print notice is not yet sent for this patron
670 for my $mtt ( @message_transport_types ) {
672 my $letter = parse_letter(
673 { letter_code => $overdue_rules->{"letter$i"},
674 borrowernumber => $borrowernumber,
675 branchcode => $branchcode,
677 substitute => { # this appears to be a hack to overcome incomplete features in this code.
678 bib => $branch_details->{'branchname'}, # maybe 'bib' is a typo for 'lib<rary>'?
679 'items.content' => $titles,
680 'count' => $itemcount,
682 message_transport_type => $mtt,
686 $verbose and warn qq|Message '$overdue_rules->{"letter$i"}' content not found|;
687 # this transport doesn't have a configured notice, so try another
691 if ( $exceededPrintNoticesMaxLines ) {
692 $letter->{'content'} .= "List too long for form; please check your account online for a complete list of your overdue items.";
695 my @misses = grep { /./ } map { /^([^>]*)[>]+/; ( $1 || '' ); } split /\</, $letter->{'content'};
697 $verbose and warn "The following terms were not matched and replaced: \n\t" . join "\n\t", @misses;
702 prepare_letter_for_printing(
704 borrowernumber => $borrowernumber,
705 firstname => $data->{'firstname'},
706 lastname => $data->{'surname'},
707 address1 => $data->{'address'},
708 address2 => $data->{'address2'},
709 city => $data->{'city'},
710 phone => $data->{'phone'},
711 cardnumber => $data->{'cardnumber'},
712 branchname => $branch_details->{'branchname'},
714 postcode => $data->{'zipcode'},
715 country => $data->{'country'},
716 email => $notice_email,
717 itemcount => $itemcount,
719 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : defined $text_filename ? 'text' : '',
723 if ( ($mtt eq 'email' and not scalar @emails_to_use) or ($mtt eq 'sms' and not $data->{smsalertnumber}) ) {
724 # email or sms is requested but not exist, do a print.
727 prepare_letter_for_printing(
729 borrowernumber => $borrowernumber,
730 firstname => $data->{'firstname'},
731 lastname => $data->{'surname'},
732 address1 => $data->{'address'},
733 address2 => $data->{'address2'},
734 city => $data->{'city'},
735 postcode => $data->{'zipcode'},
736 country => $data->{'country'},
737 email => $notice_email,
738 itemcount => $itemcount,
740 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : defined $text_filename ? 'text' : '',
744 unless ( $mtt eq 'print' and $print_sent == 1 ) {
745 # Just sent a print if not already done.
746 C4::Letters::EnqueueLetter(
748 borrowernumber => $borrowernumber,
749 message_transport_type => $mtt,
750 from_address => $admin_email_address,
751 to_address => join(',', @emails_to_use),
754 # A print notice should be sent only once per overdue level.
755 # 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.
756 $print_sent = 1 if $mtt eq 'print';
765 if (@output_chunks) {
766 if ( defined $csvfilename ) {
767 print $csv_fh @output_chunks;
769 elsif ( defined $htmlfilename ) {
770 print $fh @output_chunks;
772 elsif ( defined $text_filename ) {
773 print $fh @output_chunks;
776 local $, = "\f"; # pagebreak
777 print @output_chunks;
779 # Generate the content of the csv with headers
781 if ( defined $csvfilename ) {
782 my $delimiter = C4::Context->preference('delimiter') || ';';
783 $content = join($delimiter, qw(title name surname address1 address2 zipcode city country email itemcount itemsinfo due_date issue_date)) . "\n";
788 $content .= join( "\n", @output_chunks );
791 filename => defined $csvfilename ? 'attachment.csv' : 'attachment.txt',
792 type => 'text/plain',
797 title => 'Overdue Notices',
798 content => 'These messages were not sent directly to the patrons.',
800 C4::Letters::EnqueueLetter(
802 borrowernumber => undef,
803 message_transport_type => 'email',
804 attachments => [$attachment],
805 to_address => $admin_email_address,
812 # note that we're not testing on $csv_fh to prevent closing
817 if ( defined $htmlfilename ) {
818 print $fh "</body>\n";
819 print $fh "</html>\n";
821 } elsif ( defined $text_filename ) {
825 =head1 INTERNAL METHODS
827 These methods are internal to the operation of overdue_notices.pl.
831 parses the letter template, replacing the placeholders with data
832 specific to this patron, biblio, or item
835 letter - required hashref
836 borrowernumber - required integer
837 substitute - optional hashref of other key/value pairs that should
838 be substituted in the letter content
840 returns the C<letter> hashref, with the content updated to reflect the
841 substituted keys and values.
848 foreach my $required (qw( letter_code borrowernumber )) {
849 return unless ( exists $params->{$required} && $params->{$required} );
852 my $substitute = $params->{'substitute'} || {};
853 $substitute->{today} ||= C4::Dates->new()->output("syspref");
855 my %tables = ( 'borrowers' => $params->{'borrowernumber'} );
856 if ( my $p = $params->{'branchcode'} ) {
857 $tables{'branches'} = $p;
860 my $currencies = GetCurrency();
862 $currency_format = $currencies->{currency} if defined($currencies);
865 if ( my $i = $params->{'items'} ) {
866 my $item_format = '';
867 foreach my $item (@$i) {
868 my $fine = GetFine($item->{'itemnumber'}, $params->{'borrowernumber'});
869 if ( !$item_format and defined $params->{'letter'}->{'content'} ) {
870 $params->{'letter'}->{'content'} =~ m/(<item>.*<\/item>)/;
874 $item->{'fine'} = currency_format($currency_format, "$fine", FMT_SYMBOL);
875 # if active currency isn't correct ISO code fallback to sprintf
876 $item->{'fine'} = sprintf('%.2f', $fine) unless $item->{'fine'};
879 'biblio' => $item->{'biblionumber'},
880 'biblioitems' => $item->{'biblionumber'},
882 'issues' => $item->{'itemnumber'},
887 return C4::Letters::GetPreparedLetter (
888 module => 'circulation',
889 letter_code => $params->{'letter_code'},
890 branchcode => $params->{'branchcode'},
892 substitute => $substitute,
893 repeat => { item => \@item_tables },
894 message_transport_type => $params->{message_transport_type},
898 =head2 prepare_letter_for_printing
900 returns a string of text appropriate for printing in the event that an
901 overdue notice will not be sent to the patron's email
902 address. Depending on the desired output format, this may be a CSV
903 string, or a human-readable representation of the notice.
914 sub prepare_letter_for_printing {
917 return unless ref $params eq 'HASH';
919 foreach my $required_parameter (qw( letter borrowernumber )) {
920 return unless defined $params->{$required_parameter};
924 chomp $params->{titles};
925 if ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'csv' ) {
927 $params->{'firstname'}, $params->{'lastname'}, $params->{'address1'}, $params->{'address2'}, $params->{'postcode'},
928 $params->{'city'}, $params->{'country'}, $params->{'email'}, $params->{'phone'}, $params->{'cardnumber'},
929 $params->{'itemcount'}, $params->{'titles'}, $params->{'branchname'}, $params->{'letternumber'}
932 return $csv->string, "\n";
934 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
936 } elsif ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'html' ) {
938 $return .= "$params->{'letter'}->{'content'}\n";
939 $return .= "\n</pre>\n";
941 $return .= "$params->{'letter'}->{'content'}\n";
943 # $return .= Data::Dumper->Dump( [ $params->{'borrowernumber'}, $params->{'letter'} ], [qw( borrowernumber letter )] );