3 # Copyright (C) 2011 ByWater Solutions
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.
25 # find Koha's Perl modules
26 # test carefully before changing this
28 eval { require "$FindBin::Bin/../kohalib.pl" };
33 use Date::Calc qw(Add_Delta_Days);
43 pod2usage( -verbose => 2 );
48 "TalkingTechItivaPhoneNotification system preference not activated... dying\n"
49 unless ( C4::Context->preference("TalkingTechItivaPhoneNotification") );
52 my $dbh = C4::Context->dbh;
58 my @holds_waiting_days_to_call;
63 # maps to convert I-tiva terms to Koha terms
64 my $type_module_map = {
65 'PREOVERDUE' => 'circulation',
66 'OVERDUE' => 'circulation',
67 'RESERVE' => 'reserves',
70 my $type_notice_map = {
71 'PREOVERDUE' => 'PREDUE_PHONE',
72 'OVERDUE' => 'OVERDUE_PHONE',
73 'RESERVE' => 'HOLD_PHONE',
77 'o|output:s' => \$outfile,
79 'lang:s' => \$language,
81 'w|waiting-hold-day:s' => \@holds_waiting_days_to_call,
82 'c|code|library-code:s' => \$library_code,
86 $language = uc($language);
89 pod2usage( -verbose => 1 ) if $help;
91 # output log or STDOUT
93 if ( defined $outfile ) {
94 open( $OUT, '>', "$outfile" ) || die("Cannot open output file");
97 print "No output file defined; printing to STDOUT\n"
98 if ( defined $verbose );
99 open( $OUT, '>', "&STDOUT" ) || die("Couldn't duplicate STDOUT: $!");
102 my $format = 'V'; # format for phone notifications
104 foreach my $type (@types) {
105 $type = uc($type); #just in case lower or mixed-case was supplied
107 $type_module_map->{$type}; #since the module is required to get the letter
108 my $code = $type_notice_map->{$type}; #to get the Koha name of the notice
111 if ( $type eq 'OVERDUE' ) {
112 @loop = GetOverdueIssues();
114 elsif ( $type eq 'PREOVERDUE' ) {
115 @loop = GetPredueIssues();
117 elsif ( $type eq 'RESERVE' ) {
118 @loop = GetWaitingHolds();
121 print "Unknown or unsupported message type $type; skipping...\n"
122 if ( defined $verbose );
126 foreach my $issues (@loop) {
127 my $date = C4::Dates->new( $issues->{'date_due'}, 'iso' );
128 my $due_date = $date->output('metric');
130 my $letter = C4::Letters::GetPreparedLetter(
132 letter_code => $code,
134 borrowers => $issues->{'borrowernumber'},
135 biblio => $issues->{'biblionumber'},
136 biblioitems => $issues->{'biblionumber'}
140 die "No letter found for type $type!... dying\n" unless $letter;
144 $message_id = C4::Letters::EnqueueLetter(
147 borrowernumber => $issues->{'borrowernumber'},
148 message_transport_type => 'phone',
154 "\"$format\",\"$language\",\"$type\",\"$issues->{level}\",\"$issues->{cardnumber}\",\"$issues->{patron_title}\",\"$issues->{firstname}\",";
156 "\"$issues->{surname}\",\"$issues->{phone}\",\"$issues->{email}\",\"$library_code\",";
158 "\"$issues->{site}\",\"$issues->{site_name}\",\"$issues->{barcode}\",\"$due_date\",\"$issues->{title}\",\"$message_id\"\n";
164 TalkingTech_itiva_outbound.pl
168 TalkingTech_itiva_outbound.pl
169 TalkingTech_itiva_outbound.pl --type=OVERDUE -w 0 -w 2 -w 6 --output=/tmp/talkingtech/outbound.csv
170 TalkingTech_itiva_outbound.pl --type=RESERVE --type=PREOVERDUE --lang=FR
173 Script to generate Spec C outbound notifications file for Talking Tech i-tiva
174 phone notification system.
176 =item B<--help> B<-h>
182 Provide verbose log information.
184 =item B<--output> B<-o>
186 Destination for outbound notifications file (CSV format). If no value is specified,
187 output is dumped to screen.
191 Sets the language for all outbound messages. Currently supported values are EN, FR and ES.
192 If no value is specified, EN will be used by default.
196 REQUIRED. Sets which messaging types are to be used. Can be given multiple times, to
197 specify multiple types in a single output file. Currently supported values are RESERVE, PREOVERDUE
198 and OVERDUE. If no value is given, this script will not produce any outbound notifications.
200 =item B<--waiting-hold-day> B<-w>
202 OPTIONAL for --type=RESERVE. Sets the days after a hold has been set to waiting on which to call. Use
203 switch as many times as desired. For example, passing "-w 0 -w 2 -w 6" will cause calls to be placed
204 on the day the hold was set to waiting, 2 days after the waiting date, and 6 days after. See example above.
205 If this switch is not used with --type=RESERVE, calls will be placed every day until the waiting reserve
206 is picked up or canceled.
208 =item B<--library-code> B<--code> B<-c>
211 The code of the source library of the message.
212 The library code is used to group notices together for
213 consortium purposes and apply library specific settings, such as
214 prompts, to those notices.
215 This field can be blank if all messages are from a single library.
219 sub GetOverdueIssues {
221 "SELECT borrowers.borrowernumber, borrowers.cardnumber, borrowers.title as patron_title, borrowers.firstname, borrowers.surname,
222 borrowers.phone, borrowers.email, borrowers.branchcode, biblio.biblionumber, biblio.title, items.barcode, issues.date_due,
223 max(overduerules.branchcode) as rulebranch, TO_DAYS(NOW())-TO_DAYS(date_due) as daysoverdue, delay1, delay2, delay3,
224 issues.branchcode as site, branches.branchname as site_name
225 FROM borrowers JOIN issues USING (borrowernumber)
226 JOIN items USING (itemnumber)
227 JOIN biblio USING (biblionumber)
228 JOIN branches ON (issues.branchcode = branches.branchcode)
229 JOIN overduerules USING (categorycode)
230 WHERE ( overduerules.branchcode = borrowers.branchcode or overduerules.branchcode = '')
231 AND ( (TO_DAYS(NOW())-TO_DAYS(date_due) ) = delay1
232 OR (TO_DAYS(NOW())-TO_DAYS(date_due) ) = delay2
233 OR (TO_DAYS(NOW())-TO_DAYS(date_due) ) = delay3 )
234 GROUP BY items.itemnumber
236 my $sth = $dbh->prepare($query);
239 while ( my $issue = $sth->fetchrow_hashref() ) {
240 if ( $issue->{'daysoverdue'} == $issue->{'delay1'} ) {
241 $issue->{'level'} = 1;
243 elsif ( $issue->{'daysoverdue'} == $issue->{'delay2'} ) {
244 $issue->{'level'} = 2;
246 elsif ( $issue->{'daysoverdue'} == $issue->{'delay3'} ) {
247 $issue->{'level'} = 3;
251 # this shouldn't ever happen, based our SQL criteria
253 push @results, $issue;
258 sub GetPredueIssues {
260 "SELECT borrowers.borrowernumber, borrowers.cardnumber, borrowers.title as patron_title, borrowers.firstname, borrowers.surname,
261 borrowers.phone, borrowers.email, borrowers.branchcode, biblio.biblionumber, biblio.title, items.barcode, issues.date_due,
262 issues.branchcode as site, branches.branchname as site_name
263 FROM borrowers JOIN issues USING (borrowernumber)
264 JOIN items USING (itemnumber)
265 JOIN biblio USING (biblionumber)
266 JOIN branches ON (issues.branchcode = branches.branchcode)
267 JOIN borrower_message_preferences USING (borrowernumber)
268 JOIN borrower_message_transport_preferences USING (borrower_message_preference_id)
269 JOIN message_attributes USING (message_attribute_id)
270 WHERE ( TO_DAYS( date_due ) - TO_DAYS( NOW() ) ) = days_in_advance
271 AND message_transport_type = 'phone'
272 AND message_name = 'Advance_Notice'
274 my $sth = $dbh->prepare($query);
277 while ( my $issue = $sth->fetchrow_hashref() ) {
278 $issue->{'level'} = 1; # only one level for Predue notifications
279 push @results, $issue;
284 sub GetWaitingHolds {
286 "SELECT borrowers.borrowernumber, borrowers.cardnumber, borrowers.title as patron_title, borrowers.firstname, borrowers.surname,
287 borrowers.phone, borrowers.email, borrowers.branchcode, biblio.biblionumber, biblio.title, items.barcode, reserves.waitingdate,
288 reserves.branchcode AS site, branches.branchname AS site_name,
289 TO_DAYS(NOW())-TO_DAYS(reserves.waitingdate) AS days_since_waiting
290 FROM borrowers JOIN reserves USING (borrowernumber)
291 JOIN items USING (itemnumber)
292 JOIN biblio ON (biblio.biblionumber = items.biblionumber)
293 JOIN branches ON (reserves.branchcode = branches.branchcode)
294 JOIN borrower_message_preferences USING (borrowernumber)
295 JOIN borrower_message_transport_preferences USING (borrower_message_preference_id)
296 JOIN message_attributes USING (message_attribute_id)
297 WHERE ( reserves.found = 'W' )
298 AND message_transport_type = 'phone'
299 AND message_name = 'Hold_Filled'
301 my $pickupdelay = C4::Context->preference("ReservesMaxPickUpDelay");
302 my $sth = $dbh->prepare($query);
305 while ( my $issue = $sth->fetchrow_hashref() ) {
306 my @waitingdate = split( /-/, $issue->{'waitingdate'} );
308 Add_Delta_Days( $waitingdate[0], $waitingdate[1], $waitingdate[2],
310 $issue->{'date_due'} =
311 sprintf( "%04d-%02d-%02d", $date_due[0], $date_due[1], $date_due[2] );
312 $issue->{'level'} = 1; # only one level for Hold Waiting notifications
314 my $days_to_subtract = 0;
315 my $calendar = C4::Calendar->new( branchcode => $issue->{'site'} );
317 $calendar->isHoliday(
320 $waitingdate[0], $waitingdate[1],
321 $waitingdate[2], $days_to_subtract
329 $issue->{'days_since_waiting'} =
330 $issue->{'days_since_waiting'} - $days_to_subtract;
334 grep $_ eq $issue->{'days_since_waiting'},
335 @holds_waiting_days_to_call
337 || !scalar(@holds_waiting_days_to_call)
340 push @results, $issue;