Bug 17600: Standardize our EXPORT_OK
[srvgit] / misc / cronjobs / thirdparty / TalkingTech_itiva_outbound.pl
index b42cb25..fedc3cf 100755 (executable)
@@ -24,20 +24,21 @@ BEGIN {
 
     # find Koha's Perl modules
     # test carefully before changing this
-    use FindBin;
+    use FindBin ();
     eval { require "$FindBin::Bin/../kohalib.pl" };
 }
 
-use Getopt::Long;
-use Pod::Usage;
-use Date::Calc qw(Add_Delta_Days);
+use Getopt::Long qw( GetOptions );
+use Pod::Usage qw( pod2usage );
 
+use Koha::Script -cron;
 use C4::Context;
-use C4::Items;
 use C4::Letters;
 use C4::Overdues;
-use C4::Calendar;
-use Koha::DateUtils;
+use Koha::Calendar;
+use Koha::DateUtils qw( dt_from_string output_pref );
+use Koha::Patrons;
+use Koha::Libraries;
 
 sub usage {
     pod2usage( -verbose => 2 );
@@ -58,6 +59,8 @@ my @holds_waiting_days_to_call;
 my $library_code;
 my $help;
 my $outfile;
+my $skip_patrons_with_email;
+my $patron_branchcode;
 
 # maps to convert I-tiva terms to Koha terms
 my $type_module_map = {
@@ -73,13 +76,15 @@ my $type_notice_map = {
 };
 
 GetOptions(
-    'o|output:s'            => \$outfile,
-    'v'                     => \$verbose,
-    'lang:s'                => \$language,
-    'type:s'                => \@types,
-    'w|waiting-hold-day:s'  => \@holds_waiting_days_to_call,
-    'c|code|library-code:s' => \$library_code,
-    'help|h'                => \$help,
+    'o|output:s'             => \$outfile,
+    'v'                      => \$verbose,
+    'lang:s'                 => \$language,
+    'type:s'                 => \@types,
+    'w|waiting-hold-day:s'   => \@holds_waiting_days_to_call,
+    'c|code|library-code:s'  => \$library_code,
+    's|skip-patrons-with-email' => \$skip_patrons_with_email,
+    'pb|patron-branchcode:s' => \$patron_branchcode,
+    'h|help'                 => \$help,
 );
 
 $language = uc($language);
@@ -87,6 +92,11 @@ $library_code ||= '';
 
 pod2usage( -verbose => 1 ) if $help;
 
+if ($patron_branchcode) {
+    die("Invalid branchcode '$patron_branchcode' passed in -pb --patron-branchcode parameter")
+      unless Koha::Libraries->search( { branchcode => $patron_branchcode } )->count;
+}
+
 # output log or STDOUT
 my $OUT;
 if ( defined $outfile ) {
@@ -94,7 +104,7 @@ if ( defined $outfile ) {
 } else {
     print "No output file defined; printing to STDOUT\n"
       if ( defined $verbose );
-    open( $OUT, '>', "&STDOUT" ) || die("Couldn't duplicate STDOUT: $!");
+    $OUT = *STDOUT || die "Couldn't duplicate STDOUT: $!";
 }
 
 my $format = 'V';    # format for phone notifications
@@ -106,30 +116,35 @@ foreach my $type (@types) {
 
     my @loop;
     if ( $type eq 'OVERDUE' ) {
-        @loop = GetOverdueIssues();
+        @loop = GetOverdueIssues( $patron_branchcode );
     } elsif ( $type eq 'PREOVERDUE' ) {
-        @loop = GetPredueIssues();
+        @loop = GetPredueIssues( $patron_branchcode );
     } elsif ( $type eq 'RESERVE' ) {
-        @loop = GetWaitingHolds();
+        @loop = GetWaitingHolds( $patron_branchcode );
     } else {
         print "Unknown or unsupported message type $type; skipping...\n"
           if ( defined $verbose );
         next;
     }
 
+    my $patrons;
     foreach my $issues (@loop) {
+        $patrons->{$issues->{borrowernumber}} ||= Koha::Patrons->find( $issues->{borrowernumber} ) if $skip_patrons_with_email;
+        next if $skip_patrons_with_email && $patrons->{$issues->{borrowernumber}}->notice_email_address;
+
         my $date_dt = dt_from_string ( $issues->{'date_due'} );
         my $due_date = output_pref( { dt => $date_dt, dateonly => 1, dateformat =>'metric' } );
 
         my $letter = C4::Letters::GetPreparedLetter(
             module      => $module,
             letter_code => $code,
+            lang        => 'default', # It does not sound useful to send a lang here
             tables      => {
                 borrowers   => $issues->{'borrowernumber'},
                 biblio      => $issues->{'biblionumber'},
                 biblioitems => $issues->{'biblionumber'},
             },
-            message_transport_type => 'phone',
+            message_transport_type => 'itiva',
         );
 
         die "No letter found for type $type!... dying\n" unless $letter;
@@ -139,11 +154,14 @@ foreach my $type (@types) {
             $message_id = C4::Letters::EnqueueLetter(
                 {   letter                 => $letter,
                     borrowernumber         => $issues->{'borrowernumber'},
-                    message_transport_type => 'phone',
+                    message_transport_type => 'itiva',
                 }
             );
         }
 
+        $issues->{title} =~ s/'//g;
+        $issues->{title} =~ s/"//g;
+
         print $OUT "\"$format\",\"$language\",\"$type\",\"$issues->{level}\",\"$issues->{cardnumber}\",\"$issues->{patron_title}\",\"$issues->{firstname}\",";
         print $OUT "\"$issues->{surname}\",\"$issues->{phone}\",\"$issues->{email}\",\"$library_code\",";
         print $OUT "\"$issues->{site}\",\"$issues->{site_name}\",\"$issues->{barcode}\",\"$due_date\",\"$issues->{title}\",\"$message_id\"\n";
@@ -207,11 +225,22 @@ consortium purposes and apply library specific settings, such as
 prompts, to those notices.
 This field can be blank if all messages are from a single library.
 
+=item B<--patron-branchcode> B<--pb>
+
+OPTIONAL
+
+Limits the the patrons to generate notices for based on the patron's home library.
+Items and holds from other libraries will still be included for the given patron.
+
 =back
 
 =cut
 
 sub GetOverdueIssues {
+    my ( $patron_branchcode ) = @_;
+
+    my $patron_branchcode_filter = $patron_branchcode ? "AND borrowers.branchcode = '$patron_branchcode'" : q{};
+
     my $query = "SELECT borrowers.borrowernumber, borrowers.cardnumber, borrowers.title as patron_title, borrowers.firstname, borrowers.surname,
                 borrowers.phone, borrowers.email, borrowers.branchcode, biblio.biblionumber, biblio.title, items.barcode, issues.date_due,
                 max(overduerules.branchcode) as rulebranch, TO_DAYS(NOW())-TO_DAYS(date_due) as daysoverdue, delay1, delay2, delay3,
@@ -221,10 +250,13 @@ sub GetOverdueIssues {
                 JOIN biblio USING (biblionumber)
                 JOIN branches ON (issues.branchcode = branches.branchcode)
                 JOIN overduerules USING (categorycode)
+                JOIN overduerules_transport_types USING ( overduerules_id )
                 WHERE ( overduerules.branchcode = borrowers.branchcode or overduerules.branchcode = '')
+                AND overduerules_transport_types.message_transport_type = 'itiva'
                 AND ( (TO_DAYS(NOW())-TO_DAYS(date_due) ) = delay1
                   OR  (TO_DAYS(NOW())-TO_DAYS(date_due) ) = delay2
                   OR  (TO_DAYS(NOW())-TO_DAYS(date_due) ) = delay3 )
+                $patron_branchcode_filter
                 GROUP BY items.itemnumber
                 ";
     my $sth = $dbh->prepare($query);
@@ -247,6 +279,10 @@ sub GetOverdueIssues {
 }
 
 sub GetPredueIssues {
+    my ( $patron_branchcode ) = @_;
+
+    my $patron_branchcode_filter = $patron_branchcode ? "AND borrowers.branchcode = '$patron_branchcode'" : q{};
+
     my $query = "SELECT borrowers.borrowernumber, borrowers.cardnumber, borrowers.title as patron_title, borrowers.firstname, borrowers.surname,
                 borrowers.phone, borrowers.email, borrowers.branchcode, biblio.biblionumber, biblio.title, items.barcode, issues.date_due,
                 issues.branchcode as site, branches.branchname as site_name
@@ -258,8 +294,9 @@ sub GetPredueIssues {
                 JOIN borrower_message_transport_preferences USING (borrower_message_preference_id)
                 JOIN message_attributes USING (message_attribute_id)
                 WHERE ( TO_DAYS( date_due ) - TO_DAYS( NOW() ) ) = days_in_advance
-                AND message_transport_type = 'phone'
+                AND message_transport_type = 'itiva'
                 AND message_name = 'Advance_Notice'
+                $patron_branchcode_filter
                 ";
     my $sth = $dbh->prepare($query);
     $sth->execute();
@@ -272,7 +309,11 @@ sub GetPredueIssues {
 }
 
 sub GetWaitingHolds {
-    my $query = "SELECT borrowers.borrowernumber, borrowers.cardnumber, borrowers.title as patron_title, borrowers.firstname, borrowers.surname,
+    my ( $patron_branchcode ) = @_;
+
+    my $patron_branchcode_filter = $patron_branchcode ? "AND borrowers.branchcode = '$patron_branchcode'" : q{};
+
+    my $query = "SELECT borrowers.borrowernumber, borrowers.cardnumber, borrowers.title as patron_title, borrowers.firstname, borrowers.surname, borrowers.categorycode,
                 borrowers.phone, borrowers.email, borrowers.branchcode, biblio.biblionumber, biblio.title, items.barcode, reserves.waitingdate,
                 reserves.branchcode AS site, branches.branchname AS site_name,
                 TO_DAYS(NOW())-TO_DAYS(reserves.waitingdate) AS days_since_waiting
@@ -284,30 +325,41 @@ sub GetWaitingHolds {
                 JOIN borrower_message_transport_preferences USING (borrower_message_preference_id)
                 JOIN message_attributes USING (message_attribute_id)
                 WHERE ( reserves.found = 'W' )
-                AND message_transport_type = 'phone'
+                AND message_transport_type = 'itiva'
                 AND message_name = 'Hold_Filled'
+                $patron_branchcode_filter
                 ";
     my $pickupdelay = C4::Context->preference("ReservesMaxPickUpDelay");
     my $sth         = $dbh->prepare($query);
     $sth->execute();
     my @results;
     while ( my $issue = $sth->fetchrow_hashref() ) {
-        my $calendar = C4::Calendar->new( branchcode => $issue->{'site'} );
+        my $item = Koha::Items->find({ barcode => $issue->{barcode} });
+        my $daysmode = Koha::CirculationRules->get_effective_daysmode(
+            {
+                categorycode => $issue->{categorycode},
+                itemtype     => $item->effective_itemtype,
+                branchcode   => $issue->{site},
+            }
+        );
 
-        my ( $waiting_year, $waiting_month, $waiting_day ) = split( /-/, $issue->{'waitingdate'} );
-        my ( $pickup_year, $pickup_month, $pickup_day ) = Add_Delta_Days( $waiting_year, $waiting_month, $waiting_day, $pickupdelay );
+        my $calendar = Koha::Calendar->new( branchcode => $issue->{'site'}, days_mode => $daysmode );
 
-        while ( $calendar->isHoliday( $pickup_day, $pickup_month, $pickup_year ) ) {
-            ( $pickup_year, $pickup_month, $pickup_day ) = Add_Delta_Days( $pickup_year, $pickup_month, $pickup_day, 1 );
+        my $waiting_date = dt_from_string( $issue->{waitingdate}, 'sql' );
+        my $pickup_date = $waiting_date->clone->add( days => $pickupdelay );
+        if ( $calendar->is_holiday($pickup_date) ) {
+            $pickup_date = $calendar->next_open_days( $pickup_date, 1 );
         }
 
-        $issue->{'date_due'} = sprintf( "%04d-%02d-%02d", $pickup_year, $pickup_month, $pickup_day );
+        $issue->{'date_due'} = output_pref({dt => $pickup_date, dateformat => 'iso' });
         $issue->{'level'} = 1;    # only one level for Hold Waiting notifications
 
         my $days_to_subtract = 0;
-        while ( $calendar->isHoliday( reverse( Add_Delta_Days( $waiting_year, $waiting_month, $waiting_day, $days_to_subtract ) ) ) ) {
-            $days_to_subtract++;
+        if ( $calendar->is_holiday($waiting_date) ) {
+            my $next_open_day = $calendar->next_open_days( $waiting_date, 1 );
+            $days_to_subtract = $calendar->days_between($waiting_date, $next_open_day)->days;
         }
+
         $issue->{'days_since_waiting'} = $issue->{'days_since_waiting'} - $days_to_subtract;
 
         if ( ( grep $_ eq $issue->{'days_since_waiting'}, @holds_waiting_days_to_call )