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 # gets the placeholder message, and enqueues the letter
131 my $letter = getletter( $module, $code );
132 die "No letter found for type $type!... dying\n" unless $letter;
134 # covers basic variable parsing in letter
136 C4::Letters::parseletter( $letter, 'borrowers',
137 $issues->{'borrowernumber'} );
139 C4::Letters::parseletter( $letter, 'biblio',
140 $issues->{'biblionumber'} );
142 C4::Letters::parseletter( $letter, 'biblioitems',
143 $issues->{'biblionumber'} );
147 $message_id = C4::Letters::EnqueueLetter(
150 borrowernumber => $issues->{'borrowernumber'},
151 message_transport_type => 'phone',
157 "\"$format\",\"$language\",\"$type\",\"$issues->{level}\",\"$issues->{cardnumber}\",\"$issues->{patron_title}\",\"$issues->{firstname}\",";
159 "\"$issues->{surname}\",\"$issues->{phone}\",\"$issues->{email}\",\"$library_code\",";
161 "\"$issues->{site}\",\"$issues->{site_name}\",\"$issues->{barcode}\",\"$due_date\",\"$issues->{title}\",\"$message_id\"\n";
167 TalkingTech_itiva_outbound.pl
171 TalkingTech_itiva_outbound.pl
172 TalkingTech_itiva_outbound.pl --type=OVERDUE -w 0 -w 2 -w 6 --output=/tmp/talkingtech/outbound.csv
173 TalkingTech_itiva_outbound.pl --type=RESERVE --type=PREOVERDUE --lang=FR
176 Script to generate Spec C outbound notifications file for Talking Tech i-tiva
177 phone notification system.
179 =item B<--help> B<-h>
185 Provide verbose log information.
187 =item B<--output> B<-o>
189 Destination for outbound notifications file (CSV format). If no value is specified,
190 output is dumped to screen.
194 Sets the language for all outbound messages. Currently supported values are EN, FR and ES.
195 If no value is specified, EN will be used by default.
199 REQUIRED. Sets which messaging types are to be used. Can be given multiple times, to
200 specify multiple types in a single output file. Currently supported values are RESERVE, PREOVERDUE
201 and OVERDUE. If no value is given, this script will not produce any outbound notifications.
203 =item B<--waiting-hold-day> B<-w>
205 OPTIONAL for --type=RESERVE. Sets the days after a hold has been set to waiting on which to call. Use
206 switch as many times as desired. For example, passing "-w 0 -w 2 -w 6" will cause calls to be placed
207 on the day the hold was set to waiting, 2 days after the waiting date, and 6 days after. See example above.
208 If this switch is not used with --type=RESERVE, calls will be placed every day until the waiting reserve
209 is picked up or canceled.
211 =item B<--library-code> B<--code> B<-c>
214 The code of the source library of the message.
215 The library code is used to group notices together for
216 consortium purposes and apply library specific settings, such as
217 prompts, to those notices.
218 This field can be blank if all messages are from a single library.
222 sub GetOverdueIssues {
224 "SELECT borrowers.borrowernumber, borrowers.cardnumber, borrowers.title as patron_title, borrowers.firstname, borrowers.surname,
225 borrowers.phone, borrowers.email, borrowers.branchcode, biblio.biblionumber, biblio.title, items.barcode, issues.date_due,
226 max(overduerules.branchcode) as rulebranch, TO_DAYS(NOW())-TO_DAYS(date_due) as daysoverdue, delay1, delay2, delay3,
227 issues.branchcode as site, branches.branchname as site_name
228 FROM borrowers JOIN issues USING (borrowernumber)
229 JOIN items USING (itemnumber)
230 JOIN biblio USING (biblionumber)
231 JOIN branches ON (issues.branchcode = branches.branchcode)
232 JOIN overduerules USING (categorycode)
233 WHERE ( overduerules.branchcode = borrowers.branchcode or overduerules.branchcode = '')
234 AND ( (TO_DAYS(NOW())-TO_DAYS(date_due) ) = delay1
235 OR (TO_DAYS(NOW())-TO_DAYS(date_due) ) = delay2
236 OR (TO_DAYS(NOW())-TO_DAYS(date_due) ) = delay3 )
237 GROUP BY items.itemnumber
239 my $sth = $dbh->prepare($query);
242 while ( my $issue = $sth->fetchrow_hashref() ) {
243 if ( $issue->{'daysoverdue'} == $issue->{'delay1'} ) {
244 $issue->{'level'} = 1;
246 elsif ( $issue->{'daysoverdue'} == $issue->{'delay2'} ) {
247 $issue->{'level'} = 2;
249 elsif ( $issue->{'daysoverdue'} == $issue->{'delay3'} ) {
250 $issue->{'level'} = 3;
254 # this shouldn't ever happen, based our SQL criteria
256 push @results, $issue;
261 sub GetPredueIssues {
263 "SELECT borrowers.borrowernumber, borrowers.cardnumber, borrowers.title as patron_title, borrowers.firstname, borrowers.surname,
264 borrowers.phone, borrowers.email, borrowers.branchcode, biblio.biblionumber, biblio.title, items.barcode, issues.date_due,
265 issues.branchcode as site, branches.branchname as site_name
266 FROM borrowers JOIN issues USING (borrowernumber)
267 JOIN items USING (itemnumber)
268 JOIN biblio USING (biblionumber)
269 JOIN branches ON (issues.branchcode = branches.branchcode)
270 JOIN borrower_message_preferences USING (borrowernumber)
271 JOIN borrower_message_transport_preferences USING (borrower_message_preference_id)
272 JOIN message_attributes USING (message_attribute_id)
273 WHERE ( TO_DAYS( date_due ) - TO_DAYS( NOW() ) ) = days_in_advance
274 AND message_transport_type = 'phone'
275 AND message_name = 'Advance_Notice'
277 my $sth = $dbh->prepare($query);
280 while ( my $issue = $sth->fetchrow_hashref() ) {
281 $issue->{'level'} = 1; # only one level for Predue notifications
282 push @results, $issue;
287 sub GetWaitingHolds {
289 "SELECT borrowers.borrowernumber, borrowers.cardnumber, borrowers.title as patron_title, borrowers.firstname, borrowers.surname,
290 borrowers.phone, borrowers.email, borrowers.branchcode, biblio.biblionumber, biblio.title, items.barcode, reserves.waitingdate,
291 reserves.branchcode AS site, branches.branchname AS site_name,
292 TO_DAYS(NOW())-TO_DAYS(reserves.waitingdate) AS days_since_waiting
293 FROM borrowers JOIN reserves USING (borrowernumber)
294 JOIN items USING (itemnumber)
295 JOIN biblio ON (biblio.biblionumber = items.biblionumber)
296 JOIN branches ON (reserves.branchcode = branches.branchcode)
297 JOIN borrower_message_preferences USING (borrowernumber)
298 JOIN borrower_message_transport_preferences USING (borrower_message_preference_id)
299 JOIN message_attributes USING (message_attribute_id)
300 WHERE ( reserves.found = 'W' )
301 AND message_transport_type = 'phone'
302 AND message_name = 'Hold_Filled'
304 my $pickupdelay = C4::Context->preference("ReservesMaxPickUpDelay");
305 my $sth = $dbh->prepare($query);
308 while ( my $issue = $sth->fetchrow_hashref() ) {
309 my @waitingdate = split( /-/, $issue->{'waitingdate'} );
311 Add_Delta_Days( $waitingdate[0], $waitingdate[1], $waitingdate[2],
313 $issue->{'date_due'} =
314 sprintf( "%04d-%02d-%02d", $date_due[0], $date_due[1], $date_due[2] );
315 $issue->{'level'} = 1; # only one level for Hold Waiting notifications
317 my $days_to_subtract = 0;
318 my $calendar = C4::Calendar->new( branchcode => $issue->{'site'} );
320 $calendar->isHoliday(
323 $waitingdate[0], $waitingdate[1],
324 $waitingdate[2], $days_to_subtract
332 $issue->{'days_since_waiting'} =
333 $issue->{'days_since_waiting'} - $days_to_subtract;
337 grep $_ eq $issue->{'days_since_waiting'},
338 @holds_waiting_days_to_call
340 || !scalar(@holds_waiting_days_to_call)
343 push @results, $issue;