From 5827499d1c901140d6b31c88ad0b0423e7711fb2 Mon Sep 17 00:00:00 2001 From: Jonathan Druart Date: Fri, 6 Sep 2013 11:23:44 +0200 Subject: [PATCH] Bug 10832: Multi transport types for overdue notices Test plan: - define some complex overdue rules (tools/overduerules.pl). For example: First overdue from 2 to 5 days by sms and email with letter code L1 Second overdue from 5 to 15 days by email with letter code L2 Third overdue from 15 days by print with letter code L3 - defined a message for each transport type selected (tools/letters.pl). - select 3 patrons (P1, P2, P3) and 3 barcodes (B1, B2, B3). * checkout B1 to P1 with a due date = NOW + 3 days * checkout B2 to P2 with a due date = NOW + 10 days * checkout B3 to P3 with a due date = NOW + 20 days - into the mysql cli, note the value of unsent message: select count(*) from message_queue where status != "send"; - launch the cronjob: perl misc/cronjobs/overdue_notices.pl - retry the previous sql query, you should have X + 4 unsent messages (depending of current checkouts in your DB!). - view all unsent message: select borrowernumber, letter_code, message_transport_type, content from message_queue where status != "send"; You should see: 2 messages for P1, 1 for sms, 1 for email and the letter code L1 1 message for P2, 1 for email and the letter code L2 1 message for P3, 1 for print and the letter code L3 - Specific case: If a user don't have a smsalertnumber and a sms is required or if a user don't have an email defined and an email is required, a print notice is generated. A print notice is generated only 1 time per borrower and per level. --- misc/cronjobs/overdue_notices.pl | 126 ++++++++++++++++++++++---------------- 1 file changed, 73 insertions(+), 53 deletions(-) diff --git a/misc/cronjobs/overdue_notices.pl b/misc/cronjobs/overdue_notices.pl index 7745047..8668b1a 100755 --- a/misc/cronjobs/overdue_notices.pl +++ b/misc/cronjobs/overdue_notices.pl @@ -39,7 +39,7 @@ use C4::Context; use C4::Dates qw/format_date/; use C4::Debug; use C4::Letters; -use C4::Overdues qw(GetFine); +use C4::Overdues qw(GetFine GetOverdueMessageTransportTypes); use C4::Budgets qw(GetCurrency); use Koha::Borrower::Debarments qw(AddUniqueDebarment); @@ -435,6 +435,7 @@ END_SQL # my $outfile = 'overdues_' . ( $mybranch || $branchcode || 'default' ); while ( my $overdue_rules = $rqoverduerules->fetchrow_hashref ) { PERIOD: foreach my $i ( 1 .. 3 ) { + my $print_sent = 0; # We never sent a print notice $verbose and warn "branch '$branchcode', pass $i\n"; my $mindays = $overdue_rules->{"delay$i"}; # the notice will be sent after mindays days (grace period) @@ -456,7 +457,7 @@ END_SQL # my $borrower_sql = <<'END_SQL'; -SELECT distinct(issues.borrowernumber), firstname, surname, address, address2, city, zipcode, country, email, emailpro, B_email +SELECT distinct(issues.borrowernumber), firstname, surname, address, address2, city, zipcode, country, email, emailpro, B_email, smsalertnumber FROM issues,borrowers,categories WHERE issues.borrowernumber=borrowers.borrowernumber AND borrowers.categorycode=categories.categorycode @@ -552,63 +553,80 @@ END_SQL } $sth2->finish; - $letter = parse_letter( - { letter_code => $overdue_rules->{"letter$i"}, - borrowernumber => $borrowernumber, - branchcode => $branchcode, - items => \@items, - substitute => { # this appears to be a hack to overcome incomplete features in this code. - bib => $branch_details->{'branchname'}, # maybe 'bib' is a typo for 'lib'? - 'items.content' => $titles, - 'count' => $itemcount, - } + my @message_transport_types = @{ GetOverdueMessageTransportTypes( $branchcode, $overdue_rules->{categorycode}, $i) }; + @message_transport_types = @{ GetOverdueMessageTransportTypes( q{}, $overdue_rules->{categorycode}, $i) } + unless @message_transport_types; + + for my $mtt ( @message_transport_types ) { + + my $letter = parse_letter( + { letter_code => $overdue_rules->{"letter$i"}, + borrowernumber => $borrowernumber, + branchcode => $branchcode, + items => \@items, + substitute => { # this appears to be a hack to overcome incomplete features in this code. + bib => $branch_details->{'branchname'}, # maybe 'bib' is a typo for 'lib'? + 'items.content' => $titles, + 'count' => $itemcount, + }, + message_transport_type => $mtt, + } + ); + unless ($letter) { + $verbose and warn "Message '$overdue_rules->{letter$i}' content not found"; + + # might as well skip while PERIOD, no other borrowers are going to work. + # FIXME : Does this mean a letter must be defined in order to trigger a debar ? + next PERIOD; } - ); - unless ($letter) { - $verbose and warn "Message '$overdue_rules->{letter$i}' content not found"; - # might as well skip while PERIOD, no other borrowers are going to work. - # FIXME : Does this mean a letter must be defined in order to trigger a debar ? - next PERIOD; - } - - if ( $exceededPrintNoticesMaxLines ) { - $letter->{'content'} .= "List too long for form; please check your account online for a complete list of your overdue items."; - } + if ( $exceededPrintNoticesMaxLines ) { + $letter->{'content'} .= "List too long for form; please check your account online for a complete list of your overdue items."; + } - my @misses = grep { /./ } map { /^([^>]*)[>]+/; ( $1 || '' ); } split /\{'content'}; - if (@misses) { - $verbose and warn "The following terms were not matched and replaced: \n\t" . join "\n\t", @misses; - } + my @misses = grep { /./ } map { /^([^>]*)[>]+/; ( $1 || '' ); } split /\{'content'}; + if (@misses) { + $verbose and warn "The following terms were not matched and replaced: \n\t" . join "\n\t", @misses; + } - if ( !$nomail && scalar @emails_to_use ) { - C4::Letters::EnqueueLetter( - { letter => $letter, - borrowernumber => $borrowernumber, - message_transport_type => 'email', - from_address => $admin_email_address, - to_address => join(',', @emails_to_use), + if ($nomail) { + push @output_chunks, + prepare_letter_for_printing( + { letter => $letter, + borrowernumber => $borrowernumber, + firstname => $data->{'firstname'}, + lastname => $data->{'surname'}, + address1 => $data->{'address'}, + address2 => $data->{'address2'}, + city => $data->{'city'}, + postcode => $data->{'zipcode'}, + country => $data->{'country'}, + email => $notice_email, + itemcount => $itemcount, + titles => $titles, + outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : '', + } + ); + } else { + if ( ($mtt eq 'email' and not scalar @emails_to_use) or ($mtt eq 'sms' and not $data->{smsalertnumber}) ) { + # email or sms is requested but not exist, do a print. + $mtt = 'print'; } - ); - } else { - # if not sent by email then print - push @output_chunks, - prepare_letter_for_printing( - { letter => $letter, - borrowernumber => $borrowernumber, - firstname => $data->{'firstname'}, - lastname => $data->{'surname'}, - address1 => $data->{'address'}, - address2 => $data->{'address2'}, - city => $data->{'city'}, - postcode => $data->{'zipcode'}, - country => $data->{'country'}, - email => $notice_email, - itemcount => $itemcount, - titles => $titles, - outputformat => defined $csvfilename ? 'csv' : defined $htmlfilename ? 'html' : '', + unless ( $mtt eq 'print' and $print_sent == 1 ) { + # Just sent a print if not already done. + C4::Letters::EnqueueLetter( + { letter => $letter, + borrowernumber => $borrowernumber, + message_transport_type => $mtt, + from_address => $admin_email_address, + to_address => join(',', @emails_to_use), + } + ); + # A print notice should be sent only once per overdue level. + # 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. + $print_sent = 1 if $mtt eq 'print'; } - ); + } } } $sth->finish; @@ -732,6 +750,7 @@ sub parse_letter { tables => \%tables, substitute => $substitute, repeat => { item => \@item_tables }, + message_transport_type => $params->{message_transport_type}, ); } @@ -761,6 +780,7 @@ sub prepare_letter_for_printing { } my $return; + chomp $params->{titles}; if ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'csv' ) { if ($csv->combine( $params->{'firstname'}, $params->{'lastname'}, $params->{'address1'}, $params->{'address2'}, $params->{'postcode'}, -- 1.7.10.4