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
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use Getopt::Long qw( GetOptions );
24 use Pod::Usage qw( pod2usage );
26 use Koha::Script -cron;
31 use Koha::DateUtils qw( dt_from_string output_pref );
36 pod2usage( -verbose => 2 );
40 die "TalkingTechItivaPhoneNotification system preference not activated... dying\n"
41 unless ( C4::Context->preference("TalkingTechItivaPhoneNotification") );
44 my $dbh = C4::Context->dbh;
50 my @holds_waiting_days_to_call;
54 my $skip_patrons_with_email;
55 my $patron_branchcode;
57 # maps to convert I-tiva terms to Koha terms
58 my $type_module_map = {
59 'PREOVERDUE' => 'circulation',
60 'OVERDUE' => 'circulation',
61 'RESERVE' => 'reserves',
64 my $type_notice_map = {
65 'PREOVERDUE' => 'PREDUE',
66 'OVERDUE' => 'OVERDUE',
71 'o|output:s' => \$outfile,
73 'lang:s' => \$language,
75 'w|waiting-hold-day:s' => \@holds_waiting_days_to_call,
76 'c|code|library-code:s' => \$library_code,
77 's|skip-patrons-with-email' => \$skip_patrons_with_email,
78 'pb|patron-branchcode:s' => \$patron_branchcode,
82 $language = uc($language);
85 pod2usage( -verbose => 1 ) if $help;
87 if ($patron_branchcode) {
88 die("Invalid branchcode '$patron_branchcode' passed in -pb --patron-branchcode parameter")
89 unless Koha::Libraries->search( { branchcode => $patron_branchcode } )->count;
92 # output log or STDOUT
94 if ( defined $outfile ) {
95 open( $OUT, '>', "$outfile" ) || die("Cannot open output file");
97 print "No output file defined; printing to STDOUT\n"
98 if ( defined $verbose );
99 $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
106 my $module = $type_module_map->{$type}; #since the module is required to get the letter
107 my $code = $type_notice_map->{$type}; #to get the Koha name of the notice
110 if ( $type eq 'OVERDUE' ) {
111 @loop = GetOverdueIssues( $patron_branchcode );
112 } elsif ( $type eq 'PREOVERDUE' ) {
113 @loop = GetPredueIssues( $patron_branchcode );
114 } elsif ( $type eq 'RESERVE' ) {
115 @loop = GetWaitingHolds( $patron_branchcode );
117 print "Unknown or unsupported message type $type; skipping...\n"
118 if ( defined $verbose );
123 foreach my $issues (@loop) {
124 $patrons->{$issues->{borrowernumber}} ||= Koha::Patrons->find( $issues->{borrowernumber} ) if $skip_patrons_with_email;
125 next if $skip_patrons_with_email && $patrons->{$issues->{borrowernumber}}->notice_email_address;
127 my $date_dt = dt_from_string ( $issues->{'date_due'} );
128 my $due_date = output_pref( { dt => $date_dt, dateonly => 1, dateformat =>'metric' } );
130 my $letter = C4::Letters::GetPreparedLetter(
132 letter_code => $code,
133 lang => 'default', # It does not sound useful to send a lang here
135 borrowers => $issues->{'borrowernumber'},
136 biblio => $issues->{'biblionumber'},
137 biblioitems => $issues->{'biblionumber'},
139 message_transport_type => 'itiva',
142 die "No letter found for type $type!... dying\n" unless $letter;
146 $message_id = C4::Letters::EnqueueLetter(
148 borrowernumber => $issues->{'borrowernumber'},
149 message_transport_type => 'itiva',
154 $issues->{title} =~ s/'//g;
155 $issues->{title} =~ s/"//g;
157 print $OUT "\"$format\",\"$language\",\"$type\",\"$issues->{level}\",\"$issues->{cardnumber}\",\"$issues->{patron_title}\",\"$issues->{firstname}\",";
158 print $OUT "\"$issues->{surname}\",\"$issues->{phone}\",\"$issues->{email}\",\"$library_code\",";
159 print $OUT "\"$issues->{site}\",\"$issues->{site_name}\",\"$issues->{barcode}\",\"$due_date\",\"$issues->{title}\",\"$message_id\"\n";
165 TalkingTech_itiva_outbound.pl
169 TalkingTech_itiva_outbound.pl
170 TalkingTech_itiva_outbound.pl --type=OVERDUE -w 0 -w 2 -w 6 --output=/tmp/talkingtech/outbound.csv
171 TalkingTech_itiva_outbound.pl --type=RESERVE --type=PREOVERDUE --lang=FR
174 Script to generate Spec C outbound notifications file for Talking Tech i-tiva
175 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.
220 =item B<--patron-branchcode> B<--pb>
224 Limits the the patrons to generate notices for based on the patron's home library.
225 Items and holds from other libraries will still be included for the given patron.
231 sub GetOverdueIssues {
232 my ( $patron_branchcode ) = @_;
234 my $patron_branchcode_filter = $patron_branchcode ? "AND borrowers.branchcode = '$patron_branchcode'" : q{};
236 my $query = "SELECT borrowers.borrowernumber, borrowers.cardnumber, borrowers.title as patron_title, borrowers.firstname, borrowers.surname,
237 borrowers.phone, borrowers.email, borrowers.branchcode, biblio.biblionumber, biblio.title, items.barcode, issues.date_due,
238 max(overduerules.branchcode) as rulebranch, TO_DAYS(NOW())-TO_DAYS(date_due) as daysoverdue, delay1, delay2, delay3,
239 issues.branchcode as site, branches.branchname as site_name
240 FROM borrowers JOIN issues USING (borrowernumber)
241 JOIN items USING (itemnumber)
242 JOIN biblio USING (biblionumber)
243 JOIN branches ON (issues.branchcode = branches.branchcode)
244 JOIN overduerules USING (categorycode)
245 JOIN overduerules_transport_types USING ( overduerules_id )
246 WHERE ( overduerules.branchcode = borrowers.branchcode or overduerules.branchcode = '')
247 AND overduerules_transport_types.message_transport_type = 'itiva'
248 AND ( (TO_DAYS(NOW())-TO_DAYS(date_due) ) = delay1
249 OR (TO_DAYS(NOW())-TO_DAYS(date_due) ) = delay2
250 OR (TO_DAYS(NOW())-TO_DAYS(date_due) ) = delay3 )
251 $patron_branchcode_filter
252 GROUP BY items.itemnumber
254 my $sth = $dbh->prepare($query);
257 while ( my $issue = $sth->fetchrow_hashref() ) {
258 if ( $issue->{'daysoverdue'} == $issue->{'delay1'} ) {
259 $issue->{'level'} = 1;
260 } elsif ( $issue->{'daysoverdue'} == $issue->{'delay2'} ) {
261 $issue->{'level'} = 2;
262 } elsif ( $issue->{'daysoverdue'} == $issue->{'delay3'} ) {
263 $issue->{'level'} = 3;
266 # this shouldn't ever happen, based our SQL criteria
268 push @results, $issue;
273 sub GetPredueIssues {
274 my ( $patron_branchcode ) = @_;
276 my $patron_branchcode_filter = $patron_branchcode ? "AND borrowers.branchcode = '$patron_branchcode'" : q{};
278 my $query = "SELECT borrowers.borrowernumber, borrowers.cardnumber, borrowers.title as patron_title, borrowers.firstname, borrowers.surname,
279 borrowers.phone, borrowers.email, borrowers.branchcode, biblio.biblionumber, biblio.title, items.barcode, issues.date_due,
280 issues.branchcode as site, branches.branchname as site_name
281 FROM borrowers JOIN issues USING (borrowernumber)
282 JOIN items USING (itemnumber)
283 JOIN biblio USING (biblionumber)
284 JOIN branches ON (issues.branchcode = branches.branchcode)
285 JOIN borrower_message_preferences USING (borrowernumber)
286 JOIN borrower_message_transport_preferences USING (borrower_message_preference_id)
287 JOIN message_attributes USING (message_attribute_id)
288 WHERE ( TO_DAYS( date_due ) - TO_DAYS( NOW() ) ) = days_in_advance
289 AND message_transport_type = 'itiva'
290 AND message_name = 'Advance_Notice'
291 $patron_branchcode_filter
293 my $sth = $dbh->prepare($query);
296 while ( my $issue = $sth->fetchrow_hashref() ) {
297 $issue->{'level'} = 1; # only one level for Predue notifications
298 push @results, $issue;
303 sub GetWaitingHolds {
304 my ( $patron_branchcode ) = @_;
306 my $patron_branchcode_filter = $patron_branchcode ? "AND borrowers.branchcode = '$patron_branchcode'" : q{};
308 my $query = "SELECT borrowers.borrowernumber, borrowers.cardnumber, borrowers.title as patron_title, borrowers.firstname, borrowers.surname, borrowers.categorycode,
309 borrowers.phone, borrowers.email, borrowers.branchcode, biblio.biblionumber, biblio.title, items.barcode, reserves.waitingdate,
310 reserves.branchcode AS site, branches.branchname AS site_name,
311 TO_DAYS(NOW())-TO_DAYS(reserves.waitingdate) AS days_since_waiting,
312 reserves.expirationdate
313 FROM borrowers JOIN reserves USING (borrowernumber)
314 JOIN items USING (itemnumber)
315 JOIN biblio ON (biblio.biblionumber = items.biblionumber)
316 JOIN branches ON (reserves.branchcode = branches.branchcode)
317 JOIN borrower_message_preferences USING (borrowernumber)
318 JOIN borrower_message_transport_preferences USING (borrower_message_preference_id)
319 JOIN message_attributes USING (message_attribute_id)
320 WHERE ( reserves.found = 'W' )
321 AND message_transport_type = 'itiva'
322 AND message_name = 'Hold_Filled'
323 $patron_branchcode_filter
325 my $sth = $dbh->prepare($query);
328 while ( my $issue = $sth->fetchrow_hashref() ) {
329 my $item = Koha::Items->find({ barcode => $issue->{barcode} });
330 my $daysmode = Koha::CirculationRules->get_effective_daysmode(
332 categorycode => $issue->{categorycode},
333 itemtype => $item->effective_itemtype,
334 branchcode => $issue->{site},
338 my $calendar = Koha::Calendar->new( branchcode => $issue->{'site'}, days_mode => $daysmode );
340 my $waiting_date = dt_from_string( $issue->{waitingdate}, 'sql' );
342 $issue->{'date_due'} = output_pref({dt => dt_from_string($issue->{expirationdate}), dateformat => 'iso' });
343 $issue->{'level'} = 1; # only one level for Hold Waiting notifications
345 my $days_to_subtract = 0;
346 if ( $calendar->is_holiday($waiting_date) ) {
347 my $next_open_day = $calendar->next_open_days( $waiting_date, 1 );
348 $days_to_subtract = $calendar->days_between($waiting_date, $next_open_day)->days;
351 $issue->{'days_since_waiting'} = $issue->{'days_since_waiting'} - $days_to_subtract;
353 if ( ( grep $_ eq $issue->{'days_since_waiting'}, @holds_waiting_days_to_call )
354 || !scalar(@holds_waiting_days_to_call) ) {
355 push @results, $issue;