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);
50 overdue_notices.pl - prepare messages to be sent to patrons for overdue items
55 [ -n ][ -library <branchcode> ][ -library <branchcode> ... ]
56 [ -max <number of days> ][ -csv [<filename>] ][ -itemscontent <field list> ]
57 [ -email <email_type> ... ]
60 -help brief help message
61 -man full documentation
62 -n No email will be sent
63 -max <days> maximum days overdue to deal with
64 -library <branchname> only deal with overdues from this library (repeatable : several libraries can be given)
65 -csv <filename> populate CSV file
66 -html <directory> Output html to a file in the given directory
67 -text <directory> Output plain text to a file in the given directory
68 -itemscontent <list of fields> item information in templates
69 -borcat <categorycode> category code that must be included
70 -borcatout <categorycode> category code that must be excluded
71 -email <email_type> type of email that will be used. Can be 'email', 'emailpro' or 'B_email'. Repeatable.
79 Print a brief help message and exits.
83 Prints the manual page and exits.
87 Verbose. Without this flag set, only fatal errors are reported.
91 Do not send any email. Overdue notices that would have been sent to
92 the patrons or to the admin are printed to standard out. CSV data (if
93 the -csv flag is set) is written to standard out or to any csv
98 Items older than max days are assumed to be handled somewhere else,
99 probably the F<longoverdues.pl> script. They are therefore ignored by
100 this program. No notices are sent for them, and they are not added to
101 any CSV files. Defaults to 90 to match F<longoverdues.pl>.
105 select overdues for one specific library. Use the value in the
106 branches.branchcode table. This option can be repeated in order
107 to select overdues for a group of libraries.
111 Produces CSV data. if -n (no mail) flag is set, then this CSV data is
112 sent to standard out or to a filename if provided. Otherwise, only
113 overdues that could not be emailed are sent in CSV format to the admin.
117 Produces html data. If patron does not have an email address or
118 -n (no mail) flag is set, an HTML file is generated in the specified
119 directory. This can be downloaded or futher processed by library staff.
120 The file will be called notices-YYYY-MM-DD.html and placed in the directory
125 Produces plain text data. If patron does not have an email address or
126 -n (no mail) flag is set, a text file is generated in the specified
127 directory. This can be downloaded or futher processed by library staff.
128 The file will be called notices-YYYY-MM-DD.txt and placed in the directory
131 =item B<-itemscontent>
133 comma separated list of fields that get substituted into templates in
134 places of the E<lt>E<lt>items.contentE<gt>E<gt> placeholder. This
135 defaults to due date,title,barcode,author
137 Other possible values come from fields in the biblios, items and
142 Repetable field, that permit to select only few of patrons categories.
146 Repetable field, permis to exclude some patrons categories.
148 =item B<-t> | B<--triggered>
150 This option causes a notice to be generated if and only if
151 an item is overdue by the number of days defined in a notice trigger.
153 By default, a notice is sent each time the script runs, which is suitable for
154 less frequent run cron script, but requires syncing notice triggers with
155 the cron schedule to ensure proper behavior.
156 Add the --triggered option for daily cron, at the risk of no notice
157 being generated if the cron fails to run on time.
161 Default items.content lists only those items that fall in the
162 range of the currently processing notice.
163 Choose list-all to include all overdue items in the list (limited by B<-max> setting).
167 use it in order to send overdues on a specific date and not Now.
171 Allows to specify which type of email will be used. Can be email, emailpro or B_email. Repeatable.
177 This script is designed to alert patrons and administrators of overdue
182 This script pays attention to the overdue notice configuration
183 performed in the "Overdue notice/status triggers" section of the
184 "Tools" area of the staff interface to Koha. There, you can choose
185 which letter templates are sent out after a configurable number of
186 days to patrons of each library. More information about the use of this
187 section of Koha is available in the Koha manual.
189 The templates used to craft the emails are defined in the "Tools:
190 Notices" section of the staff interface to Koha.
192 =head2 Outgoing emails
194 Typically, messages are prepared for each patron with overdue
195 items. Messages for whom there is no email address on file are
196 collected and sent as attachments in a single email to each library
197 administrator, or if that is not set, then to the email address in the
198 C<KohaAdminEmailAddress> system preference.
200 These emails are staged in the outgoing message queue, as are messages
201 produced by other features of Koha. This message queue must be
202 processed regularly by the
203 F<misc/cronjobs/process_message_queue.pl> program.
205 In the event that the C<-n> flag is passed to this program, no emails
206 are sent. Instead, messages are sent on standard output from this
207 program. They may be redirected to a file if desired.
211 Templates can contain variables enclosed in double angle brackets like
212 E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
213 specific to the overdue items or relevant patron. Available variables
218 =item E<lt>E<lt>bibE<gt>E<gt>
220 the name of the library
222 =item E<lt>E<lt>items.contentE<gt>E<gt>
224 one line for each item, each line containing a tab separated list of
225 title, author, barcode, issuedate
227 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
229 any field from the borrowers table
231 =item E<lt>E<lt>branches.*E<gt>E<gt>
233 any field from the branches table
239 The C<-csv> command line option lets you specify a file to which
240 overdues data should be output in CSV format.
242 With the C<-n> flag set, data about all overdues is written to the
243 file. Without that flag, only information about overdues that were
244 unable to be sent directly to the patrons will be written. In other
245 words, this CSV file replaces the data that is typically sent to the
246 administrator email address.
248 =head1 USAGE EXAMPLES
250 C<overdue_notices.pl> - In this most basic usage, with no command line
251 arguments, all libraries are procesed individually, and notices are
252 prepared for all patrons with overdue items for whom we have email
253 addresses. Messages for those patrons for whom we have no email
254 address are sent in a single attachment to the library administrator's
255 email address, or to the address in the KohaAdminEmailAddress system
258 C<overdue_notices.pl -n -csv /tmp/overdues.csv> - sends no email and
259 populates F</tmp/overdues.csv> with information about all overdue
262 C<overdue_notices.pl -library MAIN max 14> - prepare notices of
263 overdues in the last 2 weeks for the MAIN library.
267 The F<misc/cronjobs/advance_notices.pl> program allows you to send
268 messages to patrons in advance of thier items becoming due, or to
269 alert them of items that have just become due.
273 # These variables are set by command line options.
274 # They are initially set to default values.
275 my $dbh = C4::Context->dbh();
281 my @branchcodes; # Branch(es) passed as parameter
282 my @emails_to_use; # Emails to use for messaging
283 my @emails; # Emails given in command-line parameters
289 my $itemscontent = join( ',', qw( date_due title barcode author itemnumber ) );
300 'library=s' => \@branchcodes,
301 'csv:s' => \$csvfilename, # this optional argument gets '' if not supplied.
302 'html:s' => \$htmlfilename, # this optional argument gets '' if not supplied.
303 'text:s' => \$text_filename, # this optional argument gets '' if not supplied.
304 'itemscontent=s' => \$itemscontent,
305 'list-all' => \$listall,
306 't|triggered' => \$triggered,
308 'borcat=s' => \@myborcat,
309 'borcatout=s' => \@myborcatout,
310 'email=s' => \@emails,
312 pod2usage(1) if $help;
313 pod2usage( -verbose => 2 ) if $man;
315 if ( defined $csvfilename && $csvfilename =~ /^-/ ) {
316 warn qq(using "$csvfilename" as filename, that seems odd);
319 my @overduebranches = C4::Overdues::GetBranchcodesWithOverdueRules(); # Branches with overdue rules
320 my @branches; # Branches passed as parameter with overdue rules
321 my $branchcount = scalar(@overduebranches);
323 my $overduebranch_word = scalar @overduebranches > 1 ? 'branches' : 'branch';
324 my $branchcodes_word = scalar @branchcodes > 1 ? 'branches' : 'branch';
326 my $PrintNoticesMaxLines = C4::Context->preference('PrintNoticesMaxLines');
329 $verbose and warn "Found $branchcount $overduebranch_word with first message enabled: " . join( ', ', map { "'$_'" } @overduebranches ), "\n";
331 die 'No branches with active overduerules';
335 $verbose and warn "$branchcodes_word @branchcodes passed on parameter\n";
337 # Getting libraries which have overdue rules
338 my %seen = map { $_ => 1 } @branchcodes;
339 @branches = grep { $seen{$_} } @overduebranches;
344 my $branch_word = scalar @branches > 1 ? 'branches' : 'branch';
345 $verbose and warn "$branch_word @branches have overdue rules\n";
349 $verbose and warn "No active overduerules for $branchcodes_word '@branchcodes'\n";
350 ( scalar grep { '' eq $_ } @branches )
351 or die "No active overduerules for DEFAULT either!";
352 $verbose and warn "Falling back on default rules for @branchcodes\n";
358 $date=$dbh->quote($date);
364 # these are the fields that will be substituted into <<item.content>>
365 my @item_content_fields = split( /,/, $itemscontent );
367 binmode( STDOUT, ':encoding(UTF-8)' );
370 our $csv; # the Text::CSV_XS object
371 our $csv_fh; # the filehandle to the CSV file.
372 if ( defined $csvfilename ) {
373 my $sep_char = C4::Context->preference('delimiter') || ';';
374 $sep_char = "\t" if ($sep_char eq 'tabulation');
375 $csv = Text::CSV_XS->new( { binary => 1 , sep_char => $sep_char } );
376 if ( $csvfilename eq '' ) {
379 open $csv_fh, ">", $csvfilename or die "unable to open $csvfilename: $!";
381 if ( $csv->combine(qw(name surname address1 address2 zipcode city country email itemcount itemsinfo)) ) {
382 print $csv_fh $csv->string, "\n";
384 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
388 @branches = @overduebranches unless @branches;
390 if ( defined $htmlfilename ) {
391 if ( $htmlfilename eq '' ) {
394 my $today = DateTime->now(time_zone => C4::Context->tz );
395 open $fh, ">",File::Spec->catdir ($htmlfilename,"notices-".$today->ymd().".html");
398 print $fh "<html>\n";
399 print $fh "<head>\n";
400 print $fh "<style type='text/css'>\n";
401 print $fh "pre {page-break-after: always;}\n";
402 print $fh "pre {white-space: pre-wrap;}\n";
403 print $fh "pre {white-space: -moz-pre-wrap;}\n";
404 print $fh "pre {white-space: -o-pre-wrap;}\n";
405 print $fh "pre {word-wrap: break-work;}\n";
406 print $fh "</style>\n";
407 print $fh "</head>\n";
408 print $fh "<body>\n";
410 elsif ( defined $text_filename ) {
411 if ( $text_filename eq '' ) {
414 my $today = DateTime->now(time_zone => C4::Context->tz );
415 open $fh, ">",File::Spec->catdir ($text_filename,"notices-".$today->ymd().".txt");
419 foreach my $branchcode (@branches) {
421 my $branch_details = C4::Branch::GetBranchDetail($branchcode);
422 my $admin_email_address = $branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
423 my @output_chunks; # may be sent to mail or stdout or csv file.
425 $verbose and warn sprintf "branchcode : '%s' using %s\n", $branchcode, $admin_email_address;
427 my $sth2 = $dbh->prepare( <<"END_SQL" );
428 SELECT biblio.*, items.*, issues.*, biblioitems.itemtype, TO_DAYS($date)-TO_DAYS(date_due) AS days_overdue
429 FROM issues,items,biblio, biblioitems
430 WHERE items.itemnumber=issues.itemnumber
431 AND biblio.biblionumber = items.biblionumber
432 AND biblio.biblionumber = biblioitems.biblionumber
433 AND issues.borrowernumber = ?
434 AND TO_DAYS($date)-TO_DAYS(date_due) BETWEEN ? and ?
437 my $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = ? ";
438 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
439 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
441 my $rqoverduerules = $dbh->prepare($query);
442 $rqoverduerules->execute($branchcode, @myborcat, @myborcatout);
444 # We get default rules is there is no rule for this branch
445 if($rqoverduerules->rows == 0){
446 $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 $rqoverduerules = $dbh->prepare($query);
451 $rqoverduerules->execute(@myborcat, @myborcatout);
454 # my $outfile = 'overdues_' . ( $mybranch || $branchcode || 'default' );
455 while ( my $overdue_rules = $rqoverduerules->fetchrow_hashref ) {
456 PERIOD: foreach my $i ( 1 .. 3 ) {
457 my $print_sent = 0; # We never sent a print notice
459 $verbose and warn "branch '$branchcode', pass $i\n";
460 my $mindays = $overdue_rules->{"delay$i"}; # the notice will be sent after mindays days (grace period)
462 $overdue_rules->{ "delay" . ( $i + 1 ) }
463 ? $overdue_rules->{ "delay" . ( $i + 1 ) } - 1
465 ); # issues being more than maxdays late are managed somewhere else. (borrower probably suspended)
467 if ( !$overdue_rules->{"letter$i"} ) {
468 $verbose and warn "No letter$i code for branch '$branchcode'";
472 # $letter->{'content'} is the text of the mail that is sent.
473 # this text contains fields that are replaced by their value. Those fields must be written between brackets
474 # The following fields are available :
475 # 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).
476 # <date> <itemcount> <firstname> <lastname> <address1> <address2> <address3> <city> <postcode> <country>
478 my $borrower_sql = <<'END_SQL';
479 SELECT distinct(issues.borrowernumber), firstname, surname, address, address2, city, zipcode, country, email, emailpro, B_email, smsalertnumber
480 FROM issues,borrowers,categories
481 WHERE issues.borrowernumber=borrowers.borrowernumber
482 AND borrowers.categorycode=categories.categorycode
484 my @borrower_parameters;
486 $borrower_sql .= ' AND issues.branchcode=? ';
487 push @borrower_parameters, $branchcode;
489 if ( $overdue_rules->{categorycode} ) {
490 $borrower_sql .= ' AND borrowers.categorycode=? ';
491 push @borrower_parameters, $overdue_rules->{categorycode};
493 $borrower_sql .= ' AND categories.overduenoticerequired=1 ';
495 $borrower_sql .= " AND TO_DAYS($date)-TO_DAYS(date_due) = ?";
496 push @borrower_parameters, $mindays;
498 $borrower_sql .= " AND TO_DAYS($date)-TO_DAYS(date_due) BETWEEN ? and ? " ;
499 push @borrower_parameters, $mindays, $maxdays;
502 # $sth gets borrower info iff at least one overdue item has triggered the overdue action.
503 my $sth = $dbh->prepare($borrower_sql);
504 $sth->execute(@borrower_parameters);
505 $verbose and warn $borrower_sql . "\n $branchcode | " . $overdue_rules->{'categorycode'} . "\n ($mindays, $maxdays)\nreturns " . $sth->rows . " rows";
507 while ( my $data = $sth->fetchrow_hashref ) {
508 my $borrowernumber = $data->{'borrowernumber'};
510 $data->{'firstname'} . ', '
511 . $data->{'surname'} . ' ('
512 . $borrowernumber . ')';
514 and warn "borrower $borr has items triggering level $i.";
518 C4::Members::GetNoticeEmailAddress($borrowernumber);
522 push @emails_to_use, $data->{$_} if ( $data->{$_} );
526 push @emails_to_use, $notice_email if ($notice_email);
530 my $letter = C4::Letters::getletter( 'circulation', $overdue_rules->{"letter$i"}, $branchcode );
533 $verbose and warn "Message '$overdue_rules->{letter$i}' content not found";
535 # might as well skip while PERIOD, no other borrowers are going to work.
536 # FIXME : Does this mean a letter must be defined in order to trigger a debar ?
540 if ( $overdue_rules->{"debarred$i"} ) {
542 #action taken is debarring
545 borrowernumber => $borrowernumber,
547 comment => "Restriction added by overdues process "
548 . output_pref( dt_from_string() ),
551 $verbose and warn "debarring $borr\n";
553 my @params = ($listall ? ( $borrowernumber , 1 , $MAX ) : ( $borrowernumber, $mindays, $maxdays ));
554 $verbose and warn "STH2 PARAMS: borrowernumber = $borrowernumber, mindays = $mindays, maxdays = $maxdays";
555 $sth2->execute(@params);
561 my $exceededPrintNoticesMaxLines = 0;
562 while ( my $item_info = $sth2->fetchrow_hashref() ) {
563 if ( ( scalar(@emails_to_use) == 0 || $nomail ) && $PrintNoticesMaxLines && $j >= $PrintNoticesMaxLines ) {
564 $exceededPrintNoticesMaxLines = 1;
568 my @item_info = map { $_ =~ /^date|date$/ ? format_date( $item_info->{$_} ) : $item_info->{$_} || '' } @item_content_fields;
569 $titles .= join("\t", @item_info) . "\n";
571 push @items, $item_info;
575 my @message_transport_types = @{ GetOverdueMessageTransportTypes( $branchcode, $overdue_rules->{categorycode}, $i) };
576 @message_transport_types = @{ GetOverdueMessageTransportTypes( q{}, $overdue_rules->{categorycode}, $i) }
577 unless @message_transport_types;
579 for my $mtt ( @message_transport_types ) {
581 my $letter = parse_letter(
582 { letter_code => $overdue_rules->{"letter$i"},
583 borrowernumber => $borrowernumber,
584 branchcode => $branchcode,
586 substitute => { # this appears to be a hack to overcome incomplete features in this code.
587 bib => $branch_details->{'branchname'}, # maybe 'bib' is a typo for 'lib<rary>'?
588 'items.content' => $titles,
589 'count' => $itemcount,
591 message_transport_type => $mtt,
595 $verbose and warn "Message '$overdue_rules->{letter$i}' content not found";
597 # might as well skip while PERIOD, no other borrowers are going to work.
598 # FIXME : Does this mean a letter must be defined in order to trigger a debar ?
602 if ( $exceededPrintNoticesMaxLines ) {
603 $letter->{'content'} .= "List too long for form; please check your account online for a complete list of your overdue items.";
606 my @misses = grep { /./ } map { /^([^>]*)[>]+/; ( $1 || '' ); } split /\</, $letter->{'content'};
608 $verbose and warn "The following terms were not matched and replaced: \n\t" . join "\n\t", @misses;
613 prepare_letter_for_printing(
615 borrowernumber => $borrowernumber,
616 firstname => $data->{'firstname'},
617 lastname => $data->{'surname'},
618 address1 => $data->{'address'},
619 address2 => $data->{'address2'},
620 city => $data->{'city'},
621 postcode => $data->{'zipcode'},
622 country => $data->{'country'},
623 email => $notice_email,
624 itemcount => $itemcount,
626 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : defined $text_filename ? 'text' : '',
630 if ( ($mtt eq 'email' and not scalar @emails_to_use) or ($mtt eq 'sms' and not $data->{smsalertnumber}) ) {
631 # email or sms is requested but not exist, do a print.
634 unless ( $mtt eq 'print' and $print_sent == 1 ) {
635 # Just sent a print if not already done.
636 C4::Letters::EnqueueLetter(
638 borrowernumber => $borrowernumber,
639 message_transport_type => $mtt,
640 from_address => $admin_email_address,
641 to_address => join(',', @emails_to_use),
644 # A print notice should be sent only once per overdue level.
645 # 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.
646 $print_sent = 1 if $mtt eq 'print';
655 if (@output_chunks) {
656 if ( defined $csvfilename ) {
657 print $csv_fh @output_chunks;
659 elsif ( defined $htmlfilename ) {
660 print $fh @output_chunks;
662 elsif ( defined $text_filename ) {
663 print $fh @output_chunks;
666 local $, = "\f"; # pagebreak
667 print @output_chunks;
669 # Generate the content of the csv with headers
671 if ( defined $csvfilename ) {
672 my $delimiter = C4::Context->preference('delimiter') || ';';
673 $content = join($delimiter, qw(title name surname address1 address2 zipcode city country email itemcount itemsinfo due_date issue_date)) . "\n";
678 $content .= join( "\n", @output_chunks );
681 filename => defined $csvfilename ? 'attachment.csv' : 'attachment.txt',
682 type => 'text/plain',
687 title => 'Overdue Notices',
688 content => 'These messages were not sent directly to the patrons.',
690 C4::Letters::EnqueueLetter(
692 borrowernumber => undef,
693 message_transport_type => 'email',
694 attachments => [$attachment],
695 to_address => $admin_email_address,
702 # note that we're not testing on $csv_fh to prevent closing
707 if ( defined $htmlfilename ) {
708 print $fh "</body>\n";
709 print $fh "</html>\n";
711 } elsif ( defined $text_filename ) {
715 =head1 INTERNAL METHODS
717 These methods are internal to the operation of overdue_notices.pl.
721 parses the letter template, replacing the placeholders with data
722 specific to this patron, biblio, or item
725 letter - required hashref
726 borrowernumber - required integer
727 substitute - optional hashref of other key/value pairs that should
728 be substituted in the letter content
730 returns the C<letter> hashref, with the content updated to reflect the
731 substituted keys and values.
738 foreach my $required (qw( letter_code borrowernumber )) {
739 return unless ( exists $params->{$required} && $params->{$required} );
742 my $substitute = $params->{'substitute'} || {};
743 $substitute->{today} ||= C4::Dates->new()->output("syspref");
745 my %tables = ( 'borrowers' => $params->{'borrowernumber'} );
746 if ( my $p = $params->{'branchcode'} ) {
747 $tables{'branches'} = $p;
750 my $currencies = GetCurrency();
752 $currency_format = $currencies->{currency} if defined($currencies);
755 if ( my $i = $params->{'items'} ) {
756 my $item_format = '';
757 foreach my $item (@$i) {
758 my $fine = GetFine($item->{'itemnumber'}, $params->{'borrowernumber'});
759 if ( !$item_format and defined $params->{'letter'}->{'content'} ) {
760 $params->{'letter'}->{'content'} =~ m/(<item>.*<\/item>)/;
764 $item->{'fine'} = currency_format($currency_format, "$fine", FMT_SYMBOL);
765 # if active currency isn't correct ISO code fallback to sprintf
766 $item->{'fine'} = sprintf('%.2f', $fine) unless $item->{'fine'};
769 'biblio' => $item->{'biblionumber'},
770 'biblioitems' => $item->{'biblionumber'},
772 'issues' => $item->{'itemnumber'},
777 return C4::Letters::GetPreparedLetter (
778 module => 'circulation',
779 letter_code => $params->{'letter_code'},
780 branchcode => $params->{'branchcode'},
782 substitute => $substitute,
783 repeat => { item => \@item_tables },
784 message_transport_type => $params->{message_transport_type},
788 =head2 prepare_letter_for_printing
790 returns a string of text appropriate for printing in the event that an
791 overdue notice will not be sent to the patron's email
792 address. Depending on the desired output format, this may be a CSV
793 string, or a human-readable representation of the notice.
804 sub prepare_letter_for_printing {
807 return unless ref $params eq 'HASH';
809 foreach my $required_parameter (qw( letter borrowernumber )) {
810 return unless defined $params->{$required_parameter};
814 chomp $params->{titles};
815 if ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'csv' ) {
817 $params->{'firstname'}, $params->{'lastname'}, $params->{'address1'}, $params->{'address2'}, $params->{'postcode'},
818 $params->{'city'}, $params->{'country'}, $params->{'email'}, $params->{'itemcount'}, $params->{'titles'}
821 return $csv->string, "\n";
823 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
825 } elsif ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'html' ) {
827 my $content = $params->{'letter'}->{'content'};
828 $content =~ s/\n/<br \/>/g;
830 $return .= "$content\n";
831 $return .= "\n</pre>\n";
833 $return .= "$params->{'letter'}->{'content'}\n";
835 # $return .= Data::Dumper->Dump( [ $params->{'borrowernumber'}, $params->{'letter'} ], [qw( borrowernumber letter )] );