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 GetOverdueMessageTransportTypes);
43 use C4::Budgets qw(GetCurrency);
45 use Koha::Borrower::Debarments qw(AddUniqueDebarment);
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
63 -n No email will be sent
64 -max <days> maximum days overdue to deal with
65 -library <branchname> only deal with overdues from this library (repeatable : several libraries can be given)
66 -csv <filename> populate CSV file
67 -html <directory> Output html to a file in the given directory
68 -text <directory> Output plain text to a file in the given directory
69 -itemscontent <list of fields> item information in templates
70 -borcat <categorycode> category code that must be included
71 -borcatout <categorycode> category code that must be excluded
72 -email <email_type> type of email that will be used. Can be 'email', 'emailpro' or 'B_email'. Repeatable.
80 Print a brief help message and exits.
84 Prints the manual page and exits.
88 Verbose. Without this flag set, only fatal errors are reported.
92 Do not send any email. Overdue notices that would have been sent to
93 the patrons or to the admin are printed to standard out. CSV data (if
94 the -csv flag is set) is written to standard out or to any csv
99 Items older than max days are assumed to be handled somewhere else,
100 probably the F<longoverdues.pl> script. They are therefore ignored by
101 this program. No notices are sent for them, and they are not added to
102 any CSV files. Defaults to 90 to match F<longoverdues.pl>.
106 select overdues for one specific library. Use the value in the
107 branches.branchcode table. This option can be repeated in order
108 to select overdues for a group of libraries.
112 Produces CSV data. if -n (no mail) flag is set, then this CSV data is
113 sent to standard out or to a filename if provided. Otherwise, only
114 overdues that could not be emailed are sent in CSV format to the admin.
118 Produces html data. If patron does not have an email address or
119 -n (no mail) flag is set, an HTML file is generated in the specified
120 directory. This can be downloaded or futher processed by library staff.
121 The file will be called notices-YYYY-MM-DD.html and placed in the directory
126 Produces plain text data. If patron does not have an email address or
127 -n (no mail) flag is set, a text file is generated in the specified
128 directory. This can be downloaded or futher processed by library staff.
129 The file will be called notices-YYYY-MM-DD.txt and placed in the directory
132 =item B<-itemscontent>
134 comma separated list of fields that get substituted into templates in
135 places of the E<lt>E<lt>items.contentE<gt>E<gt> placeholder. This
136 defaults to due date,title,barcode,author
138 Other possible values come from fields in the biblios, items and
143 Repetable field, that permit to select only few of patrons categories.
147 Repetable field, permis to exclude some patrons categories.
149 =item B<-t> | B<--triggered>
151 This option causes a notice to be generated if and only if
152 an item is overdue by the number of days defined in a notice trigger.
154 By default, a notice is sent each time the script runs, which is suitable for
155 less frequent run cron script, but requires syncing notice triggers with
156 the cron schedule to ensure proper behavior.
157 Add the --triggered option for daily cron, at the risk of no notice
158 being generated if the cron fails to run on time.
162 Default items.content lists only those items that fall in the
163 range of the currently processing notice.
164 Choose list-all to include all overdue items in the list (limited by B<-max> setting).
168 use it in order to send overdues on a specific date and not Now.
172 Allows to specify which type of email will be used. Can be email, emailpro or B_email. Repeatable.
178 This script is designed to alert patrons and administrators of overdue
183 This script pays attention to the overdue notice configuration
184 performed in the "Overdue notice/status triggers" section of the
185 "Tools" area of the staff interface to Koha. There, you can choose
186 which letter templates are sent out after a configurable number of
187 days to patrons of each library. More information about the use of this
188 section of Koha is available in the Koha manual.
190 The templates used to craft the emails are defined in the "Tools:
191 Notices" section of the staff interface to Koha.
193 =head2 Outgoing emails
195 Typically, messages are prepared for each patron with overdue
196 items. Messages for whom there is no email address on file are
197 collected and sent as attachments in a single email to each library
198 administrator, or if that is not set, then to the email address in the
199 C<KohaAdminEmailAddress> system preference.
201 These emails are staged in the outgoing message queue, as are messages
202 produced by other features of Koha. This message queue must be
203 processed regularly by the
204 F<misc/cronjobs/process_message_queue.pl> program.
206 In the event that the C<-n> flag is passed to this program, no emails
207 are sent. Instead, messages are sent on standard output from this
208 program. They may be redirected to a file if desired.
212 Templates can contain variables enclosed in double angle brackets like
213 E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
214 specific to the overdue items or relevant patron. Available variables
219 =item E<lt>E<lt>bibE<gt>E<gt>
221 the name of the library
223 =item E<lt>E<lt>items.contentE<gt>E<gt>
225 one line for each item, each line containing a tab separated list of
226 title, author, barcode, issuedate
228 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
230 any field from the borrowers table
232 =item E<lt>E<lt>branches.*E<gt>E<gt>
234 any field from the branches table
240 The C<-csv> command line option lets you specify a file to which
241 overdues data should be output in CSV format.
243 With the C<-n> flag set, data about all overdues is written to the
244 file. Without that flag, only information about overdues that were
245 unable to be sent directly to the patrons will be written. In other
246 words, this CSV file replaces the data that is typically sent to the
247 administrator email address.
249 =head1 USAGE EXAMPLES
251 C<overdue_notices.pl> - In this most basic usage, with no command line
252 arguments, all libraries are procesed individually, and notices are
253 prepared for all patrons with overdue items for whom we have email
254 addresses. Messages for those patrons for whom we have no email
255 address are sent in a single attachment to the library administrator's
256 email address, or to the address in the KohaAdminEmailAddress system
259 C<overdue_notices.pl -n -csv /tmp/overdues.csv> - sends no email and
260 populates F</tmp/overdues.csv> with information about all overdue
263 C<overdue_notices.pl -library MAIN max 14> - prepare notices of
264 overdues in the last 2 weeks for the MAIN library.
268 The F<misc/cronjobs/advance_notices.pl> program allows you to send
269 messages to patrons in advance of thier items becoming due, or to
270 alert them of items that have just become due.
274 # These variables are set by command line options.
275 # They are initially set to default values.
276 my $dbh = C4::Context->dbh();
282 my @branchcodes; # Branch(es) passed as parameter
283 my @emails_to_use; # Emails to use for messaging
284 my @emails; # Emails given in command-line parameters
290 my $itemscontent = join( ',', qw( date_due title barcode author itemnumber ) );
301 'library=s' => \@branchcodes,
302 'csv:s' => \$csvfilename, # this optional argument gets '' if not supplied.
303 'html:s' => \$htmlfilename, # this optional argument gets '' if not supplied.
304 'text:s' => \$text_filename, # this optional argument gets '' if not supplied.
305 'itemscontent=s' => \$itemscontent,
306 'list-all' => \$listall,
307 't|triggered' => \$triggered,
309 'borcat=s' => \@myborcat,
310 'borcatout=s' => \@myborcatout,
311 'email=s' => \@emails,
313 pod2usage(1) if $help;
314 pod2usage( -verbose => 2 ) if $man;
316 if ( defined $csvfilename && $csvfilename =~ /^-/ ) {
317 warn qq(using "$csvfilename" as filename, that seems odd);
320 my @overduebranches = C4::Overdues::GetBranchcodesWithOverdueRules(); # Branches with overdue rules
321 my @branches; # Branches passed as parameter with overdue rules
322 my $branchcount = scalar(@overduebranches);
324 my $overduebranch_word = scalar @overduebranches > 1 ? 'branches' : 'branch';
325 my $branchcodes_word = scalar @branchcodes > 1 ? 'branches' : 'branch';
327 my $PrintNoticesMaxLines = C4::Context->preference('PrintNoticesMaxLines');
330 $verbose and warn "Found $branchcount $overduebranch_word with first message enabled: " . join( ', ', map { "'$_'" } @overduebranches ), "\n";
332 die 'No branches with active overduerules';
336 $verbose and warn "$branchcodes_word @branchcodes passed on parameter\n";
338 # Getting libraries which have overdue rules
339 my %seen = map { $_ => 1 } @branchcodes;
340 @branches = grep { $seen{$_} } @overduebranches;
345 my $branch_word = scalar @branches > 1 ? 'branches' : 'branch';
346 $verbose and warn "$branch_word @branches have overdue rules\n";
350 $verbose and warn "No active overduerules for $branchcodes_word '@branchcodes'\n";
351 ( scalar grep { '' eq $_ } @branches )
352 or die "No active overduerules for DEFAULT either!";
353 $verbose and warn "Falling back on default rules for @branchcodes\n";
359 $date=$dbh->quote($date);
360 $date_to_run = dt_from_string($date);
364 $date_to_run = DateTime->now( time_zone => C4::Context->tz() );
367 # these are the fields that will be substituted into <<item.content>>
368 my @item_content_fields = split( /,/, $itemscontent );
370 binmode( STDOUT, ':encoding(UTF-8)' );
373 our $csv; # the Text::CSV_XS object
374 our $csv_fh; # the filehandle to the CSV file.
375 if ( defined $csvfilename ) {
376 my $sep_char = C4::Context->preference('delimiter') || ';';
377 $sep_char = "\t" if ($sep_char eq 'tabulation');
378 $csv = Text::CSV_XS->new( { binary => 1 , sep_char => $sep_char } );
379 if ( $csvfilename eq '' ) {
382 open $csv_fh, ">", $csvfilename or die "unable to open $csvfilename: $!";
384 if ( $csv->combine(qw(name surname address1 address2 zipcode city country email itemcount itemsinfo)) ) {
385 print $csv_fh $csv->string, "\n";
387 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
391 @branches = @overduebranches unless @branches;
393 if ( defined $htmlfilename ) {
394 if ( $htmlfilename eq '' ) {
397 my $today = DateTime->now(time_zone => C4::Context->tz );
398 open $fh, ">",File::Spec->catdir ($htmlfilename,"notices-".$today->ymd().".html");
401 print $fh "<html>\n";
402 print $fh "<head>\n";
403 print $fh "<style type='text/css'>\n";
404 print $fh "pre {page-break-after: always;}\n";
405 print $fh "pre {white-space: pre-wrap;}\n";
406 print $fh "pre {white-space: -moz-pre-wrap;}\n";
407 print $fh "pre {white-space: -o-pre-wrap;}\n";
408 print $fh "pre {word-wrap: break-work;}\n";
409 print $fh "</style>\n";
410 print $fh "</head>\n";
411 print $fh "<body>\n";
413 elsif ( defined $text_filename ) {
414 if ( $text_filename eq '' ) {
417 my $today = DateTime->now(time_zone => C4::Context->tz );
418 open $fh, ">",File::Spec->catdir ($text_filename,"notices-".$today->ymd().".txt");
422 foreach my $branchcode (@branches) {
423 if ( C4::Context->preference('OverdueNoticeCalendar') ) {
424 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
425 if ( $calendar->is_holiday($date_to_run) ) {
430 my $branch_details = C4::Branch::GetBranchDetail($branchcode);
431 my $admin_email_address = $branch_details->{'branchemail'}
432 || C4::Context->preference('KohaAdminEmailAddress');
433 my @output_chunks; # may be sent to mail or stdout or csv file.
435 $verbose and warn sprintf "branchcode : '%s' using %s\n", $branchcode, $admin_email_address;
437 my $sth2 = $dbh->prepare( <<"END_SQL" );
438 SELECT biblio.*, items.*, issues.*, biblioitems.itemtype, TO_DAYS($date)-TO_DAYS(date_due) AS days_overdue
439 FROM issues,items,biblio, biblioitems
440 WHERE items.itemnumber=issues.itemnumber
441 AND biblio.biblionumber = items.biblionumber
442 AND biblio.biblionumber = biblioitems.biblionumber
443 AND issues.borrowernumber = ?
446 my $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = ? ";
447 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
448 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
450 my $rqoverduerules = $dbh->prepare($query);
451 $rqoverduerules->execute($branchcode, @myborcat, @myborcatout);
453 # We get default rules is there is no rule for this branch
454 if($rqoverduerules->rows == 0){
455 $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = '' ";
456 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
457 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
459 $rqoverduerules = $dbh->prepare($query);
460 $rqoverduerules->execute(@myborcat, @myborcatout);
463 # my $outfile = 'overdues_' . ( $mybranch || $branchcode || 'default' );
464 while ( my $overdue_rules = $rqoverduerules->fetchrow_hashref ) {
465 PERIOD: foreach my $i ( 1 .. 3 ) {
467 $verbose and warn "branch '$branchcode', pass $i\n";
468 my $mindays = $overdue_rules->{"delay$i"}; # the notice will be sent after mindays days (grace period)
470 $overdue_rules->{ "delay" . ( $i + 1 ) }
471 ? $overdue_rules->{ "delay" . ( $i + 1 ) } - 1
473 ); # issues being more than maxdays late are managed somewhere else. (borrower probably suspended)
475 if ( !$overdue_rules->{"letter$i"} ) {
476 $verbose and warn "No letter$i code for branch '$branchcode'";
480 # $letter->{'content'} is the text of the mail that is sent.
481 # this text contains fields that are replaced by their value. Those fields must be written between brackets
482 # The following fields are available :
483 # 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).
484 # <date> <itemcount> <firstname> <lastname> <address1> <address2> <address3> <city> <postcode> <country>
486 my $borrower_sql = <<'END_SQL';
487 SELECT issues.borrowernumber, firstname, surname, address, address2, city, zipcode, country, email, emailpro, B_email, smsalertnumber,
488 TO_DAYS(?)-TO_DAYS(date_due) as difference, date_due
489 FROM issues,borrowers,categories
490 WHERE issues.borrowernumber=borrowers.borrowernumber
491 AND borrowers.categorycode=categories.categorycode
493 my @borrower_parameters;
494 push @borrower_parameters, $date_to_run->datetime();
496 $borrower_sql .= ' AND issues.branchcode=? ';
497 push @borrower_parameters, $branchcode;
499 if ( $overdue_rules->{categorycode} ) {
500 $borrower_sql .= ' AND borrowers.categorycode=? ';
501 push @borrower_parameters, $overdue_rules->{categorycode};
503 $borrower_sql .= ' AND categories.overduenoticerequired=1 ORDER BY issues.borrowernumber';
505 # $sth gets borrower info iff at least one overdue item has triggered the overdue action.
506 my $sth = $dbh->prepare($borrower_sql);
507 $sth->execute(@borrower_parameters);
509 $verbose and warn $borrower_sql . "\n $branchcode | " . $overdue_rules->{'categorycode'} . "\n ($mindays, $maxdays, ". $date_to_run->datetime() .")\nreturns " . $sth->rows . " rows";
511 while ( my $data = $sth->fetchrow_hashref ) {
513 next unless ( DateTime->compare( $date_to_run, dt_from_string($data->{date_due})) ) == 1;
515 # check the borrower has at least one item that matches
517 if ( C4::Context->preference('OverdueNoticeCalendar') )
520 Koha::Calendar->new( branchcode => $branchcode );
522 $calendar->days_between( dt_from_string($data->{date_due}),
527 $date_to_run->delta_days( dt_from_string($data->{date_due}) );
529 $days_between = $days_between->in_units('days');
531 if ( $mindays != $days_between ) {
536 unless ( $days_between >= $mindays
537 && $days_between <= $maxdays )
542 if ($borrowernumber eq $data->{'borrowernumber'}){
543 # we have already dealt with this borrower
544 $verbose and warn "already dealt with this borrower $borrowernumber";
547 $borrowernumber = $data->{'borrowernumber'};
549 $data->{'firstname'} . ', '
550 . $data->{'surname'} . ' ('
551 . $borrowernumber . ')';
553 and warn "borrower $borr has items triggering level $i.";
557 C4::Members::GetNoticeEmailAddress($borrowernumber);
561 push @emails_to_use, $data->{$_} if ( $data->{$_} );
565 push @emails_to_use, $notice_email if ($notice_email);
569 my $letter = C4::Letters::getletter( 'circulation', $overdue_rules->{"letter$i"}, $branchcode );
572 $verbose and warn "Message '$overdue_rules->{letter$i}' content not found";
574 # might as well skip while PERIOD, no other borrowers are going to work.
575 # FIXME : Does this mean a letter must be defined in order to trigger a debar ?
579 if ( $overdue_rules->{"debarred$i"} ) {
581 #action taken is debarring
584 borrowernumber => $borrowernumber,
586 comment => "Restriction added by overdues process "
587 . output_pref( dt_from_string() ),
590 $verbose and warn "debarring $borr\n";
592 # my @params = ($listall ? ( $borrowernumber , 1 , $MAX ) : ( $borrowernumber, $mindays, $maxdays ));
593 my @params = ($borrowernumber);
594 $verbose and warn "STH2 PARAMS: borrowernumber = $borrowernumber";
595 $sth2->execute(@params);
601 my $exceededPrintNoticesMaxLines = 0;
602 while ( my $item_info = $sth2->fetchrow_hashref() ) {
603 if ( C4::Context->preference('OverdueNoticeCalendar') ) {
605 Koha::Calendar->new( branchcode => $branchcode );
607 $calendar->days_between(
608 dt_from_string( $item_info->{date_due} ), $date_to_run );
612 $date_to_run->delta_days(
613 dt_from_string( $item_info->{date_due} ) );
615 $days_between = $days_between->in_units('days');
617 unless ($days_between >= 1 and $days_between <= $MAX){
622 unless ($days_between >=$mindays && $days_between <= $maxdays){
627 if ( ( scalar(@emails_to_use) == 0 || $nomail ) && $PrintNoticesMaxLines && $j >= $PrintNoticesMaxLines ) {
628 $exceededPrintNoticesMaxLines = 1;
632 my @item_info = map { $_ =~ /^date|date$/ ? format_date( $item_info->{$_} ) : $item_info->{$_} || '' } @item_content_fields;
633 $titles .= join("\t", @item_info) . "\n";
635 push @items, $item_info;
639 my @message_transport_types = @{ GetOverdueMessageTransportTypes( $branchcode, $overdue_rules->{categorycode}, $i) };
640 @message_transport_types = @{ GetOverdueMessageTransportTypes( q{}, $overdue_rules->{categorycode}, $i) }
641 unless @message_transport_types;
644 my $print_sent = 0; # A print notice is not yet sent for this patron
645 for my $mtt ( @message_transport_types ) {
647 my $letter = parse_letter(
648 { letter_code => $overdue_rules->{"letter$i"},
649 borrowernumber => $borrowernumber,
650 branchcode => $branchcode,
652 substitute => { # this appears to be a hack to overcome incomplete features in this code.
653 bib => $branch_details->{'branchname'}, # maybe 'bib' is a typo for 'lib<rary>'?
654 'items.content' => $titles,
655 'count' => $itemcount,
657 message_transport_type => $mtt,
661 $verbose and warn "Message '$overdue_rules->{letter$i}' content not found";
662 # this transport doesn't have a configured notice, so try another
666 if ( $exceededPrintNoticesMaxLines ) {
667 $letter->{'content'} .= "List too long for form; please check your account online for a complete list of your overdue items.";
670 my @misses = grep { /./ } map { /^([^>]*)[>]+/; ( $1 || '' ); } split /\</, $letter->{'content'};
672 $verbose and warn "The following terms were not matched and replaced: \n\t" . join "\n\t", @misses;
677 prepare_letter_for_printing(
679 borrowernumber => $borrowernumber,
680 firstname => $data->{'firstname'},
681 lastname => $data->{'surname'},
682 address1 => $data->{'address'},
683 address2 => $data->{'address2'},
684 city => $data->{'city'},
685 postcode => $data->{'zipcode'},
686 country => $data->{'country'},
687 email => $notice_email,
688 itemcount => $itemcount,
690 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : defined $text_filename ? 'text' : '',
694 if ( ($mtt eq 'email' and not scalar @emails_to_use) or ($mtt eq 'sms' and not $data->{smsalertnumber}) ) {
695 # email or sms is requested but not exist, do a print.
698 prepare_letter_for_printing(
700 borrowernumber => $borrowernumber,
701 firstname => $data->{'firstname'},
702 lastname => $data->{'surname'},
703 address1 => $data->{'address'},
704 address2 => $data->{'address2'},
705 city => $data->{'city'},
706 postcode => $data->{'zipcode'},
707 country => $data->{'country'},
708 email => $notice_email,
709 itemcount => $itemcount,
711 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : defined $text_filename ? 'text' : '',
715 unless ( $mtt eq 'print' and $print_sent == 1 ) {
716 # Just sent a print if not already done.
717 C4::Letters::EnqueueLetter(
719 borrowernumber => $borrowernumber,
720 message_transport_type => $mtt,
721 from_address => $admin_email_address,
722 to_address => join(',', @emails_to_use),
725 # A print notice should be sent only once per overdue level.
726 # 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.
727 $print_sent = 1 if $mtt eq 'print';
736 if (@output_chunks) {
737 if ( defined $csvfilename ) {
738 print $csv_fh @output_chunks;
740 elsif ( defined $htmlfilename ) {
741 print $fh @output_chunks;
743 elsif ( defined $text_filename ) {
744 print $fh @output_chunks;
747 local $, = "\f"; # pagebreak
748 print @output_chunks;
750 # Generate the content of the csv with headers
752 if ( defined $csvfilename ) {
753 my $delimiter = C4::Context->preference('delimiter') || ';';
754 $content = join($delimiter, qw(title name surname address1 address2 zipcode city country email itemcount itemsinfo due_date issue_date)) . "\n";
759 $content .= join( "\n", @output_chunks );
762 filename => defined $csvfilename ? 'attachment.csv' : 'attachment.txt',
763 type => 'text/plain',
768 title => 'Overdue Notices',
769 content => 'These messages were not sent directly to the patrons.',
771 C4::Letters::EnqueueLetter(
773 borrowernumber => undef,
774 message_transport_type => 'email',
775 attachments => [$attachment],
776 to_address => $admin_email_address,
783 # note that we're not testing on $csv_fh to prevent closing
788 if ( defined $htmlfilename ) {
789 print $fh "</body>\n";
790 print $fh "</html>\n";
792 } elsif ( defined $text_filename ) {
796 =head1 INTERNAL METHODS
798 These methods are internal to the operation of overdue_notices.pl.
802 parses the letter template, replacing the placeholders with data
803 specific to this patron, biblio, or item
806 letter - required hashref
807 borrowernumber - required integer
808 substitute - optional hashref of other key/value pairs that should
809 be substituted in the letter content
811 returns the C<letter> hashref, with the content updated to reflect the
812 substituted keys and values.
819 foreach my $required (qw( letter_code borrowernumber )) {
820 return unless ( exists $params->{$required} && $params->{$required} );
823 my $substitute = $params->{'substitute'} || {};
824 $substitute->{today} ||= C4::Dates->new()->output("syspref");
826 my %tables = ( 'borrowers' => $params->{'borrowernumber'} );
827 if ( my $p = $params->{'branchcode'} ) {
828 $tables{'branches'} = $p;
831 my $currencies = GetCurrency();
833 $currency_format = $currencies->{currency} if defined($currencies);
836 if ( my $i = $params->{'items'} ) {
837 my $item_format = '';
838 foreach my $item (@$i) {
839 my $fine = GetFine($item->{'itemnumber'}, $params->{'borrowernumber'});
840 if ( !$item_format and defined $params->{'letter'}->{'content'} ) {
841 $params->{'letter'}->{'content'} =~ m/(<item>.*<\/item>)/;
845 $item->{'fine'} = currency_format($currency_format, "$fine", FMT_SYMBOL);
846 # if active currency isn't correct ISO code fallback to sprintf
847 $item->{'fine'} = sprintf('%.2f', $fine) unless $item->{'fine'};
850 'biblio' => $item->{'biblionumber'},
851 'biblioitems' => $item->{'biblionumber'},
853 'issues' => $item->{'itemnumber'},
858 return C4::Letters::GetPreparedLetter (
859 module => 'circulation',
860 letter_code => $params->{'letter_code'},
861 branchcode => $params->{'branchcode'},
863 substitute => $substitute,
864 repeat => { item => \@item_tables },
865 message_transport_type => $params->{message_transport_type},
869 =head2 prepare_letter_for_printing
871 returns a string of text appropriate for printing in the event that an
872 overdue notice will not be sent to the patron's email
873 address. Depending on the desired output format, this may be a CSV
874 string, or a human-readable representation of the notice.
885 sub prepare_letter_for_printing {
888 return unless ref $params eq 'HASH';
890 foreach my $required_parameter (qw( letter borrowernumber )) {
891 return unless defined $params->{$required_parameter};
895 chomp $params->{titles};
896 if ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'csv' ) {
898 $params->{'firstname'}, $params->{'lastname'}, $params->{'address1'}, $params->{'address2'}, $params->{'postcode'},
899 $params->{'city'}, $params->{'country'}, $params->{'email'}, $params->{'itemcount'}, $params->{'titles'}
902 return $csv->string, "\n";
904 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
906 } elsif ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'html' ) {
908 $return .= "$params->{'letter'}->{'content'}\n";
909 $return .= "\n</pre>\n";
911 $return .= "$params->{'letter'}->{'content'}\n";
913 # $return .= Data::Dumper->Dump( [ $params->{'borrowernumber'}, $params->{'letter'} ], [qw( borrowernumber letter )] );