misc/cronjobs/overdue_notices.pl

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