X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=misc%2Fcronjobs%2Fadvance_notices.pl;h=73697b8fd0126335ba249c66586c60bf8d98c580;hb=6a2a80988dd121215284c4458438fdb0fe41b86c;hp=09c4017558872d820e77e19a99b610a16869a885;hpb=ba6c8485ca7afdaaace20d021591ac532de55b3a;p=koha.git diff --git a/misc/cronjobs/advance_notices.pl b/misc/cronjobs/advance_notices.pl index 09c4017558..73697b8fd0 100755 --- a/misc/cronjobs/advance_notices.pl +++ b/misc/cronjobs/advance_notices.pl @@ -4,18 +4,18 @@ # # This file is part of Koha. # -# Koha is free software; you can redistribute it and/or modify it under the -# terms of the GNU General Public License as published by the Free Software -# Foundation; either version 2 of the License, or (at your option) any later -# version. +# Koha is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. # -# Koha is distributed in the hope that it will be useful, but WITHOUT ANY -# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR -# A PARTICULAR PURPOSE. See the GNU General Public License for more details. +# Koha is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. # -# You should have received a copy of the GNU General Public License along -# with Koha; if not, write to the Free Software Foundation, Inc., -# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +# You should have received a copy of the GNU General Public License +# along with Koha; if not, see . =head1 NAME @@ -41,6 +41,7 @@ the OPAC. use strict; use warnings; use Getopt::Long; +use Pod::Usage; use Data::Dumper; BEGIN { # find Koha's Perl modules @@ -54,36 +55,141 @@ use C4::Letters; use C4::Members; use C4::Members::Messaging; use C4::Overdues; -use C4::Dates qw/format_date/; +use Koha::DateUtils; +use C4::Log; +use Koha::Items; +use Koha::Libraries; +use Koha::Patrons; +=head1 NAME + +advance_notices.pl - prepare messages to be sent to patrons for nearly due, or due, items + +=head1 SYNOPSIS + +advance_notices.pl + [ -n ][ -m ][ --itemscontent ][ -c ] + +=head1 OPTIONS + +=over 8 + +=item B<--help> + +Print a brief help message and exits. + +=item B<--man> + +Prints the manual page and exits. + +=item B<-v> + +Verbose. Without this flag set, only fatal errors are reported. + +=item B<-n> + +Do not send any email. Advanced or due notices that would have been sent to +the patrons are printed to standard out. + +=item B<-m> + +Defines the maximum number of days in advance to send advance notices. + +=item B<-c> + +Confirm flag: Add this option. The script will only print a usage +statement otherwise. + +=item B<--itemscontent> + +comma separated list of fields that get substituted into templates in +places of the EEitems.contentEE placeholder. This +defaults to date_due,title,author,barcode + +Other possible values come from fields in the biblios, items and +issues tables. + +=back + +=head1 DESCRIPTION + +This script is designed to alert patrons when items are due, or coming due + +=head2 Configuration + +This script pays attention to the advanced notice configuration +performed by borrowers in the OPAC, or by staff in the patron detail page of the intranet. The content of the messages is configured in Tools -> Notices and slips. Advanced notices use the PREDUE template, due notices use DUE. More information about the use of this +section of Koha is available in the Koha manual. + +=head2 Outgoing emails + +Typically, messages are prepared for each patron with due +items, and who have selected (or the library has elected for them) Advance or Due notices. + +These emails are staged in the outgoing message queue, as are messages +produced by other features of Koha. This message queue must be +processed regularly by the +F program. + +In the event that the C<-n> flag is passed to this program, no emails +are sent. Instead, messages are sent on standard output from this +program. They may be redirected to a file if desired. + +=head2 Templates + +Templates can contain variables enclosed in double angle brackets like +EEthisEE. Those variables will be replaced with values +specific to the overdue items or relevant patron. Available variables +are: + +=over + +=item EEitems.contentEE + +one line for each item, each line containing a tab separated list of +date due, title, author, barcode + +=item EEborrowers.*EE + +any field from the borrowers table + +=item EEbranches.*EE + +any field from the branches table + +=back + +=head1 SEE ALSO + +The F program allows you to send +messages to patrons when their messages are overdue. + +=cut + +binmode( STDOUT, ':encoding(UTF-8)' ); # These are defaults for command line options. my $confirm; # -c: Confirm that the user has read and configured this script. -# my $confirm = 1; # -c: Confirm that the user has read and configured this script. my $nomail; # -n: No mail. Will not send any emails. my $mindays = 0; # -m: Maximum number of days in advance to send notices my $maxdays = 30; # -e: the End of the time period my $verbose = 0; # -v: verbose -my $itemscontent = join(',',qw( issuedate title barcode author )); +my $itemscontent = join(',',qw( date_due title author barcode )); + +my $help = 0; +my $man = 0; -GetOptions( 'c' => \$confirm, +GetOptions( + 'help|?' => \$help, + 'man' => \$man, + 'c' => \$confirm, 'n' => \$nomail, 'm:i' => \$maxdays, 'v' => \$verbose, 'itemscontent=s' => \$itemscontent, - ); -my $usage = << 'ENDUSAGE'; - -This script prepares pre-due and item due reminders to be sent to -patrons. It queues them in the message queue, which is processed by -the process_message_queue.pl cronjob. -See the comments in the script for directions on changing the script. -This script has the following parameters : - -c Confirm and remove this help & warning - -m maximum number of days in advance to send advance notices. - -n send No mail. Instead, all mail messages are printed on screen. Usefull for testing purposes. - -v verbose -ENDUSAGE + )or pod2usage(2); +pod2usage(1) if $help; +pod2usage( -verbose => 2 ) if $man; # Since advance notice options are not visible in the web-interface # unless EnhancedMessagingPreferences is on, let the user know that @@ -97,15 +203,12 @@ To change this, edit the "EnhancedMessagingPreferences" syspref. END_WARN } - unless ($confirm) { - print $usage; - print "Do you wish to continue? (y/n)"; - chomp($_ = ); - exit unless (/^y/i); - + pod2usage(1); } +cronlogaction(); + # The fields that will be substituted into <> my @item_content_fields = split(/,/,$itemscontent); @@ -131,97 +234,102 @@ END_SQL my $admin_adress = C4::Context->preference('KohaAdminEmailAddress'); +my @letters; UPCOMINGITEM: foreach my $upcoming ( @$upcoming_dues ) { + @letters = (); warn 'examining ' . $upcoming->{'itemnumber'} . ' upcoming due items' if $verbose; - # warn( Data::Dumper->Dump( [ $upcoming ], [ 'overdue' ] ) ); my $from_address = $upcoming->{branchemail} || $admin_adress; - my $letter; my $borrower_preferences; if ( 0 == $upcoming->{'days_until_due'} ) { # This item is due today. Send an 'item due' message. $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $upcoming->{'borrowernumber'}, message_name => 'item_due' } ); - # warn( Data::Dumper->Dump( [ $borrower_preferences ], [ 'borrower_preferences' ] ) ); next unless $borrower_preferences; if ( $borrower_preferences->{'wants_digest'} ) { # cache this one to process after we've run through all of the items. - my $digest = $due_digest->{$upcoming->{'borrowernumber'}} ||= {}; - $digest->{email} ||= $from_address; - $digest->{count}++; + $due_digest->{ $upcoming->{borrowernumber} }->{email} = $from_address; + $due_digest->{ $upcoming->{borrowernumber} }->{count}++; } else { - my $biblio = C4::Biblio::GetBiblioFromItemNumber( $upcoming->{'itemnumber'} ); + my $item = Koha::Items->find( $upcoming->{itemnumber} ); my $letter_type = 'DUE'; $sth->execute($upcoming->{'borrowernumber'},$upcoming->{'itemnumber'},'0'); my $titles = ""; while ( my $item_info = $sth->fetchrow_hashref()) { - my @item_info = map { $_ =~ /^date|date$/ ? format_date($item_info->{$_}) : $item_info->{$_} || '' } @item_content_fields; - $titles .= join("\t",@item_info) . "\n"; + $titles .= C4::Letters::get_item_content( { item => $item_info, item_content_fields => \@item_content_fields } ); } - - $letter = parse_letter( { letter_code => $letter_type, + + ## Get branch info for borrowers home library. + foreach my $transport ( keys %{$borrower_preferences->{'transports'}} ) { + my $letter = parse_letter( { letter_code => $letter_type, borrowernumber => $upcoming->{'borrowernumber'}, branchcode => $upcoming->{'branchcode'}, - biblionumber => $biblio->{'biblionumber'}, + biblionumber => $item->biblionumber, itemnumber => $upcoming->{'itemnumber'}, - substitute => { 'items.content' => $titles } + substitute => { 'items.content' => $titles }, + message_transport_type => $transport, } ) - or die "no letter of type '$letter_type' found. Please see sample_notices.sql"; + or warn "no letter of type '$letter_type' found for borrowernumber ".$upcoming->{'borrowernumber'}.". Please see sample_notices.sql"; + push @letters, $letter if $letter; + } } } else { $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $upcoming->{'borrowernumber'}, message_name => 'advance_notice' } ); - # warn( Data::Dumper->Dump( [ $borrower_preferences ], [ 'borrower_preferences' ] ) ); next UPCOMINGITEM unless $borrower_preferences && exists $borrower_preferences->{'days_in_advance'}; next UPCOMINGITEM unless $borrower_preferences->{'days_in_advance'} == $upcoming->{'days_until_due'}; if ( $borrower_preferences->{'wants_digest'} ) { # cache this one to process after we've run through all of the items. - my $digest = $upcoming_digest->{$upcoming->{'borrowernumber'}} ||= {}; - $digest->{email} ||= $from_address; - $digest->{count}++; + $upcoming_digest->{ $upcoming->{borrowernumber} }->{email} = $from_address; + $upcoming_digest->{ $upcoming->{borrowernumber} }->{count}++; } else { - my $biblio = C4::Biblio::GetBiblioFromItemNumber( $upcoming->{'itemnumber'} ); + my $item = Koha::Items->find( $upcoming->{itemnumber} ); my $letter_type = 'PREDUE'; $sth->execute($upcoming->{'borrowernumber'},$upcoming->{'itemnumber'},$borrower_preferences->{'days_in_advance'}); my $titles = ""; while ( my $item_info = $sth->fetchrow_hashref()) { - my @item_info = map { $_ =~ /^date|date$/ ? format_date($item_info->{$_}) : $item_info->{$_} || '' } @item_content_fields; - $titles .= join("\t",@item_info) . "\n"; + $titles .= C4::Letters::get_item_content( { item => $item_info, item_content_fields => \@item_content_fields } ); } - - $letter = parse_letter( { letter_code => $letter_type, + + ## Get branch info for borrowers home library. + foreach my $transport ( keys %{$borrower_preferences->{'transports'}} ) { + my $letter = parse_letter( { letter_code => $letter_type, borrowernumber => $upcoming->{'borrowernumber'}, branchcode => $upcoming->{'branchcode'}, - biblionumber => $biblio->{'biblionumber'}, + biblionumber => $item->biblionumber, itemnumber => $upcoming->{'itemnumber'}, - substitute => { 'items.content' => $titles } + substitute => { 'items.content' => $titles }, + message_transport_type => $transport, } ) - or die "no letter of type '$letter_type' found. Please see sample_notices.sql"; + or warn "no letter of type '$letter_type' found for borrowernumber ".$upcoming->{'borrowernumber'}.". Please see sample_notices.sql"; + push @letters, $letter if $letter; + } } } # If we have prepared a letter, send it. - if ($letter) { + if ( @letters ) { if ($nomail) { - local $, = "\f"; - print $letter->{'content'}; + for my $letter ( @letters ) { + local $, = "\f"; + print $letter->{'content'}; + } } else { - foreach my $transport ( @{$borrower_preferences->{'transports'}} ) { + for my $letter ( @letters ) { C4::Letters::EnqueueLetter( { letter => $letter, borrowernumber => $upcoming->{'borrowernumber'}, from_address => $from_address, - message_transport_type => $transport } ); + message_transport_type => $letter->{message_transport_type} } ); } } } } -# warn( Data::Dumper->Dump( [ $upcoming_digest ], [ 'upcoming_digest' ] ) ); # Now, run through all the people that want digests and send them @@ -233,14 +341,13 @@ SELECT biblio.*, items.*, issues.* AND issues.borrowernumber = ? AND (TO_DAYS(date_due)-TO_DAYS(NOW()) = ?) END_SQL - PATRON: while ( my ( $borrowernumber, $digest ) = each %$upcoming_digest ) { + @letters = (); my $count = $digest->{count}; my $from_address = $digest->{email}; my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $borrowernumber, message_name => 'advance_notice' } ); - # warn( Data::Dumper->Dump( [ $borrower_preferences ], [ 'borrower_preferences' ] ) ); next PATRON unless $borrower_preferences; # how could this happen? @@ -249,67 +356,103 @@ PATRON: while ( my ( $borrowernumber, $digest ) = each %$upcoming_digest ) { $sth->execute($borrowernumber,$borrower_preferences->{'days_in_advance'}); my $titles = ""; while ( my $item_info = $sth->fetchrow_hashref()) { - my @item_info = map { $_ =~ /^date|date$/ ? format_date($item_info->{$_}) : $item_info->{$_} || '' } @item_content_fields; - $titles .= join("\t",@item_info) . "\n"; + $titles .= C4::Letters::get_item_content( { item => $item_info, item_content_fields => \@item_content_fields } ); } - my $letter = parse_letter( { letter_code => $letter_type, - borrowernumber => $borrowernumber, - substitute => { count => $count, - 'items.content' => $titles - } - } ) - or die "no letter of type '$letter_type' found. Please see sample_notices.sql"; - if ($nomail) { - local $, = "\f"; - print $letter->{'content'}; + + ## Get branch info for borrowers home library. + my %branch_info = get_branch_info( $borrowernumber ); + + foreach my $transport ( keys %{ $borrower_preferences->{'transports'} } ) { + my $letter = parse_letter( + { + letter_code => $letter_type, + borrowernumber => $borrowernumber, + substitute => { + count => $count, + 'items.content' => $titles, + %branch_info, + }, + branchcode => $branch_info{"branches.branchcode"}, + message_transport_type => $transport, + } + ) + or warn "no letter of type '$letter_type' found for borrowernumber $borrowernumber. Please see sample_notices.sql"; + push @letters, $letter if $letter; } - else { - foreach my $transport ( @{$borrower_preferences->{'transports'}} ) { - C4::Letters::EnqueueLetter( { letter => $letter, - borrowernumber => $borrowernumber, - from_address => $from_address, - message_transport_type => $transport } ); + + if ( @letters ) { + if ($nomail) { + for my $letter ( @letters ) { + local $, = "\f"; + print $letter->{'content'}; + } + } + else { + for my $letter ( @letters ) { + C4::Letters::EnqueueLetter( { letter => $letter, + borrowernumber => $borrowernumber, + from_address => $from_address, + message_transport_type => $letter->{message_transport_type} } ); + } } } } # Now, run through all the people that want digests and send them PATRON: while ( my ( $borrowernumber, $digest ) = each %$due_digest ) { + @letters = (); my $count = $digest->{count}; my $from_address = $digest->{email}; my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $borrowernumber, message_name => 'item_due' } ); - # warn( Data::Dumper->Dump( [ $borrower_preferences ], [ 'borrower_preferences' ] ) ); next PATRON unless $borrower_preferences; # how could this happen? my $letter_type = 'DUEDGST'; $sth->execute($borrowernumber,'0'); my $titles = ""; while ( my $item_info = $sth->fetchrow_hashref()) { - my @item_info = map { $_ =~ /^date|date$/ ? format_date($item_info->{$_}) : $item_info->{$_} || '' } @item_content_fields; - $titles .= join("\t",@item_info) . "\n"; + $titles .= C4::Letters::get_item_content( { item => $item_info, item_content_fields => \@item_content_fields } ); } - my $letter = parse_letter( { letter_code => $letter_type, - borrowernumber => $borrowernumber, - substitute => { count => $count, - 'items.content' => $titles - } - } ) - or die "no letter of type '$letter_type' found. Please see sample_notices.sql"; - - if ($nomail) { - local $, = "\f"; - print $letter->{'content'}; + + ## Get branch info for borrowers home library. + my %branch_info = get_branch_info( $borrowernumber ); + + for my $transport ( keys %{ $borrower_preferences->{'transports'} } ) { + my $letter = parse_letter( + { + letter_code => $letter_type, + borrowernumber => $borrowernumber, + substitute => { + count => $count, + 'items.content' => $titles, + %branch_info, + }, + branchcode => $branch_info{"branches.branchcode"}, + message_transport_type => $transport, + } + ) + or warn "no letter of type '$letter_type' found for borrowernumber $borrowernumber. Please see sample_notices.sql"; + push @letters, $letter if $letter; } - else { - foreach my $transport ( @{$borrower_preferences->{'transports'}} ) { - C4::Letters::EnqueueLetter( { letter => $letter, - borrowernumber => $borrowernumber, - from_address => $from_address, - message_transport_type => $transport } ); + + if ( @letters ) { + if ($nomail) { + for my $letter ( @letters ) { + local $, = "\f"; + print $letter->{'content'}; + } + } + else { + for my $letter ( @letters ) { + C4::Letters::EnqueueLetter( { letter => $letter, + borrowernumber => $borrowernumber, + from_address => $from_address, + message_transport_type => $letter->{message_transport_type} } ); + } } } + } =head1 METHODS @@ -323,6 +466,7 @@ sub parse_letter { foreach my $required ( qw( letter_code borrowernumber ) ) { return unless exists $params->{$required}; } + my $patron = Koha::Patrons->find( $params->{borrowernumber} ); my %table_params = ( 'borrowers' => $params->{'borrowernumber'} ); @@ -342,11 +486,31 @@ sub parse_letter { module => 'circulation', letter_code => $params->{'letter_code'}, branchcode => $table_params{'branches'}, + lang => $patron->lang, substitute => $params->{'substitute'}, tables => \%table_params, + message_transport_type => $params->{message_transport_type}, ); } +=head2 get_branch_info + +=cut + +sub get_branch_info { + my ( $borrowernumber ) = @_; + + ## Get branch info for borrowers home library. + my $patron = Koha::Patrons->find( $borrowernumber ); + my $branch = $patron->library->unblessed; + my %branch_info; + foreach my $key( keys %$branch ) { + $branch_info{"branches.$key"} = $branch->{$key}; + } + + return %branch_info; +} + 1; __END__