-#!/usr/bin/perl -w
+#!/usr/bin/perl
# Copyright 2008 LibLime
#
# 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., 59 Temple Place,
-# Suite 330, Boston, MA 02111-1307 USA
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
=head1 NAME
use strict;
use warnings;
use Getopt::Long;
+use Pod::Usage;
use Data::Dumper;
BEGIN {
# find Koha's Perl modules
use C4::Members;
use C4::Members::Messaging;
use C4::Overdues;
+use Koha::DateUtils;
+use C4::Log;
+use Koha::Libraries;
+=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 <number of days> ][ --itemscontent <comma separated field list> ][ -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 E<lt>E<lt>items.contentE<gt>E<gt> 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<misc/cronjobs/process_message_queue.pl> 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
+E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
+specific to the overdue items or relevant patron. Available variables
+are:
+
+=over
+
+=item E<lt>E<lt>items.contentE<gt>E<gt>
+
+one line for each item, each line containing a tab separated list of
+date due, title, author, barcode
+
+=item E<lt>E<lt>borrowers.*E<gt>E<gt>
+
+any field from the borrowers table
+
+=item E<lt>E<lt>branches.*E<gt>E<gt>
+
+any field from the branches table
+
+=back
+
+=head1 SEE ALSO
+
+The F<misc/cronjobs/overdue_notices.pl> 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 $fromaddress = C4::Context->preference('KohaAdminEmailAddress'); # -f: From address for the emails
my $verbose = 0; # -v: verbose
-
-GetOptions( 'c' => \$confirm,
- 'n' => \$nomail,
- 'm:i' => \$maxdays,
- 'f:s' => \$fromaddress,
- 'v' => \$verbose,
- );
-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.
- -f from address for the emails. Defaults to KohaAdminEmailAddress system preference
- -n send No mail. Instead, all mail messages are printed on screen. Usefull for testing purposes.
- -v verbose
-
-ENDUSAGE
+my $itemscontent = join(',',qw( date_due title author barcode ));
+
+my $help = 0;
+my $man = 0;
+
+GetOptions(
+ 'help|?' => \$help,
+ 'man' => \$man,
+ 'c' => \$confirm,
+ 'n' => \$nomail,
+ 'm:i' => \$maxdays,
+ 'v' => \$verbose,
+ 'itemscontent=s' => \$itemscontent,
+ )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
END_WARN
}
-
unless ($confirm) {
- print $usage;
- print "Do you wish to continue? (y/n)";
- chomp($_ = <STDIN>);
- exit unless (/^y/i);
-
+ pod2usage(1);
}
+cronlogaction();
+
+# The fields that will be substituted into <<items.content>>
+my @item_content_fields = split(/,/,$itemscontent);
warn 'getting upcoming due issues' if $verbose;
my $upcoming_dues = C4::Circulation::GetUpcomingDueIssues( { days_in_advance => $maxdays } );
my $upcoming_digest;
my $due_digest;
+my $dbh = C4::Context->dbh();
+my $sth = $dbh->prepare(<<'END_SQL');
+SELECT biblio.*, items.*, issues.*
+ FROM issues,items,biblio
+ WHERE items.itemnumber=issues.itemnumber
+ AND biblio.biblionumber=items.biblionumber
+ AND issues.borrowernumber = ?
+ AND issues.itemnumber = ?
+ AND (TO_DAYS(date_due)-TO_DAYS(NOW()) = ?)
+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 $letter;
+
+ my $from_address = $upcoming->{branchemail} || $admin_adress;
+
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 DUEITEM unless $borrower_preferences;
+ message_name => 'item_due' } );
+ next unless $borrower_preferences;
if ( $borrower_preferences->{'wants_digest'} ) {
# cache this one to process after we've run through all of the items.
- $due_digest->{$upcoming->{'borrowernumber'}}++;
+ $due_digest->{ $upcoming->{borrowernumber} }->{email} = $from_address;
+ $due_digest->{ $upcoming->{borrowernumber} }->{count}++;
} else {
my $biblio = C4::Biblio::GetBiblioFromItemNumber( $upcoming->{'itemnumber'} );
my $letter_type = 'DUE';
- $letter = C4::Letters::getletter( 'circulation', $letter_type );
- die "no letter of type '$letter_type' found. Please see sample_notices.sql" unless $letter;
-
- $letter = parse_letter( { letter => $letter,
+ $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";
+ }
+
+ ## 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'} } );
+ branchcode => $upcoming->{'branchcode'},
+ biblionumber => $biblio->{'biblionumber'},
+ itemnumber => $upcoming->{'itemnumber'},
+ substitute => { 'items.content' => $titles },
+ message_transport_type => $transport,
+ } )
+ 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' ] ) );
+ message_name => 'advance_notice' } );
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.
- $upcoming_digest->{$upcoming->{'borrowernumber'}}++;
+ $upcoming_digest->{ $upcoming->{borrowernumber} }->{email} = $from_address;
+ $upcoming_digest->{ $upcoming->{borrowernumber} }->{count}++;
} else {
my $biblio = C4::Biblio::GetBiblioFromItemNumber( $upcoming->{'itemnumber'} );
my $letter_type = 'PREDUE';
- $letter = C4::Letters::getletter( 'circulation', $letter_type );
- die "no letter of type '$letter_type' found. Please see sample_notices.sql" unless $letter;
-
- $letter = parse_letter( { letter => $letter,
+ $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";
+ }
+
+ ## 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'} } );
+ branchcode => $upcoming->{'branchcode'},
+ biblionumber => $biblio->{'biblionumber'},
+ itemnumber => $upcoming->{'itemnumber'},
+ substitute => { 'items.content' => $titles },
+ message_transport_type => $transport,
+ } )
+ 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 ) {
- foreach my $transport ( @{$borrower_preferences->{'transports'}} ) {
+ if ( @letters ) {
+ if ($nomail) {
+ for my $letter ( @letters ) {
+ local $, = "\f";
+ print $letter->{'content'};
+ }
+ }
+ else {
+ for my $letter ( @letters ) {
C4::Letters::EnqueueLetter( { letter => $letter,
borrowernumber => $upcoming->{'borrowernumber'},
- message_transport_type => $transport } );
+ from_address => $from_address,
+ 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
-PATRON: while ( my ( $borrowernumber, $count ) = each %$upcoming_digest ) {
+
+$sth = $dbh->prepare(<<'END_SQL');
+SELECT biblio.*, items.*, issues.*
+ FROM issues,items,biblio
+ WHERE items.itemnumber=issues.itemnumber
+ AND biblio.biblionumber=items.biblionumber
+ 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' ] ) );
+ message_name => 'advance_notice' } );
next PATRON unless $borrower_preferences; # how could this happen?
my $letter_type = 'PREDUEDGST';
- my $letter = C4::Letters::getletter( 'circulation', $letter_type );
- die "no letter of type '$letter_type' found. Please see sample_notices.sql" unless $letter;
- $letter = parse_letter( { letter => $letter,
- borrowernumber => $borrowernumber,
- substitute => { count => $count }
- } );
-
- foreach my $transport ( @{$borrower_preferences->{'transports'}} ) {
- C4::Letters::EnqueueLetter( { letter => $letter,
- borrowernumber => $borrowernumber,
- message_transport_type => $transport } );
+
+ $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";
+ }
+
+ ## 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;
+ }
+
+ 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, $count ) = each %$due_digest ) {
+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' ] ) );
+ message_name => 'item_due' } );
next PATRON unless $borrower_preferences; # how could this happen?
my $letter_type = 'DUEDGST';
- my $letter = C4::Letters::getletter( 'circulation', $letter_type );
- die "no letter of type '$letter_type' found. Please see sample_notices.sql" unless $letter;
- $letter = parse_letter( { letter => $letter,
- borrowernumber => $borrowernumber,
- substitute => { count => $count }
- } );
-
- foreach my $transport ( @{$borrower_preferences->{'transports'}} ) {
- C4::Letters::EnqueueLetter( { letter => $letter,
- borrowernumber => $borrowernumber,
- message_transport_type => $transport } );
+ $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";
+ }
+
+ ## 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;
+ }
+
+ 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
=head2 parse_letter
-
-
=cut
sub parse_letter {
my $params = shift;
- foreach my $required ( qw( letter borrowernumber ) ) {
+ foreach my $required ( qw( letter_code borrowernumber ) ) {
return unless exists $params->{$required};
}
- if ( $params->{'substitute'} ) {
- while ( my ($key, $replacedby) = each %{$params->{'substitute'}} ) {
- my $replacefield = "<<$key>>";
-
- $params->{'letter'}->{title} =~ s/$replacefield/$replacedby/g;
- $params->{'letter'}->{content} =~ s/$replacefield/$replacedby/g;
- }
+ my %table_params = ( 'borrowers' => $params->{'borrowernumber'} );
+
+ if ( my $p = $params->{'branchcode'} ) {
+ $table_params{'branches'} = $p;
+ }
+ if ( my $p = $params->{'itemnumber'} ) {
+ $table_params{'issues'} = $p;
+ $table_params{'items'} = $p;
+ }
+ if ( my $p = $params->{'biblionumber'} ) {
+ $table_params{'biblio'} = $p;
+ $table_params{'biblioitems'} = $p;
}
- C4::Letters::parseletter( $params->{'letter'}, 'borrowers', $params->{'borrowernumber'} );
+ return C4::Letters::GetPreparedLetter (
+ module => 'circulation',
+ letter_code => $params->{'letter_code'},
+ branchcode => $table_params{'branches'},
+ substitute => $params->{'substitute'},
+ tables => \%table_params,
+ message_transport_type => $params->{message_transport_type},
+ );
+}
- if ( $params->{'branchcode'} ) {
- C4::Letters::parseletter( $params->{'letter'}, 'branches', $params->{'branchcode'} );
- }
-
- if ( $params->{'biblionumber'} ) {
- C4::Letters::parseletter( $params->{'letter'}, 'biblio', $params->{'biblionumber'} );
- C4::Letters::parseletter( $params->{'letter'}, 'biblioitems', $params->{'biblionumber'} );
+sub format_date {
+ my $date_string = shift;
+ my $dt=dt_from_string($date_string);
+ return output_pref($dt);
+}
+
+=head2 get_branch_info
+
+=cut
+
+sub get_branch_info {
+ my ( $borrowernumber ) = @_;
+
+ ## Get branch info for borrowers home library.
+ my $borrower_details = C4::Members::GetMember( borrowernumber => $borrowernumber );
+ my $borrower_branchcode = $borrower_details->{'branchcode'};
+ my $branch = Koha::Libraries->find( $borrower_branchcode )->unblessed;
+ my %branch_info;
+ foreach my $key( keys %$branch ) {
+ $branch_info{"branches.$key"} = $branch->{$key};
}
- return $params->{'letter'};
+ return %branch_info;
}
1;
projects / koha.git / blobdiff