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
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use Getopt::Long qw( GetOptions );
24 use Pod::Usage qw( pod2usage );
27 use DateTime::Duration;
29 use Koha::Script -cron;
32 use C4::Overdues qw( GetOverdueMessageTransportTypes parse_overdues_letter );
33 use C4::Log qw( cronlogaction );
34 use Koha::Patron::Debarments qw( AddUniqueDebarment );
35 use Koha::DateUtils qw( dt_from_string output_pref );
38 use Koha::Acquisition::Currencies;
43 overdue_notices.pl - prepare messages to be sent to patrons for overdue items
48 [ -n ][ --library <branchcode> ][ --library <branchcode> ... ]
49 [ --max <number of days> ][ --csv [<filename>] ][ --itemscontent <field list> ]
50 [ --email <email_type> ... ]
53 --help Brief help message.
54 --man Full documentation.
55 --verbose | -v Verbose mode. Can be repeated for increased output
56 --nomail | -n No email will be sent.
57 --max <days> Maximum days overdue to deal with.
58 --library <branchcode> Only deal with overdues from this library.
59 (repeatable : several libraries can be given)
60 --csv <filename> Populate CSV file.
61 --html <directory> Output html to a file in the given directory.
62 --text <directory> Output plain text to a file in the given directory.
63 --itemscontent <list of fields> Item information in templates.
64 --borcat <categorycode> Category code that must be included.
65 --borcatout <categorycode> Category code that must be excluded.
66 --triggered | -t Only include triggered overdues.
67 --test Run in test mode. No changes will be made on the DB.
68 --list-all List all overdues.
69 --date <yyyy-mm-dd> Emulate overdues run for this date.
70 --email <email_type> Type of email that will be used.
71 Can be 'email', 'emailpro' or 'B_email'. Repeatable.
72 --frombranch Organize and send overdue notices by home library (item-homebranch) or checkout library (item-issuebranch) or patron home library (patron-homebranch).
73 This option is only used, if the OverdueNoticeFrom system preference is set to 'command-line option'.
74 Defaults to item-issuebranch.
82 Print a brief help message and exits.
86 Prints the manual page and exits.
88 =item B<-v> | B<--verbose>
90 Verbose. Without this flag set, only fatal errors are reported.
91 A single 'v' will report info on branches, letter codes, and patrons.
92 A second 'v' will report The SQL code used to search for triggered patrons.
94 =item B<-n> | B<--nomail>
96 Do not send any email. Overdue notices that would have been sent to
97 the patrons or to the admin are printed to standard out. CSV data (if
98 the --csv flag is set) is written to standard out or to any csv
103 Items older than max days are assumed to be handled somewhere else,
104 probably the F<longoverdues.pl> script. They are therefore ignored by
105 this program. No notices are sent for them, and they are not added to
106 any CSV files. Defaults to 90 to match F<longoverdues.pl>.
110 select overdues for one specific library. Use the value in the
111 branches.branchcode table. This option can be repeated in order
112 to select overdues for a group of libraries.
116 Produces CSV data. if -n (no mail) flag is set, then this CSV data is
117 sent to standard out or to a filename if provided. Otherwise, only
118 overdues that could not be emailed are sent in CSV format to the admin.
122 Produces html data. If patron does not have an email address or
123 -n (no mail) flag is set, an HTML file is generated in the specified
124 directory. This can be downloaded or further processed by library staff.
125 The file will be called notices-YYYY-MM-DD.html and placed in the directory
130 Produces plain text data. If patron does not have an email address or
131 -n (no mail) flag is set, a text file is generated in the specified
132 directory. This can be downloaded or further processed by library staff.
133 The file will be called notices-YYYY-MM-DD.txt and placed in the directory
136 =item B<--itemscontent>
138 comma separated list of fields that get substituted into templates in
139 places of the E<lt>E<lt>items.contentE<gt>E<gt> placeholder. This
140 defaults to due date,title,barcode,author
142 Other possible values come from fields in the biblios, items and
147 Repeatable field, that permits to select only some patron categories.
151 Repeatable field, that permits to exclude some patron categories.
153 =item B<-t> | B<--triggered>
155 This option causes a notice to be generated if and only if
156 an item is overdue by the number of days defined in a notice trigger.
158 By default, a notice is sent each time the script runs, which is suitable for
159 less frequent run cron script, but requires syncing notice triggers with
160 the cron schedule to ensure proper behavior.
161 Add the --triggered option for daily cron, at the risk of no notice
162 being generated if the cron fails to run on time.
166 This option makes the script run in test mode.
168 In test mode, the script won't make any changes on the DB. This is useful
169 for debugging configuration.
173 Default items.content lists only those items that fall in the
174 range of the currently processing notice.
175 Choose --list-all to include all overdue items in the list (limited by B<--max> setting).
179 use it in order to send overdues on a specific date and not Now. Format: YYYY-MM-DD.
183 Allows to specify which type of email will be used. Can be email, emailpro or B_email. Repeatable.
185 =item B<--frombranch>
187 Organize overdue notices either by checkout library (item-issuebranch) or item home library (item-homebranch) or patron home library (patron-homebranch).
188 This option is only used, if the OverdueNoticeFrom system preference is set to use 'command-line option'.
189 Defaults to checkout library (item-issuebranch).
195 This script is designed to alert patrons and administrators of overdue
200 This script pays attention to the overdue notice configuration
201 performed in the "Overdue notice/status triggers" section of the
202 "Tools" area of the staff interface to Koha. There, you can choose
203 which letter templates are sent out after a configurable number of
204 days to patrons of each library. More information about the use of this
205 section of Koha is available in the Koha manual.
207 The templates used to craft the emails are defined in the "Tools:
208 Notices" section of the staff interface to Koha.
210 =head2 Outgoing emails
212 Typically, messages are prepared for each patron with overdue
213 items. Messages for whom there is no email address on file are
214 collected and sent as attachments in a single email to each library
215 administrator, or if that is not set, then to the email address in the
216 C<KohaAdminEmailAddress> system preference.
218 These emails are staged in the outgoing message queue, as are messages
219 produced by other features of Koha. This message queue must be
220 processed regularly by the
221 F<misc/cronjobs/process_message_queue.pl> program.
223 In the event that the C<-n> flag is passed to this program, no emails
224 are sent. Instead, messages are sent on standard output from this
225 program. They may be redirected to a file if desired.
229 Templates can contain variables enclosed in double angle brackets like
230 E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
231 specific to the overdue items or relevant patron. Available variables
236 =item E<lt>E<lt>bibE<gt>E<gt>
238 the name of the library
240 =item E<lt>E<lt>items.contentE<gt>E<gt>
242 one line for each item, each line containing a tab separated list of
243 title, author, barcode, issuedate
245 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
247 any field from the borrowers table
249 =item E<lt>E<lt>branches.*E<gt>E<gt>
251 any field from the branches table
257 The C<-csv> command line option lets you specify a file to which
258 overdues data should be output in CSV format.
260 With the C<-n> flag set, data about all overdues is written to the
261 file. Without that flag, only information about overdues that were
262 unable to be sent directly to the patrons will be written. In other
263 words, this CSV file replaces the data that is typically sent to the
264 administrator email address.
266 =head1 USAGE EXAMPLES
268 C<overdue_notices.pl> - In this most basic usage, with no command line
269 arguments, all libraries are processed individually, and notices are
270 prepared for all patrons with overdue items for whom we have email
271 addresses. Messages for those patrons for whom we have no email
272 address are sent in a single attachment to the library administrator's
273 email address, or to the address in the KohaAdminEmailAddress system
276 C<overdue_notices.pl -n --csv /tmp/overdues.csv> - sends no email and
277 populates F</tmp/overdues.csv> with information about all overdue
280 C<overdue_notices.pl --library MAIN max 14> - prepare notices of
281 overdues in the last 2 weeks for the MAIN library.
285 The F<misc/cronjobs/advance_notices.pl> program allows you to send
286 messages to patrons in advance of their items becoming due, or to
287 alert them of items that have just become due.
291 # These variables are set by command line options.
292 # They are initially set to default values.
293 my $dbh = C4::Context->dbh();
300 my $frombranch = 'item-issuebranch';
301 my @branchcodes; # Branch(es) passed as parameter
302 my @emails_to_use; # Emails to use for messaging
303 my @emails; # Emails given in command-line parameters
309 my $itemscontent = join( ',', qw( date_due title barcode author itemnumber ) );
312 my ( $date_input, $today );
314 my $command_line_options = join(" ",@ARGV);
319 'v|verbose+' => \$verbose,
320 'n|nomail' => \$nomail,
322 'library=s' => \@branchcodes,
323 'csv:s' => \$csvfilename, # this optional argument gets '' if not supplied.
324 'html:s' => \$htmlfilename, # this optional argument gets '' if not supplied.
325 'text:s' => \$text_filename, # this optional argument gets '' if not supplied.
326 'itemscontent=s' => \$itemscontent,
327 'list-all' => \$listall,
328 't|triggered' => \$triggered,
329 'test' => \$test_mode,
330 'date=s' => \$date_input,
331 'borcat=s' => \@myborcat,
332 'borcatout=s' => \@myborcatout,
333 'email=s' => \@emails,
334 'frombranch=s' => \$frombranch,
336 pod2usage(1) if $help;
337 pod2usage( -verbose => 2 ) if $man;
338 cronlogaction({ info => $command_line_options });
340 if ( defined $csvfilename && $csvfilename =~ /^-/ ) {
341 warn qq(using "$csvfilename" as filename, that seems odd);
344 die "--frombranch takes item-homebranch or item-issuebranch or patron-homebranch only"
345 unless ( $frombranch eq 'item-issuebranch'
346 || $frombranch eq 'item-homebranch'
347 || $frombranch eq 'patron-homebranch' );
349 C4::Context->preference('OverdueNoticeFrom') ne 'cron' ? C4::Context->preference('OverdueNoticeFrom') : $frombranch;
350 my $owning_library = ( $frombranch eq 'item-homebranch' ) ? 1 : 0;
351 my $patron_homelibrary = ( $frombranch eq 'patron-homebranch' ) ? 1 : 0;
353 my @overduebranches = C4::Overdues::GetBranchcodesWithOverdueRules(); # Branches with overdue rules
354 my @branches; # Branches passed as parameter with overdue rules
355 my $branchcount = scalar(@overduebranches);
357 my $overduebranch_word = scalar @overduebranches > 1 ? 'branches' : 'branch';
358 my $branchcodes_word = scalar @branchcodes > 1 ? 'branches' : 'branch';
360 my $PrintNoticesMaxLines = C4::Context->preference('PrintNoticesMaxLines');
363 $verbose and warn "Found $branchcount $overduebranch_word with first message enabled: " . join( ', ', map { "'$_'" } @overduebranches ), "\n";
365 die 'No branches with active overduerules';
369 $verbose and warn "$branchcodes_word @branchcodes passed on parameter\n";
371 # Getting libraries which have overdue rules
372 my %seen = map { $_ => 1 } @branchcodes;
373 @branches = grep { $seen{$_} } @overduebranches;
378 my $branch_word = scalar @branches > 1 ? 'branches' : 'branch';
379 $verbose and warn "$branch_word @branches have overdue rules\n";
383 $verbose and warn "No active overduerules for $branchcodes_word '@branchcodes'\n";
384 ( scalar grep { '' eq $_ } @branches )
385 or die "No active overduerules for DEFAULT either!";
386 $verbose and warn "Falling back on default rules for @branchcodes\n";
394 $date_to_run = dt_from_string( $date_input, 'iso' );
396 die "$date_input is not a valid date, aborting! Use a date in format YYYY-MM-DD."
397 if $@ or not $date_to_run;
399 # It's certainly useless to escape $date_input
400 # dt_from_string should not return something if $date_input is not correctly set.
401 $date = $dbh->quote( $date_input );
405 $date_to_run = dt_from_string();
408 # these are the fields that will be substituted into <<item.content>>
409 my @item_content_fields = split( /,/, $itemscontent );
411 binmode( STDOUT, ':encoding(UTF-8)' );
414 our $csv; # the Text::CSV_XS object
415 our $csv_fh; # the filehandle to the CSV file.
416 if ( defined $csvfilename ) {
417 my $sep_char = C4::Context->csv_delimiter;
418 $csv = Text::CSV_XS->new( { binary => 1 , sep_char => $sep_char } );
419 if ( $csvfilename eq '' ) {
422 open $csv_fh, ">", $csvfilename or die "unable to open $csvfilename: $!";
424 if ( $csv->combine(qw(name surname address1 address2 zipcode city country email phone cardnumber itemcount itemsinfo branchname letternumber)) ) {
425 print $csv_fh $csv->string, "\n";
427 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
431 @branches = @overduebranches unless @branches;
433 if ( defined $htmlfilename ) {
434 if ( $htmlfilename eq '' ) {
437 my $today = dt_from_string();
438 open $fh, ">:encoding(UTF-8)",File::Spec->catdir ($htmlfilename,"notices-".$today->ymd().".html");
441 print $fh _get_html_start();
443 elsif ( defined $text_filename ) {
444 if ( $text_filename eq '' ) {
447 my $today = dt_from_string();
448 open $fh, ">:encoding(UTF-8)",File::Spec->catdir ($text_filename,"notices-".$today->ymd().".txt");
453 my %seen = map { $_ => 1 } @branches;
454 foreach my $branchcode (@branches) {
456 if ( C4::Context->preference('OverdueNoticeCalendar') ) {
457 $calendar = Koha::Calendar->new( branchcode => $branchcode );
458 if ( $calendar->is_holiday($date_to_run) ) {
463 my $library = Koha::Libraries->find($branchcode);
464 my $admin_email_address = $library->from_email_address;
465 my $branch_email_address = C4::Context->preference('AddressForFailedOverdueNotices')
466 || $library->inbound_email_address;
467 my @output_chunks; # may be sent to mail or stdout or csv file.
469 $verbose and print "======================================\n";
470 $verbose and warn sprintf "branchcode : '%s' using %s\n", $branchcode, $branch_email_address;
472 my $sql2 = <<"END_SQL";
473 SELECT biblio.*, items.*, issues.*, biblioitems.itemtype, branchname
474 FROM issues,items,biblio, biblioitems, branches b
475 WHERE items.itemnumber=issues.itemnumber
476 AND biblio.biblionumber = items.biblionumber
477 AND b.branchcode = items.homebranch
478 AND biblio.biblionumber = biblioitems.biblionumber
479 AND issues.borrowernumber = ?
480 AND items.itemlost = 0
481 AND TO_DAYS($date)-TO_DAYS(issues.date_due) >= 0
484 if ($owning_library) {
485 $sql2 .= ' AND items.homebranch = ? ' unless ($patron_homelibrary);
487 $sql2 .= ' AND issues.branchcode = ? ' unless ($patron_homelibrary);
489 my $sth2 = $dbh->prepare($sql2);
491 my $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = ? ";
492 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
493 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
495 my $rqoverduerules = $dbh->prepare($query);
496 $rqoverduerules->execute($branchcode, @myborcat, @myborcatout);
498 # We get default rules if there is no rule for this branch
499 if($rqoverduerules->rows == 0){
500 $query = "SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = '' ";
501 $query .= " AND categorycode IN (".join( ',' , ('?') x @myborcat ).") " if (@myborcat);
502 $query .= " AND categorycode NOT IN (".join( ',' , ('?') x @myborcatout ).") " if (@myborcatout);
504 $rqoverduerules = $dbh->prepare($query);
505 $rqoverduerules->execute(@myborcat, @myborcatout);
508 # my $outfile = 'overdues_' . ( $mybranch || $branchcode || 'default' );
509 while ( my $overdue_rules = $rqoverduerules->fetchrow_hashref ) {
510 PERIOD: foreach my $i ( 1 .. 3 ) {
512 $verbose and warn "branch '$branchcode', categorycode = $overdue_rules->{categorycode} pass $i\n";
514 my $mindays = $overdue_rules->{"delay$i"}; # the notice will be sent after mindays days (grace period)
516 $overdue_rules->{ "delay" . ( $i + 1 ) }
517 ? $overdue_rules->{ "delay" . ( $i + 1 ) } - 1
519 ); # issues being more than maxdays late are managed somewhere else. (borrower probably suspended)
521 next unless defined $mindays;
523 if ( !$overdue_rules->{"letter$i"} ) {
524 $verbose and warn sprintf "No letter code found for pass %s\n", $i;
527 $verbose and warn sprintf "Using letter code '%s' for pass %s\n", $overdue_rules->{"letter$i"}, $i;
529 # $letter->{'content'} is the text of the mail that is sent.
530 # this text contains fields that are replaced by their value. Those fields must be written between brackets
531 # The following fields are available :
532 # 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).
533 # <date> <itemcount> <firstname> <lastname> <address1> <address2> <address3> <city> <postcode> <country>
535 my $borrower_sql = <<"END_SQL";
536 SELECT issues.borrowernumber, firstname, surname, address, address2, city, zipcode, country, email, emailpro, B_email, smsalertnumber, phone, cardnumber, date_due
537 FROM issues,borrowers,categories,items
538 WHERE issues.borrowernumber=borrowers.borrowernumber
539 AND borrowers.categorycode=categories.categorycode
540 AND issues.itemnumber = items.itemnumber
541 AND items.itemlost = 0
542 AND TO_DAYS($date)-TO_DAYS(issues.date_due) >= 0
544 my @borrower_parameters;
546 if($owning_library) {
547 $borrower_sql .= ' AND items.homebranch=? ';
549 $borrower_sql .= ' AND issues.branchcode=? ';
551 push @borrower_parameters, $branchcode;
553 if ( $overdue_rules->{categorycode} ) {
554 $borrower_sql .= ' AND borrowers.categorycode=? ';
555 push @borrower_parameters, $overdue_rules->{categorycode};
557 $borrower_sql .= ' AND categories.overduenoticerequired=1 ORDER BY issues.borrowernumber';
559 # $sth gets borrower info iff at least one overdue item has triggered the overdue action.
560 my $sth = $dbh->prepare($borrower_sql);
561 $sth->execute(@borrower_parameters);
564 warn sprintf "--------Borrower SQL------\n";
565 warn $borrower_sql . "\n $branchcode | " . $overdue_rules->{'categorycode'} . "\n ($mindays, $maxdays, ". $date_to_run->datetime() .")\n";
566 warn sprintf "--------------------------\n";
568 $verbose and warn sprintf "Found %s borrowers with overdues\n", $sth->rows;
570 while ( my $data = $sth->fetchrow_hashref ) {
572 # check the borrower has at least one item that matches
574 if ( C4::Context->preference('OverdueNoticeCalendar') )
577 $calendar->days_between( dt_from_string($data->{date_due}),
582 $date_to_run->delta_days( dt_from_string($data->{date_due}) );
584 $days_between = $days_between->in_units('days');
586 if ( $mindays != $days_between ) {
591 unless ( $days_between >= $mindays
592 && $days_between <= $maxdays )
597 if (defined $borrowernumber && $borrowernumber eq $data->{'borrowernumber'}){
598 # we have already dealt with this borrower
599 $verbose and warn "already dealt with this borrower $borrowernumber";
602 $borrowernumber = $data->{'borrowernumber'};
603 next if ( $patron_homelibrary && $already_queued{"$borrowernumber$i"} );
604 my $borr = sprintf( "%s%s%s (%s)",
605 $data->{'surname'} || '',
606 $data->{'firstname'} && $data->{'surname'} ? ', ' : '',
607 $data->{'firstname'} || '',
609 $verbose and warn "borrower $borr has items triggering level $i.\n";
611 my $patron = Koha::Patrons->find( $borrowernumber );
612 if ($patron_homelibrary) {
613 $branchcode = $patron->branchcode;
614 $library = Koha::Libraries->find($branchcode);
615 $admin_email_address = $library->from_email_address;
616 $branch_email_address = C4::Context->preference('AddressForFailedOverdueNotices')
617 || $library->inbound_email_address;
620 my $notice_email = $patron->notice_email_address;
624 push @emails_to_use, $data->{$_} if ( $data->{$_} );
628 push @emails_to_use, $notice_email if ($notice_email);
632 my $letter = Koha::Notice::Templates->find_effective_template(
634 module => 'circulation',
635 code => $overdue_rules->{"letter$i"},
636 branchcode => $branchcode,
637 lang => $patron->lang
642 $verbose and warn qq|Message '$overdue_rules->{"letter$i"}' content not found|;
644 # might as well skip while PERIOD, no other borrowers are going to work.
645 # FIXME : Does this mean a letter must be defined in order to trigger a debar ?
649 if ( $overdue_rules->{"debarred$i"} ) {
651 #action taken is debarring
654 borrowernumber => $borrowernumber,
656 comment => "OVERDUES_PROCESS " . output_pref( dt_from_string() ),
659 $verbose and warn "debarring $borr\n";
661 my @params = $patron_homelibrary ? ($borrowernumber) : ( $borrowernumber, $branchcode );
663 $sth2->execute(@params);
669 my $exceededPrintNoticesMaxLines = 0;
670 while ( my $item_info = $sth2->fetchrow_hashref() ) {
671 if ( C4::Context->preference('OverdueNoticeCalendar') ) {
673 $calendar->days_between(
674 dt_from_string( $item_info->{date_due} ), $date_to_run );
678 $date_to_run->delta_days(
679 dt_from_string( $item_info->{date_due} ) );
681 $days_between = $days_between->in_units('days');
683 unless ($days_between >= 1 and $days_between <= $MAX){
689 if ( $mindays != $days_between ) {
694 unless ( $days_between >= $mindays
695 && $days_between <= $maxdays )
702 if ( ( scalar(@emails_to_use) == 0 || $nomail ) && $PrintNoticesMaxLines && $j >= $PrintNoticesMaxLines ) {
703 $exceededPrintNoticesMaxLines = 1;
706 next if $patron_homelibrary and !grep { $seen{ $item_info->{branchcode} } } @branches;
709 $titles .= C4::Letters::get_item_content( { item => $item_info, item_content_fields => \@item_content_fields, dateonly => 1 } );
711 push @items, $item_info;
715 my @message_transport_types = @{ GetOverdueMessageTransportTypes( $branchcode, $overdue_rules->{categorycode}, $i) };
716 @message_transport_types = @{ GetOverdueMessageTransportTypes( q{}, $overdue_rules->{categorycode}, $i) }
717 unless @message_transport_types;
720 my $print_sent = 0; # A print notice is not yet sent for this patron
721 for my $mtt ( @message_transport_types ) {
722 next if $mtt eq 'itiva';
723 my $effective_mtt = $mtt;
724 if ( ($mtt eq 'email' and not scalar @emails_to_use) or ($mtt eq 'sms' and not $data->{smsalertnumber}) ) {
725 # email or sms is requested but not exist, do a print.
726 $effective_mtt = 'print';
728 splice @items, $PrintNoticesMaxLines if $effective_mtt eq 'print' && $PrintNoticesMaxLines && scalar @items > $PrintNoticesMaxLines;
729 #catch the case where we are sending a print to someone with an email
731 my $letter_exists = Koha::Notice::Templates->find_effective_template(
733 module => 'circulation',
734 code => $overdue_rules->{"letter$i"},
735 message_transport_type => $effective_mtt,
736 branchcode => $branchcode,
737 lang => $patron->lang
741 my $letter = parse_overdues_letter(
742 { letter_code => $overdue_rules->{"letter$i"},
743 borrowernumber => $borrowernumber,
744 branchcode => $branchcode,
746 substitute => { # this appears to be a hack to overcome incomplete features in this code.
747 bib => $library->branchname, # maybe 'bib' is a typo for 'lib<rary>'?
748 'items.content' => $titles,
749 'count' => $itemcount,
751 # If there is no template defined for the requested letter
752 # Fallback on the original type
753 message_transport_type => $letter_exists ? $effective_mtt : $mtt,
756 unless ($letter && $letter->{content}) {
757 $verbose and warn qq|Message '$overdue_rules->{"letter$i"}' content not found|;
758 # this transport doesn't have a configured notice, so try another
762 if ( $exceededPrintNoticesMaxLines ) {
763 $letter->{'content'} .= "List too long for form; please check your account online for a complete list of your overdue items.";
766 my @misses = grep { /./ } map { /^([^>]*)[>]+/; ( $1 || '' ); } split /\</, $letter->{'content'};
768 $verbose and warn "The following terms were not matched and replaced: \n\t" . join "\n\t", @misses;
773 prepare_letter_for_printing(
775 borrowernumber => $borrowernumber,
776 firstname => $data->{'firstname'},
777 lastname => $data->{'surname'},
778 address1 => $data->{'address'},
779 address2 => $data->{'address2'},
780 city => $data->{'city'},
781 phone => $data->{'phone'},
782 cardnumber => $data->{'cardnumber'},
783 branchname => $library->branchname,
785 postcode => $data->{'zipcode'},
786 country => $data->{'country'},
787 email => $notice_email,
788 itemcount => $itemcount,
790 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : defined $text_filename ? 'text' : '',
794 if ( ($mtt eq 'email' and not scalar @emails_to_use) or ($mtt eq 'sms' and not $data->{smsalertnumber}) ) {
796 prepare_letter_for_printing(
798 borrowernumber => $borrowernumber,
799 firstname => $data->{'firstname'},
800 lastname => $data->{'surname'},
801 address1 => $data->{'address'},
802 address2 => $data->{'address2'},
803 city => $data->{'city'},
804 postcode => $data->{'zipcode'},
805 country => $data->{'country'},
806 email => $notice_email,
807 itemcount => $itemcount,
809 outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : defined $text_filename ? 'text' : '',
813 unless ( $effective_mtt eq 'print' and $print_sent == 1 ) {
814 # Just sent a print if not already done.
815 C4::Letters::EnqueueLetter(
817 borrowernumber => $borrowernumber,
818 message_transport_type => $effective_mtt,
819 from_address => $admin_email_address,
820 to_address => join(',', @emails_to_use),
821 reply_address => $library->inbound_email_address,
824 # A print notice should be sent only once per overdue level.
825 # 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.
826 $print_sent = 1 if $effective_mtt eq 'print';
830 $already_queued{"$borrowernumber$i"} = 1;
836 if (@output_chunks) {
837 if ( defined $csvfilename ) {
838 print $csv_fh @output_chunks;
840 elsif ( defined $htmlfilename ) {
841 print $fh @output_chunks;
843 elsif ( defined $text_filename ) {
844 print $fh @output_chunks;
847 local $, = "\f"; # pagebreak
848 print @output_chunks;
850 # Generate the content of the csv with headers
852 if ( defined $csvfilename ) {
853 my $delimiter = C4::Context->csv_delimiter;
854 $content = join($delimiter, qw(title name surname address1 address2 zipcode city country email itemcount itemsinfo due_date issue_date)) . "\n";
855 $content .= join( "\n", @output_chunks );
856 } elsif ( defined $htmlfilename ) {
857 $content = _get_html_start();
858 $content .= join( "\n", @output_chunks );
859 $content .= _get_html_end();
861 $content = join( "\n", @output_chunks );
864 if ( C4::Context->preference('EmailOverduesNoEmail') ) {
866 filename => defined $csvfilename ? 'attachment.csv' : defined $htmlfilename ? 'attachment.html' : 'attachment.txt',
867 type => defined $htmlfilename ? 'text/html' : 'text/plain',
872 title => 'Overdue Notices',
873 content => 'These messages were not sent directly to the patrons.',
876 C4::Letters::EnqueueLetter(
878 borrowernumber => undef,
879 message_transport_type => 'email',
880 attachments => [$attachment],
881 to_address => $branch_email_address,
889 # note that we're not testing on $csv_fh to prevent closing
894 if ( defined $htmlfilename ) {
895 print $fh _get_html_end();
897 } elsif ( defined $text_filename ) {
901 =head1 INTERNAL METHODS
903 These methods are internal to the operation of overdue_notices.pl.
905 =head2 prepare_letter_for_printing
907 returns a string of text appropriate for printing in the event that an
908 overdue notice will not be sent to the patron's email
909 address. Depending on the desired output format, this may be a CSV
910 string, or a human-readable representation of the notice.
921 sub prepare_letter_for_printing {
924 return unless ref $params eq 'HASH';
926 foreach my $required_parameter (qw( letter borrowernumber )) {
927 return unless defined $params->{$required_parameter};
931 chomp $params->{titles};
932 if ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'csv' ) {
934 $params->{'firstname'}, $params->{'lastname'}, $params->{'address1'}, $params->{'address2'}, $params->{'postcode'},
935 $params->{'city'}, $params->{'country'}, $params->{'email'}, $params->{'phone'}, $params->{'cardnumber'},
936 $params->{'itemcount'}, $params->{'titles'}, $params->{'branchname'}, $params->{'letternumber'}
939 return $csv->string, "\n";
941 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
943 } elsif ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'html' ) {
945 $return .= "$params->{'letter'}->{'content'}\n";
946 $return .= "\n</pre>\n";
948 $return .= "$params->{'letter'}->{'content'}\n";
950 # $return .= Data::Dumper->Dump( [ $params->{'borrowernumber'}, $params->{'letter'} ], [qw( borrowernumber letter )] );
955 =head2 _get_html_start
957 Return the start of a HTML document, including html, head and the start body
958 tags. This should be usable both in the HTML file written to disc, and in the
959 attachment.html sent as email.
963 sub _get_html_start {
967 <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />
968 <style type='text/css'>
969 pre {page-break-after: always;}
970 pre {white-space: pre-wrap;}
971 pre {white-space: -moz-pre-wrap;}
972 pre {white-space: -o-pre-wrap;}
973 pre {word-wrap: break-work;}
982 Return the end of an HTML document, namely the closing body and html tags.
993 cronlogaction({ action => 'End', info => "COMPLETED" });