3 # Copyright 2008 LibLime
5 # This file is part of Koha.
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
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.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 advance_notices.pl - cron script to put item due reminders into message queue
26 ./advance_notices.pl -c
29 0 1 * * * advance_notices.pl -c
33 This script prepares pre-due and item due reminders to be sent to
34 patrons. It queues them in the message queue, which is processed by
35 the process_message_queue.pl cronjob. The type and timing of the
36 messages can be configured by the patrons in their "My Alerts" tab in
47 # find Koha's Perl modules
48 # test carefully before changing this
50 eval { require "$FindBin::Bin/../kohalib.pl" };
56 use C4::Members::Messaging;
62 advance_notices.pl - prepare messages to be sent to patrons for nearly due, or due, items
67 [ -n ][ -m <number of days> ][ --itemscontent <comma separated field list> ][ -c ]
75 Print a brief help message and exits.
79 Prints the manual page and exits.
83 Verbose. Without this flag set, only fatal errors are reported.
87 Do not send any email. Advanced or due notices that would have been sent to
88 the patrons are printed to standard out.
92 Defines the maximum number of days in advance to send advance notices.
96 =item B<--itemscontent>
98 comma separated list of fields that get substituted into templates in
99 places of the E<lt>E<lt>items.contentE<gt>E<gt> placeholder. This
100 defaults to due date,title,author,barcode
102 Other possible values come from fields in the biblios, items and
109 This script is designed to alert patrons when items are due, or coming due
113 This script pays attention to the advanced notice configuration
114 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
115 section of Koha is available in the Koha manual.
117 =head2 Outgoing emails
119 Typically, messages are prepared for each patron with due
120 items, and who have selected (or the library has elected for them) Advance or Due notices.
122 These emails are staged in the outgoing message queue, as are messages
123 produced by other features of Koha. This message queue must be
124 processed regularly by the
125 F<misc/cronjobs/process_message_queue.pl> program.
127 In the event that the C<-n> flag is passed to this program, no emails
128 are sent. Instead, messages are sent on standard output from this
129 program. They may be redirected to a file if desired.
133 Templates can contain variables enclosed in double angle brackets like
134 E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
135 specific to the overdue items or relevant patron. Available variables
140 =item E<lt>E<lt>items.contentE<gt>E<gt>
142 one line for each item, each line containing a tab separated list of
143 title, author, barcode, issuedate
145 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
147 any field from the borrowers table
149 =item E<lt>E<lt>branches.*E<gt>E<gt>
151 any field from the branches table
157 The F<misc/cronjobs/overdue_notices.pl> program allows you to send
158 messages to patrons when their messages are overdue.
161 # These are defaults for command line options.
162 my $confirm; # -c: Confirm that the user has read and configured this script.
163 # my $confirm = 1; # -c: Confirm that the user has read and configured this script.
164 my $nomail; # -n: No mail. Will not send any emails.
165 my $mindays = 0; # -m: Maximum number of days in advance to send notices
166 my $maxdays = 30; # -e: the End of the time period
167 my $verbose = 0; # -v: verbose
168 my $itemscontent = join(',',qw( date_due title author barcode ));
180 'itemscontent=s' => \$itemscontent,
182 pod2usage(1) if $help;
183 pod2usage( -verbose => 2 ) if $man;;
185 # Since advance notice options are not visible in the web-interface
186 # unless EnhancedMessagingPreferences is on, let the user know that
187 # this script probably isn't going to do much
188 if ( ! C4::Context->preference('EnhancedMessagingPreferences') ) {
191 The "EnhancedMessagingPreferences" syspref is off.
192 Therefore, it is unlikely that this script will actually produce any messages to be sent.
193 To change this, edit the "EnhancedMessagingPreferences" syspref.
200 # The fields that will be substituted into <<items.content>>
201 my @item_content_fields = split(/,/,$itemscontent);
203 warn 'getting upcoming due issues' if $verbose;
204 my $upcoming_dues = C4::Circulation::GetUpcomingDueIssues( { days_in_advance => $maxdays } );
205 warn 'found ' . scalar( @$upcoming_dues ) . ' issues' if $verbose;
207 # hash of borrowernumber to number of items upcoming
208 # for patrons wishing digests only.
212 my $dbh = C4::Context->dbh();
213 my $sth = $dbh->prepare(<<'END_SQL');
214 SELECT biblio.*, items.*, issues.*
215 FROM issues,items,biblio
216 WHERE items.itemnumber=issues.itemnumber
217 AND biblio.biblionumber=items.biblionumber
218 AND issues.borrowernumber = ?
219 AND issues.itemnumber = ?
220 AND (TO_DAYS(date_due)-TO_DAYS(NOW()) = ?)
223 my $admin_adress = C4::Context->preference('KohaAdminEmailAddress');
225 UPCOMINGITEM: foreach my $upcoming ( @$upcoming_dues ) {
226 warn 'examining ' . $upcoming->{'itemnumber'} . ' upcoming due items' if $verbose;
227 # warn( Data::Dumper->Dump( [ $upcoming ], [ 'overdue' ] ) );
229 my $from_address = $upcoming->{branchemail} || $admin_adress;
232 my $borrower_preferences;
233 if ( 0 == $upcoming->{'days_until_due'} ) {
234 # This item is due today. Send an 'item due' message.
235 $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $upcoming->{'borrowernumber'},
236 message_name => 'item_due' } );
237 # warn( Data::Dumper->Dump( [ $borrower_preferences ], [ 'borrower_preferences' ] ) );
238 next unless $borrower_preferences;
240 if ( $borrower_preferences->{'wants_digest'} ) {
241 # cache this one to process after we've run through all of the items.
242 my $digest = $due_digest->{$upcoming->{'borrowernumber'}} ||= {};
243 $digest->{email} ||= $from_address;
246 my $biblio = C4::Biblio::GetBiblioFromItemNumber( $upcoming->{'itemnumber'} );
247 my $letter_type = 'DUE';
248 $sth->execute($upcoming->{'borrowernumber'},$upcoming->{'itemnumber'},'0');
250 while ( my $item_info = $sth->fetchrow_hashref()) {
251 my @item_info = map { $_ =~ /^date|date$/ ? format_date($item_info->{$_}) : $item_info->{$_} || '' } @item_content_fields;
252 $titles .= join("\t",@item_info) . "\n";
255 ## Get branch info for borrowers home library.
256 $letter = parse_letter( { letter_code => $letter_type,
257 borrowernumber => $upcoming->{'borrowernumber'},
258 branchcode => $upcoming->{'branchcode'},
259 biblionumber => $biblio->{'biblionumber'},
260 itemnumber => $upcoming->{'itemnumber'},
261 substitute => { 'items.content' => $titles }
263 or die "no letter of type '$letter_type' found. Please see sample_notices.sql";
266 $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $upcoming->{'borrowernumber'},
267 message_name => 'advance_notice' } );
268 # warn( Data::Dumper->Dump( [ $borrower_preferences ], [ 'borrower_preferences' ] ) );
269 next UPCOMINGITEM unless $borrower_preferences && exists $borrower_preferences->{'days_in_advance'};
270 next UPCOMINGITEM unless $borrower_preferences->{'days_in_advance'} == $upcoming->{'days_until_due'};
272 if ( $borrower_preferences->{'wants_digest'} ) {
273 # cache this one to process after we've run through all of the items.
274 my $digest = $upcoming_digest->{$upcoming->{'borrowernumber'}} ||= {};
275 $digest->{email} ||= $from_address;
278 my $biblio = C4::Biblio::GetBiblioFromItemNumber( $upcoming->{'itemnumber'} );
279 my $letter_type = 'PREDUE';
280 $sth->execute($upcoming->{'borrowernumber'},$upcoming->{'itemnumber'},$borrower_preferences->{'days_in_advance'});
282 while ( my $item_info = $sth->fetchrow_hashref()) {
283 my @item_info = map { $_ =~ /^date|date$/ ? format_date($item_info->{$_}) : $item_info->{$_} || '' } @item_content_fields;
284 $titles .= join("\t",@item_info) . "\n";
287 ## Get branch info for borrowers home library.
288 $letter = parse_letter( { letter_code => $letter_type,
289 borrowernumber => $upcoming->{'borrowernumber'},
290 branchcode => $upcoming->{'branchcode'},
291 biblionumber => $biblio->{'biblionumber'},
292 itemnumber => $upcoming->{'itemnumber'},
293 substitute => { 'items.content' => $titles }
295 or die "no letter of type '$letter_type' found. Please see sample_notices.sql";
299 # If we have prepared a letter, send it.
303 print $letter->{'content'};
306 foreach my $transport ( keys %{$borrower_preferences->{'transports'}} ) {
307 C4::Letters::EnqueueLetter( { letter => $letter,
308 borrowernumber => $upcoming->{'borrowernumber'},
309 from_address => $from_address,
310 message_transport_type => $transport } );
317 # warn( Data::Dumper->Dump( [ $upcoming_digest ], [ 'upcoming_digest' ] ) );
319 # Now, run through all the people that want digests and send them
321 $sth = $dbh->prepare(<<'END_SQL');
322 SELECT biblio.*, items.*, issues.*
323 FROM issues,items,biblio
324 WHERE items.itemnumber=issues.itemnumber
325 AND biblio.biblionumber=items.biblionumber
326 AND issues.borrowernumber = ?
327 AND (TO_DAYS(date_due)-TO_DAYS(NOW()) = ?)
330 PATRON: while ( my ( $borrowernumber, $digest ) = each %$upcoming_digest ) {
331 my $count = $digest->{count};
332 my $from_address = $digest->{email};
334 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $borrowernumber,
335 message_name => 'advance_notice' } );
336 # warn( Data::Dumper->Dump( [ $borrower_preferences ], [ 'borrower_preferences' ] ) );
337 next PATRON unless $borrower_preferences; # how could this happen?
340 my $letter_type = 'PREDUEDGST';
342 $sth->execute($borrowernumber,$borrower_preferences->{'days_in_advance'});
344 while ( my $item_info = $sth->fetchrow_hashref()) {
345 my @item_info = map { $_ =~ /^date|date$/ ? format_date($item_info->{$_}) : $item_info->{$_} || '' } @item_content_fields;
346 $titles .= join("\t",@item_info) . "\n";
349 ## Get branch info for borrowers home library.
350 my %branch_info = get_branch_info( $borrowernumber );
352 my $letter = parse_letter(
354 letter_code => $letter_type,
355 borrowernumber => $borrowernumber,
358 'items.content' => $titles,
361 branchcode => $branch_info{ "branches.branchcode" },
364 or die "no letter of type '$letter_type' found. Please see sample_notices.sql";
367 print $letter->{'content'};
370 foreach my $transport ( keys %{$borrower_preferences->{'transports'}} ) {
371 C4::Letters::EnqueueLetter( { letter => $letter,
372 borrowernumber => $borrowernumber,
373 from_address => $from_address,
374 message_transport_type => $transport } );
379 # Now, run through all the people that want digests and send them
380 PATRON: while ( my ( $borrowernumber, $digest ) = each %$due_digest ) {
381 my $count = $digest->{count};
382 my $from_address = $digest->{email};
384 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $borrowernumber,
385 message_name => 'item_due' } );
386 # warn( Data::Dumper->Dump( [ $borrower_preferences ], [ 'borrower_preferences' ] ) );
387 next PATRON unless $borrower_preferences; # how could this happen?
389 my $letter_type = 'DUEDGST';
390 $sth->execute($borrowernumber,'0');
392 while ( my $item_info = $sth->fetchrow_hashref()) {
393 my @item_info = map { $_ =~ /^date|date$/ ? format_date($item_info->{$_}) : $item_info->{$_} || '' } @item_content_fields;
394 $titles .= join("\t",@item_info) . "\n";
397 ## Get branch info for borrowers home library.
398 my %branch_info = get_branch_info( $borrowernumber );
400 my $letter = parse_letter(
402 letter_code => $letter_type,
403 borrowernumber => $borrowernumber,
406 'items.content' => $titles,
409 branchcode => $branch_info{ "branches.branchcode" },
412 or die "no letter of type '$letter_type' found. Please see sample_notices.sql";
416 print $letter->{'content'};
419 foreach my $transport ( keys %{$borrower_preferences->{'transports'}} ) {
420 C4::Letters::EnqueueLetter( { letter => $letter,
421 borrowernumber => $borrowernumber,
422 from_address => $from_address,
423 message_transport_type => $transport } );
436 foreach my $required ( qw( letter_code borrowernumber ) ) {
437 return unless exists $params->{$required};
440 my %table_params = ( 'borrowers' => $params->{'borrowernumber'} );
442 if ( my $p = $params->{'branchcode'} ) {
443 $table_params{'branches'} = $p;
445 if ( my $p = $params->{'itemnumber'} ) {
446 $table_params{'issues'} = $p;
447 $table_params{'items'} = $p;
449 if ( my $p = $params->{'biblionumber'} ) {
450 $table_params{'biblio'} = $p;
451 $table_params{'biblioitems'} = $p;
454 return C4::Letters::GetPreparedLetter (
455 module => 'circulation',
456 letter_code => $params->{'letter_code'},
457 branchcode => $table_params{'branches'},
458 substitute => $params->{'substitute'},
459 tables => \%table_params,
464 my $date_string = shift;
465 my $dt=dt_from_string($date_string);
466 return output_pref($dt);
469 =head2 get_branch_info
473 sub get_branch_info {
474 my ( $borrowernumber ) = @_;
476 ## Get branch info for borrowers home library.
477 my $borrower_details = C4::Members::GetMember( borrowernumber => $borrowernumber );
478 my $borrower_branchcode = $borrower_details->{'branchcode'};
479 my $branch = C4::Branch::GetBranchDetail( $borrower_branchcode );
481 foreach my $key( keys %$branch ) {
482 $branch_info{"branches.$key"} = $branch->{$key};