updating page-numbers.inc for OPAC
[koha.git] / misc / overduenotices-30.pl
1 #!/usr/bin/perl -w
2 #-----------------------------------
3 # Script Name: overduenotices.pl
4 # Script Version: 1.0
5 # Date:  2003/9/7
6 # Author:  Stephen Hedges (shedges@skemotah.com)
7 # modified by Paul Poulain (paul@koha-fr.org)
8 # modified by Henri-Damien LAURENT (henridamien@koha-fr.org)
9 # Description: 
10 #       This script runs a Koha report of items using overduerules tables and letters tool management.
11 # Revision History:
12 #    1.0  2003/9/7: original version
13 #    1.5  2006/2/28: Modifications for managing Letters and overduerules
14 #-----------------------------------
15 # Copyright 2003 Skemotah Solutions
16 #
17 # This file is part of Koha.
18 #
19 # Koha is free software; you can redistribute it and/or modify it under the
20 # terms of the GNU General Public License as published by the Free Software
21 # Foundation; either version 2 of the License, or (at your option) any later
22 # version.
23 #
24 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
25 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
26 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
27 #
28 # You should have received a copy of the GNU General Public License along with
29 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
30 # Suite 330, Boston, MA  02111-1307 USA
31
32 use strict;
33 use C4::Context;
34 use C4::Date;
35 use Mail::Sendmail;  # comment out if not doing e-mail notices
36 use Getopt::Long;
37
38 my ($confirm, $nomail, $mybranch, $myborcat,$myborcatout, $letter, $MAX, $choice);
39 GetOptions(
40     'c'    => \$confirm,
41     'n' => \$nomail,
42     'max=s'     => \$MAX,
43     'all'       => \$choice,
44 );
45 unless ($confirm) {
46         print qq|
47 This script will send overdue notices by e-mail and prepare a file of\nnotices for printing if the borrower does not have e-mail.
48 You MUST edit this script for your library BEFORE you run it for the first time!
49 See the comments in the script for directions on changing the script.
50 This script has 2 parameters :
51         -c to confirm and remove this help & warning
52         -n to avoid sending any mail. Instead, all mail messages are printed on screen. Usefull for testing purposes.
53         -branch <branchcode> to select overdues for ONE specific branch.
54         -borcat <borcatcode> to select overdues for one borrower category,
55         -borcatout <borcatcode> to exclude this borrower category from overdunotices,
56         -max <MAX> MAXIMUM day count before stopping to send overdue notice,
57         -file <filename> to enter a specific filename to be read for message.
58         -all to include ALL the items that reader borrowed.
59
60 Do you wish to continue? (y/n)
61 |;
62         chomp($_ = <STDIN>);
63         exit unless (/^(y|Y|o|O)/i);  # comment these lines out once you've made the changes
64         
65 }
66 my $dbh = C4::Context->dbh;
67 my $rqoverduebranches=$dbh->prepare("SELECT DISTINCT branchcode FROM overduerules WHERE delay1>0");
68 $rqoverduebranches->execute;
69 while (my ($branchcode)=$rqoverduebranches->fetchrow){
70     warn "branchcode : $branchcode";
71     my $branchname;
72     my $emailaddress;
73     if ($branchcode){
74         my $rqbranch=$dbh->prepare("SELECT * FROM branches WHERE branchcode = ?");
75         $rqbranch->execute($branchcode);
76         my $data = $rqbranch->fetchrow_hashref;
77         $emailaddress = $data->{branchemail};
78         $branchname = $data->{branchname};
79     }
80     $emailaddress=C4::Context->preference('KohaAdminEmailAddress') unless ($emailaddress);
81
82     #print STDERR "$emailaddress\n";
83     #
84     # BEGINNING OF PARAMETERS
85     #
86     my $rqoverduerules=$dbh->prepare("SELECT * FROM overduerules WHERE delay1>0 and branchcode = ?");
87     $rqoverduerules->execute($branchcode);
88     while (my $data=$rqoverduerules->fetchrow_hashref){
89         for (my $i=1; $i<=3;$i++){
90             #Two actions :
91             # A- Send a letter
92             # B- Debar
93             my $mindays = $data->{"delay$i"}; # the notice will be sent after mindays days (grace period)
94             my $rqdebarring=$dbh->prepare("UPDATE borrowers SET debarred=1 WHERE borrowernumber=?") if $data->{"debarred$i"};
95             my $maxdays = ($data->{"delay".($i+1)}?
96                             $data->{"delay".($i+1)}
97                             :($MAX?$MAX:365)); # issues being more than maxdays late are managed somewhere else. (borrower probably suspended)
98             #LETTER parameters
99             my $smtpserver = 'smtp.wanadoo.fr'; # your smtp server (the server who sent mails)
100             my $from = $emailaddress; # all the mails sent to the borrowers will appear coming from here.
101             my $mailtitle = 'Overdue'; # the title of the mails
102             $mailtitle = 'Issue status' if ($choice); # the title of the mails
103             my $librarymail = $emailaddress; # all notices without mail are sent (in 1 mail) to this mail address. They must then be managed manually.
104             my $letter = $data->{"letter$i"} if $data->{"letter$i"};
105             # this parameter (the last) is the text of the mail that is sent.
106             # this text contains fields that are replaced by their value. Those fields must be written between brackets
107             # The following fields are available :
108             # <date> <itemcount> <firstname> <lastname> <address1> <address2> <address3> <city> <postcode>
109             my $mailtext=$letter;
110             #
111             # END OF PARAMETERS
112             #
113             open OUTFILE, ">overdues" or die "Cannot open file overdues: $!";
114             
115             # set the e-mail server -- comment out if not doing e-mail notices
116             unshift @{$Mail::Sendmail::mailcfg{'smtp'}} , $smtpserver;
117             # set your own mail server name here
118             
119             my $strsth = "SELECT COUNT(*), issues.borrowernumber,firstname,surname,address,address2,city,zipcode, email, MIN(date_due) as longest_issue FROM issues,borrowers,categories WHERE returndate IS NULL AND issues.borrowernumber=borrowers.borrowernumber AND borrowers.categorycode=categories.categorycode ";
120             $strsth .= " AND issues.branchcode='".$branchcode."' " if ($branchcode);
121             $strsth .= " AND borrowers.categorycode='".$data->{categorycode}."' " if ($data->{categorycode});
122             $strsth .= " AND categories.overduenoticerequired=1 GROUP BY issues.borrowernumber HAVING TO_DAYS(NOW())-TO_DAYS(longest_issue) BETWEEN $mindays and $maxdays ";
123             my $sth = $dbh->prepare ($strsth);
124 #             warn "".$strsth;
125             my $sth2 = $dbh->prepare("SELECT biblio.title,biblio.author,items.barcode, issues.timestamp FROM issues,items,biblio WHERE items.itemnumber=issues.itemnumber and biblio.biblionumber=items.biblionumber AND issues.borrowernumber=? AND returndate IS NULL AND TO_DAYS(NOW())-TO_DAYS(date_due) BETWEEN $mindays and $maxdays");
126
127             $sth->execute;
128             # 
129             # my $itemcount = 0;
130             # my $row;
131             my $count = 0;   # to keep track of how many notices are printed
132             my $e_count = 0;   # and e-mailed
133             my $date=format_date(localtime);
134             my ($itemcount,$borrowernumber,$firstname,$lastname,$address1,$address2,$city,$postcode,$email);
135             
136             while (($itemcount, $borrowernumber, $firstname, $lastname, $address1, $address2, $city, $postcode, $email) = $sth->fetchrow) {
137                 if ($data->{"debarred$i"}){
138                     #action taken is debarring
139                     $rqdebarring->execute($borrowernumber);
140                     warn "debarring $borrowernumber $firstname $lastname";
141                 }
142                 if ($letter){
143                     my $notice .= $mailtext;
144                     $notice =~ s/\<itemcount\>/$itemcount/g if ($itemcount);
145                     $notice =~ s/\<firstname\>/$firstname/g if ($firstname);
146                     $notice =~ s/\<lastname\>/$lastname/g if ($lastname);
147                     $notice =~ s/\<address1\>/$address1/g if ($address1);
148                     $notice =~ s/\<address2\>/$address2/g if ($address2);
149                     $notice =~ s/\<city\>/$city/g if ($city);
150                     $notice =~ s/\<postcode\>/$postcode/g if ($postcode);
151                     $notice =~ s/\<date\>/$date/g if ($date);
152                     $notice =~ s/\<bib\>/$branchname/g if ($branchname);
153     
154                     $sth2->execute($borrowernumber);
155                     my $titles="";
156                     my ($title, $author, $barcode, $issuedate);
157                     while (($title, $author, $barcode,$issuedate) = $sth2->fetchrow){
158                             $titles .= "        ".format_date($issuedate)."     ".($barcode?$barcode:"")."      ".($title?$title:"")."  ".($author?$author:"")."\n";
159                     }
160                     $notice =~ s/\<titles\>/$titles/g;
161                     $sth2->finish;
162                     # if not using e-mail notices, comment out the following lines
163                     if ($email) {   # or you might check for borrowers.preferredcont 
164                         if ($nomail) {
165                             print "TO => $email\n";
166                             print "FROM => $from\n";
167                             print "SUBJECT => $mailtitle\n";
168                             print "MESSAGE => $notice\n";
169                         } else {
170                             my %mail = ( To      => $email,
171                                         From    => $from,
172                                         Subject => $mailtitle,
173                                         Message => $notice,
174                                     );
175                             sendmail(%mail);
176                         }
177                         $e_count++
178                     } else {
179                         print OUTFILE $notice;
180                         $count++;
181                     }    # and comment this one out, too, if not using e-mail
182                 }
183             }
184             $sth->finish;
185             close OUTFILE;
186             # if some notices have to be printed & managed by the library, send them to library mail address.
187             if ($count) {
188                 open ODUES, "overdues" or die "Cannot open file overdues: $!";
189                 my $notice = "$e_count overdue notices e-mailed\n";
190                 $notice .= "$count overdue notices in file for printing\n\n";
191
192                 $notice .= <ODUES>;
193                 if ($nomail) {
194                     print "TO => $email\n" if $email;
195                     print "FROM => $from\n";
196                     print "SUBJECT => Koha overdue\n";
197                     print "MESSAGE => $notice\n";
198                 } else {
199                     my %mail = (To      => $email,
200                                 From    => $from,
201                                 Subject => 'Koha overdues',
202                                 Message => $notice,
203                             );
204                     sendmail(%mail);
205                 }
206             }
207         }
208     }
209 }