Merge remote branch 'kc/new/bug_5381' into kcmaster
[wip/koha-chris_n.git] / misc / cronjobs / overdue_notices.pl
1 #!/usr/bin/perl
2
3 # Copyright 2008 Liblime
4 #
5 # This file is part of Koha.
6 #
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
10 # version.
11 #
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19
20 use strict;
21 use warnings;
22
23 BEGIN {
24
25     # find Koha's Perl modules
26     # test carefully before changing this
27     use FindBin;
28     eval { require "$FindBin::Bin/../kohalib.pl" };
29 }
30
31 use Getopt::Long;
32 use Pod::Usage;
33 use Text::CSV_XS;
34 use Locale::Currency::Format 1.28;
35 use Encode;
36
37 use C4::Context;
38 use C4::Dates qw/format_date/;
39 use C4::Debug;
40 use C4::Letters;
41 use C4::Overdues qw(GetFine);
42
43 =head1 NAME
44
45 overdue_notices.pl - prepare messages to be sent to patrons for overdue items
46
47 =head1 SYNOPSIS
48
49 overdue_notices.pl [ -n ] [ -library <branchcode> ] [ -library <branchcode>...] [ -max <number of days> ] [ -csv [ <filename> ] ] [ -itemscontent <field list> ]
50
51  Options:
52    -help                          brief help message
53    -man                           full documentation
54    -n                             No email will be sent
55    -max          <days>           maximum days overdue to deal with
56    -library      <branchname>     only deal with overdues from this library (repeatable : several libraries can be given)
57    -csv          <filename>       populate CSV file
58    -html         <filename>       Output html to file
59    -itemscontent <list of fields> item information in templates
60    -borcat       <categorycode>   category code that must be included
61    -borcatout    <categorycode>   category code that must be excluded
62
63 =head1 OPTIONS
64
65 =over 8
66
67 =item B<-help>
68
69 Print a brief help message and exits.
70
71 =item B<-man>
72
73 Prints the manual page and exits.
74
75 =item B<-v>
76
77 Verbose. Without this flag set, only fatal errors are reported.
78
79 =item B<-n>
80
81 Do not send any email. Overdue notices that would have been sent to
82 the patrons or to the admin are printed to standard out. CSV data (if
83 the -csv flag is set) is written to standard out or to any csv
84 filename given.
85
86 =item B<-max>
87
88 Items older than max days are assumed to be handled somewhere else,
89 probably the F<longoverdues.pl> script. They are therefore ignored by
90 this program. No notices are sent for them, and they are not added to
91 any CSV files. Defaults to 90 to match F<longoverdues.pl>.
92
93 =item B<-library>
94
95 select overdues for one specific library. Use the value in the
96 branches.branchcode table. This option can be repeated in order 
97 to select overdues for a group of libraries.
98
99 =item B<-csv>
100
101 Produces CSV data. if -n (no mail) flag is set, then this CSV data is
102 sent to standard out or to a filename if provided. Otherwise, only
103 overdues that could not be emailed are sent in CSV format to the admin.
104
105 =item B<-html>
106
107 Produces html data. if patron does not have a mail address or
108 -n (no mail) flag is set, an html file is generated in the specified
109 directory. This can be downloaded or futher processed by library staff.
110
111 =item B<-itemscontent>
112
113 comma separated list of fields that get substituted into templates in
114 places of the E<lt>E<lt>items.contentE<gt>E<gt> placeholder. This
115 defaults to issuedate,title,barcode,author
116
117 Other possible values come from fields in the biblios, items, and
118 issues tables.
119
120 =item B<-borcat>
121
122 Repetable field, that permit to select only few of patrons categories.
123
124 =item B<-borcatout>
125
126 Repetable field, permis to exclude some patrons categories.
127
128 =item B<-t> | B<--triggered>
129
130 This option causes a notice to be generated if and only if 
131 an item is overdue by the number of days defined in a notice trigger.
132
133 By default, a notice is sent each time the script runs, which is suitable for 
134 less frequent run cron script, but requires syncing notice triggers with 
135 the  cron schedule to ensure proper behavior.
136 Add the --triggered option for daily cron, at the risk of no notice 
137 being generated if the cron fails to run on time.
138
139 =item B<-list-all>
140
141 Default items.content lists only those items that fall in the 
142 range of the currently processing notice.
143 Choose list-all to include all overdue items in the list (limited by B<-max> setting).
144
145 =back
146
147 =head1 DESCRIPTION
148
149 This script is designed to alert patrons and administrators of overdue
150 items.
151
152 =head2 Configuration
153
154 This script pays attention to the overdue notice configuration
155 performed in the "Overdue notice/status triggers" section of the
156 "Tools" area of the staff interface to Koha. There, you can choose
157 which letter templates are sent out after a configurable number of
158 days to patrons of each library. More information about the use of this
159 section of Koha is available in the Koha manual.
160
161 The templates used to craft the emails are defined in the "Tools:
162 Notices" section of the staff interface to Koha.
163
164 =head2 Outgoing emails
165
166 Typically, messages are prepared for each patron with overdue
167 items. Messages for whom there is no email address on file are
168 collected and sent as attachments in a single email to each library
169 administrator, or if that is not set, then to the email address in the
170 C<KohaAdminEmailAddress> system preference.
171
172 These emails are staged in the outgoing message queue, as are messages
173 produced by other features of Koha. This message queue must be
174 processed regularly by the
175 F<misc/cronjobs/process_message_queue.pl> program.
176
177 In the event that the C<-n> flag is passed to this program, no emails
178 are sent. Instead, messages are sent on standard output from this
179 program. They may be redirected to a file if desired.
180
181 =head2 Templates
182
183 Templates can contain variables enclosed in double angle brackets like
184 E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
185 specific to the overdue items or relevant patron. Available variables
186 are:
187
188 =over
189
190 =item E<lt>E<lt>bibE<gt>E<gt>
191
192 the name of the library
193
194 =item E<lt>E<lt>items.contentE<gt>E<gt>
195
196 one line for each item, each line containing a tab separated list of
197 title, author, barcode, issuedate
198
199 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
200
201 any field from the borrowers table
202
203 =item E<lt>E<lt>branches.*E<gt>E<gt>
204
205 any field from the branches table
206
207 =back
208
209 =head2 CSV output
210
211 The C<-csv> command line option lets you specify a file to which
212 overdues data should be output in CSV format.
213
214 With the C<-n> flag set, data about all overdues is written to the
215 file. Without that flag, only information about overdues that were
216 unable to be sent directly to the patrons will be written. In other
217 words, this CSV file replaces the data that is typically sent to the
218 administrator email address.
219
220 =head1 USAGE EXAMPLES
221
222 C<overdue_notices.pl> - In this most basic usage, with no command line
223 arguments, all libraries are procesed individually, and notices are
224 prepared for all patrons with overdue items for whom we have email
225 addresses. Messages for those patrons for whom we have no email
226 address are sent in a single attachment to the library administrator's
227 email address, or to the address in the KohaAdminEmailAddress system
228 preference.
229
230 C<overdue_notices.pl -n -csv /tmp/overdues.csv> - sends no email and
231 populates F</tmp/overdues.csv> with information about all overdue
232 items.
233
234 C<overdue_notices.pl -library MAIN max 14> - prepare notices of
235 overdues in the last 2 weeks for the MAIN library.
236
237 =head1 SEE ALSO
238
239 The F<misc/cronjobs/advance_notices.pl> program allows you to send
240 messages to patrons in advance of thier items becoming due, or to
241 alert them of items that have just become due.
242
243 =cut
244
245 # These variables are set by command line options.
246 # They are initially set to default values.
247 my $dbh = C4::Context->dbh();
248 my $help    = 0;
249 my $man     = 0;
250 my $verbose = 0;
251 my $nomail  = 0;
252 my $MAX     = 90;
253 my @branchcodes; # Branch(es) passed as parameter
254 my $csvfilename;
255 my $htmlfilename;
256 my $triggered = 0;
257 my $listall = 0;
258 my $itemscontent = join( ',', qw( issuedate title barcode author itemnumber ) );
259 my @myborcat;
260 my @myborcatout;
261
262 GetOptions(
263     'help|?'         => \$help,
264     'man'            => \$man,
265     'v'              => \$verbose,
266     'n'              => \$nomail,
267     'max=s'          => \$MAX,
268     'library=s'      => \@branchcodes,
269     'csv:s'          => \$csvfilename,    # this optional argument gets '' if not supplied.
270     'html:s'          => \$htmlfilename,    # this optional argument gets '' if not supplied.
271     'itemscontent=s' => \$itemscontent,
272     'list-all'      => \$listall,
273     't|triggered'             => \$triggered,
274     'borcat=s'      => \@myborcat,
275     'borcatout=s'   => \@myborcatout,
276 ) or pod2usage(2);
277 pod2usage(1) if $help;
278 pod2usage( -verbose => 2 ) if $man;
279
280 if ( defined $csvfilename && $csvfilename =~ /^-/ ) {
281     warn qq(using "$csvfilename" as filename, that seems odd);
282 }
283
284 my @overduebranches    = C4::Overdues::GetBranchcodesWithOverdueRules();        # Branches with overdue rules
285 my @branches;                                                                   # Branches passed as parameter with overdue rules
286 my $branchcount = scalar(@overduebranches);
287
288 my $overduebranch_word = scalar @overduebranches > 1 ? 'branches' : 'branch';
289 my $branchcodes_word = scalar @branchcodes > 1 ? 'branches' : 'branch';
290
291 my $PrintNoticesMaxLines = C4::Context->preference('PrintNoticesMaxLines');
292
293 if ($branchcount) {
294     $verbose and warn "Found $branchcount $overduebranch_word with first message enabled: " . join( ', ', map { "'$_'" } @overduebranches ), "\n";
295 } else {
296     die 'No branches with active overduerules';
297 }
298
299 if (@branchcodes) {
300     $verbose and warn "$branchcodes_word @branchcodes passed on parameter\n";
301     
302     # Getting libraries which have overdue rules
303     my %seen = map { $_ => 1 } @branchcodes;
304     @branches = grep { $seen{$_} } @overduebranches;
305     
306     
307     if (@overduebranches) {
308
309         my $branch_word = scalar @branches > 1 ? 'branches' : 'branch';
310         $verbose and warn "$branch_word @branches have overdue rules\n";
311
312     } else {
313     
314         $verbose and warn "No active overduerules for $branchcodes_word  '@branchcodes'\n";
315         ( scalar grep { '' eq $_ } @branches )
316           or die "No active overduerules for DEFAULT either!";
317         $verbose and warn "Falling back on default rules for @branchcodes\n";
318         @branches = ('');
319     }
320 }
321
322 # these are the fields that will be substituted into <<item.content>>
323 my @item_content_fields = split( /,/, $itemscontent );
324
325 binmode( STDOUT, ":utf8" );
326
327
328 our $csv;       # the Text::CSV_XS object
329 our $csv_fh;    # the filehandle to the CSV file.
330 if ( defined $csvfilename ) {
331     my $sep_char = C4::Context->preference('delimiter') || ',';
332     $csv = Text::CSV_XS->new( { binary => 1 , sep_char => $sep_char } );
333     if ( $csvfilename eq '' ) {
334         $csv_fh = *STDOUT;
335     } else {
336         open $csv_fh, ">", $csvfilename or die "unable to open $csvfilename: $!";
337     }
338     if ( $csv->combine(qw(name surname address1 address2 zipcode city country email itemcount itemsinfo)) ) {
339         print $csv_fh $csv->string, "\n";
340     } else {
341         $verbose and warn 'combine failed on argument: ' . $csv->error_input;
342     }
343 }
344
345 @branches = @overduebranches unless @branches;
346 our $html_fh;
347 if ( defined $htmlfilename ) {
348   if ( $htmlfilename eq '' ) {
349     $html_fh = *STDOUT;
350   } else {
351     my $today = C4::Dates->new();
352     open $html_fh, ">",File::Spec->catdir ($htmlfilename,"notices-".$today->output('iso').".html");
353   }
354   
355   print $html_fh "<html>\n";
356   print $html_fh "<head>\n";
357   print $html_fh "<style type='text/css'>\n";
358   print $html_fh "pre {page-break-after: always;}\n";
359   print $html_fh "pre {white-space: pre-wrap;}\n";
360   print $html_fh "pre {white-space: -moz-pre-wrap;}\n";
361   print $html_fh "pre {white-space: -o-pre-wrap;}\n";
362   print $html_fh "pre {word-wrap: break-work;}\n";
363   print $html_fh "</style>\n";
364   print $html_fh "</head>\n";
365   print $html_fh "<body>\n";
366 }
367
368 foreach my $branchcode (@branches) {
369
370     my $branch_details = C4::Branch::GetBranchDetail($branchcode);
371     my $admin_email_address = $branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
372     my @output_chunks;    # may be sent to mail or stdout or csv file.
373
374     $verbose and warn sprintf "branchcode : '%s' using %s\n", $branchcode, $admin_email_address;
375
376     my $sth2 = $dbh->prepare( <<'END_SQL' );
377 SELECT biblio.*, items.*, issues.*, TO_DAYS(NOW())-TO_DAYS(date_due) AS days_overdue
378   FROM issues,items,biblio
379   WHERE items.itemnumber=issues.itemnumber
380     AND biblio.biblionumber   = items.biblionumber
381     AND issues.borrowernumber = ?
382     AND TO_DAYS(NOW())-TO_DAYS(date_due) BETWEEN ? and ?
383 END_SQL
384
385     my $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = ? ";
386     $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
387     $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
388     
389     my $rqoverduerules =  $dbh->prepare($query);
390     $rqoverduerules->execute($branchcode, @myborcat, @myborcatout);
391     
392     # We get default rules is there is no rule for this branch
393     if($rqoverduerules->rows == 0){
394         $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = '' ";
395         $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
396         $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
397         
398         $rqoverduerules = $dbh->prepare($query);
399         $rqoverduerules->execute(@myborcat, @myborcatout);
400     }
401
402     # my $outfile = 'overdues_' . ( $mybranch || $branchcode || 'default' );
403     while ( my $overdue_rules = $rqoverduerules->fetchrow_hashref ) {
404       PERIOD: foreach my $i ( 1 .. 3 ) {
405
406             $verbose and warn "branch '$branchcode', pass $i\n";
407             my $mindays = $overdue_rules->{"delay$i"};    # the notice will be sent after mindays days (grace period)
408             my $maxdays = (
409                   $overdue_rules->{ "delay" . ( $i + 1 ) }
410                 ? $overdue_rules->{ "delay" . ( $i + 1 ) }
411                 : ($MAX)
412             );                                            # issues being more than maxdays late are managed somewhere else. (borrower probably suspended)
413
414             if ( !$overdue_rules->{"letter$i"} ) {
415                 $verbose and warn "No letter$i code for branch '$branchcode'";
416                 next PERIOD;
417             }
418
419             # $letter->{'content'} is the text of the mail that is sent.
420             # this text contains fields that are replaced by their value. Those fields must be written between brackets
421             # The following fields are available :
422             # 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).
423             # <date> <itemcount> <firstname> <lastname> <address1> <address2> <address3> <city> <postcode>
424
425             my $borrower_sql = <<'END_SQL';
426 SELECT COUNT(*), issues.borrowernumber, firstname, surname, address, address2, city, zipcode, country, email, MIN(date_due) as longest_issue
427 FROM   issues,borrowers,categories
428 WHERE  issues.borrowernumber=borrowers.borrowernumber
429 AND    borrowers.categorycode=categories.categorycode
430 END_SQL
431             my @borrower_parameters;
432             if ($branchcode) {
433                 $borrower_sql .= ' AND issues.branchcode=? ';
434                 push @borrower_parameters, $branchcode;
435             }
436             if ( $overdue_rules->{categorycode} ) {
437                 $borrower_sql .= ' AND borrowers.categorycode=? ';
438                 push @borrower_parameters, $overdue_rules->{categorycode};
439             }
440             $borrower_sql .= '  AND categories.overduenoticerequired=1
441                                 GROUP BY issues.borrowernumber ';
442             if($triggered) {
443                 $borrower_sql .= ' HAVING TO_DAYS(NOW())-TO_DAYS(longest_issue) = ?';
444                 push @borrower_parameters, $mindays;
445             } else {
446                 $borrower_sql .= ' HAVING TO_DAYS(NOW())-TO_DAYS(longest_issue) BETWEEN ? and ? ' ;
447                 push @borrower_parameters, $mindays, $maxdays;
448             }
449
450             # $sth gets borrower info iff at least one overdue item has triggered the overdue action.
451                 my $sth = $dbh->prepare($borrower_sql);
452             $sth->execute(@borrower_parameters);
453             $verbose and warn $borrower_sql . "\n $branchcode | " . $overdue_rules->{'categorycode'} . "\n ($mindays, $maxdays)\nreturns " . $sth->rows . " rows";
454
455             while ( my ($itemcount, $borrowernumber, $firstname, $lastname,
456                     $address1, $address2, $city, $postcode, $country, $email,
457                     $longest_issue ) = $sth->fetchrow )
458             {
459                 $verbose and warn "borrower $firstname, $lastname ($borrowernumber) has $itemcount items triggering level $i.";
460     
461                 my $letter = C4::Letters::getletter( 'circulation', $overdue_rules->{"letter$i"} );
462
463                 unless ($letter) {
464                     $verbose and warn "Message '$overdue_rules->{letter$i}' content not found";
465     
466                     # might as well skip while PERIOD, no other borrowers are going to work.
467                     # FIXME : Does this mean a letter must be defined in order to trigger a debar ?
468                     next PERIOD;
469                 }
470     
471                 if ( $overdue_rules->{"debarred$i"} ) {
472     
473                     #action taken is debarring
474                     C4::Members::DebarMember($borrowernumber);
475                     $verbose and warn "debarring $borrowernumber $firstname $lastname\n";
476                 }
477                 my @params = ($listall ? ( $borrowernumber , 1 , $MAX ) : ( $borrowernumber, $mindays, $maxdays ));
478                 $verbose and warn "STH2 PARAMS: borrowernumber = $borrowernumber, mindays = $mindays, maxdays = $maxdays";
479                 $sth2->execute(@params);
480                 my $itemcount = 0;
481                 my $titles = "";
482                 my @items = ();
483                 
484                 my $i = 0;
485                 my $exceededPrintNoticesMaxLines = 0;
486                 while ( my $item_info = $sth2->fetchrow_hashref() ) {
487                     if ( ( !$email || $nomail ) && $PrintNoticesMaxLines && $i >= $PrintNoticesMaxLines ) {
488                       $exceededPrintNoticesMaxLines = 1;
489                       last;
490                     }
491                     $i++;
492                     my @item_info = map { $_ =~ /^date|date$/ ? format_date( $item_info->{$_} ) : $item_info->{$_} || '' } @item_content_fields;
493                     $titles .= join("\t", @item_info) . "\n";
494                     $itemcount++;
495                     push @items, { itemnumber => $item_info->{'itemnumber'}, biblionumber => $item_info->{'biblionumber'} };
496                 }
497                 $sth2->finish;
498                 $letter = parse_letter(
499                     {   letter          => $letter,
500                         borrowernumber  => $borrowernumber,
501                         branchcode      => $branchcode,
502                         items           => \@items,
503                         substitute      => {    # this appears to be a hack to overcome incomplete features in this code.
504                                             bib             => $branch_details->{'branchname'}, # maybe 'bib' is a typo for 'lib<rary>'?
505                                             'items.content' => $titles
506                                            }
507                     }
508                 );
509                 
510                 if ( $exceededPrintNoticesMaxLines ) {
511                   $letter->{'content'} .= "List too long for form; please check your account online for a complete list of your overdue items.";
512                 }
513
514                 my @misses = grep { /./ } map { /^([^>]*)[>]+/; ( $1 || '' ); } split /\</, $letter->{'content'};
515                 if (@misses) {
516                     $verbose and warn "The following terms were not matched and replaced: \n\t" . join "\n\t", @misses;
517                 }
518                 $letter->{'content'} =~ s/\<[^<>]*?\>//g;    # Now that we've warned about them, remove them.
519                 $letter->{'content'} =~ s/\<[^<>]*?\>//g;    # 2nd pass for the double nesting.
520     
521                 if ($nomail) {
522     
523                     push @output_chunks,
524                       prepare_letter_for_printing(
525                         {   letter         => $letter,
526                             borrowernumber => $borrowernumber,
527                             firstname      => $firstname,
528                             lastname       => $lastname,
529                             address1       => $address1,
530                             address2       => $address2,
531                             city           => $city,
532                             postcode       => $postcode,
533                             email          => $email,
534                             itemcount      => $itemcount,
535                             titles         => $titles,
536                             outputformat   => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : '',
537                         }
538                       );
539                 } else {
540                     if ($email) {
541                         C4::Letters::EnqueueLetter(
542                             {   letter                 => $letter,
543                                 borrowernumber         => $borrowernumber,
544                                 message_transport_type => 'email',
545                                 from_address           => $admin_email_address,
546                             }
547                         );
548                     } else {
549     
550                         # If we don't have an email address for this patron, send it to the admin to deal with.
551                         push @output_chunks,
552                           prepare_letter_for_printing(
553                             {   letter         => $letter,
554                                 borrowernumber => $borrowernumber,
555                                 firstname      => $firstname,
556                                 lastname       => $lastname,
557                                 address1       => $address1,
558                                 address2       => $address2,
559                                 city           => $city,
560                                 postcode       => $postcode,
561                                 email          => $email,
562                                 itemcount      => $itemcount,
563                                 titles         => $titles,
564                                 outputformat   => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : '',
565                             }
566                           );
567                     }
568                 }
569             }
570             $sth->finish;
571         }
572     }
573
574     if (@output_chunks) {
575         if ( defined $csvfilename ) {
576             print $csv_fh @output_chunks;        
577         }
578         elsif ( defined $htmlfilename ) {
579             print $html_fh @output_chunks;        
580         }
581         elsif ($nomail){
582                 local $, = "\f";    # pagebreak
583                 print @output_chunks;
584         }
585         my $attachment = {
586             filename => defined $csvfilename ? 'attachment.csv' : 'attachment.txt',
587             type => 'text/plain',
588             content => join( "\n", @output_chunks )
589         };
590
591         my $letter = {
592             title   => 'Overdue Notices',
593             content => 'These messages were not sent directly to the patrons.',
594         };
595         C4::Letters::EnqueueLetter(
596             {   letter                 => $letter,
597                 borrowernumber         => undef,
598                 message_transport_type => 'email',
599                 attachments            => [$attachment],
600                 to_address             => $admin_email_address,
601             }
602         );
603     }
604
605 }
606 if ($csvfilename) {
607     # note that we're not testing on $csv_fh to prevent closing
608     # STDOUT.
609     close $csv_fh;
610 }
611
612 if ( defined $htmlfilename ) {
613   print $html_fh "</body>\n";
614   print $html_fh "</html>\n";
615   close $html_fh;
616 }
617
618 =head1 INTERNAL METHODS
619
620 These methods are internal to the operation of overdue_notices.pl.
621
622 =head2 parse_letter
623
624 parses the letter template, replacing the placeholders with data
625 specific to this patron, biblio, or item
626
627 named parameters:
628   letter - required hashref
629   borrowernumber - required integer
630   substitute - optional hashref of other key/value pairs that should
631     be substituted in the letter content
632
633 returns the C<letter> hashref, with the content updated to reflect the
634 substituted keys and values.
635
636
637 =cut
638
639 sub parse_letter { # FIXME: this code should probably be moved to C4::Letters:parseletter
640     my $params = shift;
641     foreach my $required (qw( letter borrowernumber )) {
642         return unless exists $params->{$required};
643     }
644
645
646     if ( $params->{'substitute'} ) {
647         while ( my ( $key, $replacedby ) = each %{ $params->{'substitute'} } ) {
648             my $replacefield = "<<$key>>";
649             $params->{'letter'}->{title}   =~ s/$replacefield/$replacedby/g;
650             $params->{'letter'}->{content} =~ s/$replacefield/$replacedby/g;
651         }
652     }
653
654     $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'borrowers', $params->{'borrowernumber'} );
655
656     if ( $params->{'branchcode'} ) {
657         $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'branches', $params->{'branchcode'} );
658     }
659
660     if ( $params->{'items'} ) {
661         my $item_format = '';
662         PROCESS_ITEMS:
663         while (scalar(@{$params->{'items'}}) > 0) {
664             my $item = shift @{$params->{'items'}};
665             my $fine = GetFine($item->{'itemnumber'}, $params->{'borrowernumber'});
666             if (!$item_format) {
667                 $params->{'letter'}->{'content'} =~ m/(<item>.*<\/item>)/;
668                 $item_format = $1;
669             }
670             if ($params->{'letter'}->{'content'} =~ m/<fine>(.*)<\/fine>/) { # process any fine tags...
671                 my $formatted_fine = currency_format("$1", "$fine", FMT_SYMBOL);
672                 $params->{'letter'}->{'content'} =~ s/<fine>.*<\/fine>/$formatted_fine/;
673             }
674             $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'biblio',      $item->{'biblionumber'} );
675             $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'biblioitems', $item->{'biblionumber'} );
676             $params->{'letter'} = C4::Letters::parseletter( $params->{'letter'}, 'items', $item->{'itemnumber'} );
677             $params->{'letter'}->{'content'} =~ s/(<item>.*<\/item>)/$1\n$item_format/ if scalar(@{$params->{'items'}} > 0);
678
679         }
680     }
681     $params->{'letter'}->{'content'} =~ s/<\/{0,1}?item>//g; # strip all remaining item tags...
682     return $params->{'letter'};
683 }
684
685 =head2 prepare_letter_for_printing
686
687 returns a string of text appropriate for printing in the event that an
688 overdue notice will not be sent to the patron's email
689 address. Depending on the desired output format, this may be a CSV
690 string, or a human-readable representation of the notice.
691
692 required parameters:
693   letter
694   borrowernumber
695
696 optional parameters:
697   outputformat
698
699 =cut
700
701 sub prepare_letter_for_printing {
702     my $params = shift;
703
704     return unless ref $params eq 'HASH';
705
706     foreach my $required_parameter (qw( letter borrowernumber )) {
707         return unless defined $params->{$required_parameter};
708     }
709
710     my $return;
711     if ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'csv' ) {
712         if ($csv->combine(
713                 $params->{'firstname'}, $params->{'lastname'}, $params->{'address1'},  $params->{'address2'}, $params->{'postcode'},
714                 $params->{'city'},      $params->{'email'},    $params->{'itemcount'}, $params->{'titles'}
715             )
716           ) {
717             return $csv->string, "\n";
718         } else {
719             $verbose and warn 'combine failed on argument: ' . $csv->error_input;
720         }
721     } elsif ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'html' ) {
722       $return = "<pre>\n";
723       $return .= "$params->{'letter'}->{'content'}\n";
724       $return .= "\n</pre>\n";
725     } else {
726         $return .= "$params->{'letter'}->{'content'}\n";
727
728         # $return .= Data::Dumper->Dump( [ $params->{'borrowernumber'}, $params->{'letter'} ], [qw( borrowernumber letter )] );
729     }
730     return $return;
731 }
732