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 with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA 02111-1307 USA
25 # find Koha's Perl modules
26 # test carefully before changing this
28 eval { require "$FindBin::Bin/../kohalib.pl" };
32 use C4::Dates qw/format_date/;
42 overdue_notices.pl - prepare messages to be sent to patrons for overdue items
46 overdue_notices.pl [ -n ] [ -library <branchcode> ] [ -max <number of days> ] [ -csv [ <filename> ] ] [ -itemscontent <field list> ]
49 -help brief help message
50 -man full documentation
51 -n No email will be sent
52 -max <days> maximum days overdue to deal with
53 -library <branchname> only deal with overdues from this library
54 -csv <filename> populate CSV file
55 -itemscontent <list of fields> item information in templates
63 Print a brief help message and exits.
67 Prints the manual page and exits.
71 Verbose. Without this flag set, only fatal errors are reported.
75 Do not send any email. Overdue notices that would have been sent to
76 the patrons or to the admin are printed to standard out. CSV data (if
77 the -csv flag is set) is written to standard out or to any csv
82 Items older than max days are assumed to be handled somewhere else,
83 probably the F<longoverdues.pl> script. They are therefore ignored by
84 this program. No notices are sent for them, and they are not added to
85 any CSV files. Defaults to 90 to match F<longoverdues.pl>.
89 select overdues for one specific library. Use the value in the
90 branches.branchcode table.
94 Produces CSV data. if -n (no mail) flag is set, then this CSV data is
95 sent to standard out or to a filename if provided. Otherwise, only
96 overdues that could not be emailed are sent in CSV format to the admin.
98 =item B<-itemscontent>
100 comma separated list of fields that get substituted into templates in
101 places of the E<lt>E<lt>items.contentE<gt>E<gt> placeholder. This
102 defaults to issuedate,title,barcode,author
104 Other possible values come from fields in the biblios, items, and
107 =item B<-t> | B<--triggered>
109 This option causes a notice to be generated if and only if
110 an item is overdue by the number of days defined in a notice trigger.
112 By default, a notice is sent each time the script runs, which is suitable for
113 less frequent run cron script, but requires syncing notice triggers with
114 the cron schedule to ensure proper behavior.
115 Add the --triggered option for daily cron, at the risk of no notice
116 being generated if the cron fails to run on time.
120 Default items.content lists only those items that fall in the
121 range of the currently processing notice.
122 Choose list-all to include all overdue items in the list (limited by B<-max> setting).
128 This script is designed to alert patrons and administrators of overdue
133 This script pays attention to the overdue notice configuration
134 performed in the "Overdue notice/status triggers" section of the
135 "Tools" area of the staff interface to Koha. There, you can choose
136 which letter templates are sent out after a configurable number of
137 days to patrons of each library. More information about the use of this
138 section of Koha is available in the Koha manual.
140 The templates used to craft the emails are defined in the "Tools:
141 Notices" section of the staff interface to Koha.
143 =head2 Outgoing emails
145 Typically, messages are prepared for each patron with overdue
146 items. Messages for whom there is no email address on file are
147 collected and sent as attachments in a single email to each library
148 administrator, or if that is not set, then to the email address in the
149 C<KohaAdminEmailAddress> system preference.
151 These emails are staged in the outgoing message queue, as are messages
152 produced by other features of Koha. This message queue must be
153 processed regularly by the
154 F<misc/cronjobs/process_message_queue.pl> program.
156 In the event that the C<-n> flag is passed to this program, no emails
157 are sent. Instead, messages are sent on standard output from this
158 program. They may be redirected to a file if desired.
162 Templates can contain variables enclosed in double angle brackets like
163 E<lt>E<lt>thisE<gt>E<gt>. Those variables will be replaced with values
164 specific to the overdue items or relevant patron. Available variables
169 =item E<lt>E<lt>bibE<gt>E<gt>
171 the name of the library
173 =item E<lt>E<lt>items.contentE<gt>E<gt>
175 one line for each item, each line containing a tab separated list of
176 title, author, barcode, issuedate
178 =item E<lt>E<lt>borrowers.*E<gt>E<gt>
180 any field from the borrowers table
182 =item E<lt>E<lt>branches.*E<gt>E<gt>
184 any field from the branches table
190 The C<-csv> command line option lets you specify a file to which
191 overdues data should be output in CSV format.
193 With the C<-n> flag set, data about all overdues is written to the
194 file. Without that flag, only information about overdues that were
195 unable to be sent directly to the patrons will be written. In other
196 words, this CSV file replaces the data that is typically sent to the
197 administrator email address.
199 =head1 USAGE EXAMPLES
201 C<overdue_notices.pl> - In this most basic usage, with no command line
202 arguments, all libraries are procesed individually, and notices are
203 prepared for all patrons with overdue items for whom we have email
204 addresses. Messages for those patrons for whom we have no email
205 address are sent in a single attachment to the library administrator's
206 email address, or to the address in the KohaAdminEmailAddress system
209 C<overdue_notices.pl -n -csv /tmp/overdues.csv> - sends no email and
210 populates F</tmp/overdues.csv> with information about all overdue
213 C<overdue_notices.pl -library MAIN max 14> - prepare notices of
214 overdues in the last 2 weeks for the MAIN library.
218 The F<misc/cronjobs/advance_notices.pl> program allows you to send
219 messages to patrons in advance of thier items becoming due, or to
220 alert them of items that have just become due.
224 # These variables are set by command line options.
225 # They are initially set to default values.
235 my $itemscontent = join( ',', qw( issuedate title barcode author ) );
243 'library=s' => \$mybranch,
244 'csv:s' => \$csvfilename, # this optional argument gets '' if not supplied.
245 'itemscontent=s' => \$itemscontent,
246 'list-all' => \$listall,
247 't|triggered' => \$triggered,
249 pod2usage(1) if $help;
250 pod2usage( -verbose => 2 ) if $man;
252 if ( defined $csvfilename && $csvfilename =~ /^-/ ) {
253 warn qq(using "$csvfilename" as filename, that seems odd);
256 my @branches = C4::Overdues::GetBranchcodesWithOverdueRules();
257 my $branchcount = scalar(@branches);
259 my $branch_word = scalar @branches > 1 ? 'branches' : 'branch';
260 $verbose and warn "Found $branchcount $branch_word with first message enabled: " . join( ', ', map { "'$_'" } @branches ), "\n";
262 die 'No branches with active overduerules';
266 $verbose and warn "Branch $mybranch selected\n";
267 if ( scalar grep { $mybranch eq $_ } @branches ) {
268 @branches = ($mybranch);
270 $verbose and warn "No active overduerules for branch '$mybranch'\n";
271 ( scalar grep { '' eq $_ } @branches )
272 or die "No active overduerules for DEFAULT either!";
273 $verbose and warn "Falling back on default rules for $mybranch\n";
278 # these are the fields that will be substituted into <<item.content>>
279 my @item_content_fields = split( /,/, $itemscontent );
281 my $dbh = C4::Context->dbh();
282 binmode( STDOUT, ":utf8" );
284 our $csv; # the Text::CSV_XS object
285 our $csv_fh; # the filehandle to the CSV file.
286 if ( defined $csvfilename ) {
287 $csv = Text::CSV_XS->new( { binary => 1 } );
288 if ( $csvfilename eq '' ) {
291 open $csv_fh, ">", $csvfilename or die "unable to open $csvfilename: $!";
293 if ( $csv->combine(qw(name surname address1 address2 zipcode city email itemcount itemsinfo)) ) {
294 print $csv_fh $csv->string, "\n";
296 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
300 foreach my $branchcode (@branches) {
301 my $branch_details = C4::Branch::GetBranchDetail($branchcode);
302 my $admin_email_address = $branch_details->{'branchemail'} || C4::Context->preference('KohaAdminEmailAddress');
303 my @output_chunks; # may be sent to mail or stdout or csv file.
305 $verbose and warn sprintf "branchcode : '%s' using %s\n", $branchcode, $admin_email_address;
307 my $sth2 = $dbh->prepare( <<'END_SQL' );
308 SELECT biblio.*, items.*, issues.*, TO_DAYS(NOW())-TO_DAYS(date_due) AS days_overdue
310 LEFT JOIN items USING(itemnumber)
311 LEFT JOIN biblio USING(biblionumber)
312 WHERE issues.borrowernumber = ?
313 AND TO_DAYS(NOW())-TO_DAYS(date_due) BETWEEN ? and ?
316 my $rqoverduerules = $dbh->prepare("SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = ? ");
317 $rqoverduerules->execute($branchcode);
319 # We get default rules is there is no rule for this branch
320 if($rqoverduerules->rows == 0){
321 $rqoverduerules = $dbh->prepare("SELECT * FROM overduerules WHERE delay1 IS NOT NULL AND branchcode = '' ");
322 $rqoverduerules->execute();
325 # my $outfile = 'overdues_' . ( $mybranch || $branchcode || 'default' );
326 while ( my $overdue_rules = $rqoverduerules->fetchrow_hashref ) {
327 PERIOD: foreach my $i ( 1 .. 3 ) {
328 $verbose and warn "branch '$branchcode', pass $i\n";
329 my $mindays = $overdue_rules->{"delay$i"}; # the notice will be sent after mindays days (grace period)
331 $overdue_rules->{ "delay" . ( $i + 1 ) }
332 ? $overdue_rules->{ "delay" . ( $i + 1 ) }
334 ); # issues being more than maxdays late are managed somewhere else. (borrower probably suspended)
336 if ( !$overdue_rules->{"letter$i"} ) {
337 $verbose and warn "No letter$i code for branch '$branchcode'";
341 # $letter->{'content'} is the text of the mail that is sent.
342 # this text contains fields that are replaced by their value. Those fields must be written between brackets
343 # The following fields are available :
344 # 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).
345 # <date> <itemcount> <firstname> <lastname> <address1> <address2> <address3> <city> <postcode>
347 my $borrower_sql = <<'END_SQL';
348 SELECT COUNT(*), issues.borrowernumber, firstname, surname, address, address2, city, zipcode, email, MIN(date_due) as longest_issue
350 LEFT JOIN borrowers USING (borrowernumber)
351 LEFT JOIN categories ON (borrowers.categorycode=categories.categorycode)
354 my @borrower_parameters;
356 $borrower_sql .= ' AND issues.branchcode=? ';
357 push @borrower_parameters, $branchcode;
359 if ( $overdue_rules->{categorycode} ) {
360 $borrower_sql .= ' AND borrowers.categorycode=? ';
361 push @borrower_parameters, $overdue_rules->{categorycode};
363 $borrower_sql .= ' AND categories.overduenoticerequired=1
364 GROUP BY issues.borrowernumber ';
366 $borrower_sql .= ' HAVING TO_DAYS(NOW())-TO_DAYS(longest_issue) = ?';
367 push @borrower_parameters, $mindays;
369 $borrower_sql .= ' HAVING TO_DAYS(NOW())-TO_DAYS(longest_issue) BETWEEN ? and ? ' ;
370 push @borrower_parameters, $mindays, $maxdays;
373 # $sth gets borrower info iff at least one overdue item has triggered the overdue action.
374 my $sth = $dbh->prepare($borrower_sql);
375 $sth->execute(@borrower_parameters);
376 $verbose and warn $borrower_sql . "\n $branchcode | " . $overdue_rules->{'categorycode'} . "\n ($mindays, $maxdays)\nreturns " . $sth->rows . " rows";
378 while( my ( $itemcount, $borrowernumber, $firstname, $lastname, $address1, $address2, $city, $postcode, $email ) = $sth->fetchrow ) {
379 $verbose and warn "borrower $firstname, $lastname ($borrowernumber) has $itemcount items triggering level $i.";
381 my $letter = C4::Letters::getletter( 'circulation', $overdue_rules->{"letter$i"} );
383 $verbose and warn "Message '$overdue_rules->{letter$i}' content not found";
385 # might as well skip while PERIOD, no other borrowers are going to work.
386 # FIXME : Does this mean a letter must be defined in order to trigger a debar ?
390 if ( $overdue_rules->{"debarred$i"} ) {
392 #action taken is debarring
393 C4::Members::DebarMember($borrowernumber);
394 $verbose and warn "debarring $borrowernumber $firstname $lastname\n";
396 $sth2->execute( ($listall) ? ( $borrowernumber , 1 , $MAX ) : ( $borrowernumber, $mindays, $maxdays ) );
399 while ( my $item_info = $sth2->fetchrow_hashref() ) {
400 my @item_info = map { $_ =~ /^date|date$/ ? format_date( $item_info->{$_} ) : $item_info->{$_} || '' } @item_content_fields;
401 $titles .= join("\t", @item_info) . "\n";
406 $letter = parse_letter(
408 borrowernumber => $borrowernumber,
409 branchcode => $branchcode,
411 bib => $branch_details->{'branchname'},
412 'items.content' => $titles
417 my @misses = grep { /./ } map { /^([^>]*)[>]+/; ( $1 || '' ); } split /\</, $letter->{'content'};
419 $verbose and warn "The following terms were not matched and replaced: \n\t" . join "\n\t", @misses;
421 $letter->{'content'} =~ s/\<[^<>]*?\>//g; # Now that we've warned about them, remove them.
422 $letter->{'content'} =~ s/\<[^<>]*?\>//g; # 2nd pass for the double nesting.
427 prepare_letter_for_printing(
429 borrowernumber => $borrowernumber,
430 firstname => $firstname,
431 lastname => $lastname,
432 address1 => $address1,
433 address2 => $address2,
435 postcode => $postcode,
437 itemcount => $itemcount,
439 outputformat => defined $csvfilename ? 'csv' : '',
444 C4::Letters::EnqueueLetter(
446 borrowernumber => $borrowernumber,
447 message_transport_type => 'email',
448 from_address => $admin_email_address,
453 # If we don't have an email address for this patron, send it to the admin to deal with.
455 prepare_letter_for_printing(
457 borrowernumber => $borrowernumber,
458 firstname => $firstname,
459 lastname => $lastname,
460 address1 => $address1,
461 address2 => $address2,
463 postcode => $postcode,
465 itemcount => $itemcount,
467 outputformat => defined $csvfilename ? 'csv' : '',
477 if (@output_chunks) {
479 if ( defined $csvfilename ) {
480 print $csv_fh @output_chunks;
482 local $, = "\f"; # pagebreak
483 print @output_chunks;
487 filename => defined $csvfilename ? 'attachment.csv' : 'attachment.txt',
488 type => 'text/plain',
489 content => join( "\n", @output_chunks )
493 title => 'Overdue Notices',
494 content => 'These messages were not sent directly to the patrons.',
496 C4::Letters::EnqueueLetter(
498 borrowernumber => undef,
499 message_transport_type => 'email',
500 attachments => [$attachment],
501 to_address => $admin_email_address,
510 # note that we're not testing on $csv_fh to prevent closing
515 =head1 INTERNAL METHODS
517 These methods are internal to the operation of overdue_notices.pl.
521 parses the letter template, replacing the placeholders with data
522 specific to this patron, biblio, or item
525 letter - required hashref
526 borrowernumber - required integer
527 substitute - optional hashref of other key/value pairs that should
528 be substituted in the letter content
530 returns the C<letter> hashref, with the content updated to reflect the
531 substituted keys and values.
538 foreach my $required (qw( letter borrowernumber )) {
539 return unless exists $params->{$required};
542 if ( $params->{'substitute'} ) {
543 while ( my ( $key, $replacedby ) = each %{ $params->{'substitute'} } ) {
544 my $replacefield = "<<$key>>";
546 $params->{'letter'}->{title} =~ s/$replacefield/$replacedby/g;
547 $params->{'letter'}->{content} =~ s/$replacefield/$replacedby/g;
551 C4::Letters::parseletter( $params->{'letter'}, 'borrowers', $params->{'borrowernumber'} );
553 if ( $params->{'branchcode'} ) {
554 C4::Letters::parseletter( $params->{'letter'}, 'branches', $params->{'branchcode'} );
557 if ( $params->{'biblionumber'} ) {
558 C4::Letters::parseletter( $params->{'letter'}, 'biblio', $params->{'biblionumber'} );
559 C4::Letters::parseletter( $params->{'letter'}, 'biblioitems', $params->{'biblionumber'} );
562 return $params->{'letter'};
565 =head2 prepare_letter_for_printing
567 returns a string of text appropriate for printing in the event that an
568 overdue notice will not be sent to the patron's email
569 address. Depending on the desired output format, this may be a CSV
570 string, or a human-readable representation of the notice.
581 sub prepare_letter_for_printing {
584 return unless ref $params eq 'HASH';
586 foreach my $required_parameter (qw( letter borrowernumber )) {
587 return unless defined $params->{$required_parameter};
591 if ( exists $params->{'outputformat'} && $params->{'outputformat'} eq 'csv' ) {
593 $params->{'firstname'}, $params->{'lastname'}, $params->{'address1'}, $params->{'address2'}, $params->{'postcode'},
594 $params->{'city'}, $params->{'email'}, $params->{'itemcount'}, $params->{'titles'}
597 return $csv->string, "\n";
599 $verbose and warn 'combine failed on argument: ' . $csv->error_input;
602 $return .= "$params->{'letter'}->{'content'}\n";
604 # $return .= Data::Dumper->Dump( [ $params->{'borrowernumber'}, $params->{'letter'} ], [qw( borrowernumber letter )] );