Bug 16149: Generate and send custom notices based on report output
[koha-equinox.git] / C4 / Reports / Guided.pm
index 631f961..eff3a7c 100644 (file)
@@ -20,27 +20,31 @@ package C4::Reports::Guided;
 use Modern::Perl;
 use CGI qw ( -utf8 );
 use Carp;
+use JSON qw( from_json );
 
 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
 use C4::Context;
 use C4::Templates qw/themelanguage/;
 use C4::Koha;
 use Koha::DateUtils;
+use Koha::Patrons;
+use Koha::Reports;
 use C4::Output;
-use XML::Simple;
-use XML::Dumper;
 use C4::Debug;
 use C4::Log;
+use Koha::Notice::Templates;
+use C4::Letters;
 
 use Koha::AuthorisedValues;
 use Koha::Patron::Categories;
+use Koha::SharedContent;
 
 BEGIN {
     require Exporter;
     @ISA    = qw(Exporter);
     @EXPORT = qw(
       get_report_types get_report_areas get_report_groups get_columns build_query get_criteria
-      save_report get_saved_reports execute_query get_saved_report create_compound run_compound
+      save_report get_saved_reports execute_query
       get_column_type get_distinct_values save_dictionary get_from_dictionary
       delete_definition delete_report format_results get_sql
       nb_rows update_sql
@@ -497,7 +501,7 @@ sub strip_limit {
 
 sub execute_query {
 
-    my ( $sql, $offset, $limit, $sql_params ) = @_;
+    my ( $sql, $offset, $limit, $sql_params, $report_id ) = @_;
 
     $sql_params = [] unless defined $sql_params;
 
@@ -532,14 +536,15 @@ sub execute_query {
     }
     $sql .= " LIMIT ?, ?";
 
-    my $sth = C4::Context->dbh->prepare($sql);
+    my $dbh = C4::Context->dbh;
+
+    $dbh->do( 'UPDATE saved_sql SET last_run = NOW() WHERE id = ?', undef, $report_id ) if $report_id;
+
+    my $sth = $dbh->prepare($sql);
     $sth->execute(@$sql_params, $offset, $limit);
+
     return ( $sth, { queryerr => $sth->errstr } ) if ($sth->err);
     return ( $sth );
-    # my @xmlarray = ... ;
-    # my $url = "/cgi-bin/koha/reports/guided_reports.pl?phase=retrieve%20results&id=$id";
-    # my $xml = XML::Dumper->new()->pl2xml( \@xmlarray );
-    # store_results($id,$xml);
 }
 
 =head2 save_report($sql,$name,$type,$notes)
@@ -594,54 +599,36 @@ sub update_sql {
 }
 
 sub store_results {
-       my ($id,$xml)=@_;
-       my $dbh = C4::Context->dbh();
-       my $query = "SELECT * FROM saved_reports WHERE report_id=?";
-       my $sth = $dbh->prepare($query);
-       $sth->execute($id);
-       if (my $data=$sth->fetchrow_hashref()){
-               my $query2 = "UPDATE saved_reports SET report=?,date_run=now() WHERE report_id=?";
-               my $sth2 = $dbh->prepare($query2);
-           $sth2->execute($xml,$id);
-       }
-       else {
-               my $query2 = "INSERT INTO saved_reports (report_id,report,date_run) VALUES (?,?,now())";
-               my $sth2 = $dbh->prepare($query2);
-               $sth2->execute($id,$xml);
-       }
+    my ( $id, $json ) = @_;
+    my $dbh = C4::Context->dbh();
+    $dbh->do(q|
+        INSERT INTO saved_reports ( report_id, report, date_run ) VALUES ( ?, ?, NOW() );
+    |, undef, $id, $json );
 }
 
 sub format_results {
-       my ($id) = @_;
-       my $dbh = C4::Context->dbh();
-       my $query = "SELECT * FROM saved_reports WHERE report_id = ?";
-       my $sth = $dbh->prepare($query);
-       $sth->execute($id);
-       my $data = $sth->fetchrow_hashref();
-       my $dump = new XML::Dumper;
-       my $perl = $dump->xml2pl( $data->{'report'} );
-       foreach my $row (@$perl) {
-               my $htmlrow="<tr>";
-               foreach my $key (keys %$row){
-                       $htmlrow .= "<td>$row->{$key}</td>";
-               }
-               $htmlrow .= "</tr>";
-               $row->{'row'} = $htmlrow;
-       }
-       $sth->finish;
-       $query = "SELECT * FROM saved_sql WHERE id = ?";
-       $sth = $dbh->prepare($query);
-       $sth->execute($id);
-       $data = $sth->fetchrow_hashref();
-       return ($perl,$data->{'report_name'},$data->{'notes'}); 
-}      
+    my ( $id ) = @_;
+    my $dbh = C4::Context->dbh();
+    my ( $report_name, $notes, $json, $date_run ) = $dbh->selectrow_array(q|
+       SELECT ss.report_name, ss.notes, sr.report, sr.date_run
+       FROM saved_sql ss
+       LEFT JOIN saved_reports sr ON sr.report_id = ss.id
+       WHERE sr.id = ?
+    |, undef, $id);
+    return {
+        report_name => $report_name,
+        notes => $notes,
+        results => from_json( $json ),
+        date_run => $date_run,
+    };
+}
 
 sub delete_report {
     my (@ids) = @_;
     return unless @ids;
     foreach my $id (@ids) {
-        my $data = get_saved_report($id);
-        logaction( "REPORTS", "DELETE", $id, "$data->{'report_name'} | $data->{'savedsql'}  " ) if C4::Context->preference("ReportsLog");
+        my $data = Koha::Reports->find($id);
+        logaction( "REPORTS", "DELETE", $id, $data->report_name." | ".$data->savedsql ) if C4::Context->preference("ReportsLog");
     }
     my $dbh = C4::Context->dbh;
     my $query = 'DELETE FROM saved_sql WHERE id IN (' . join( ',', ('?') x @ids ) . ')';
@@ -652,7 +639,7 @@ sub delete_report {
 sub get_saved_reports_base_query {
     my $area_name_sql_snippet = get_area_name_sql_snippet;
     return <<EOQ;
-SELECT s.*, r.report, r.date_run, $area_name_sql_snippet, av_g.lib AS groupname, av_sg.lib AS subgroupname,
+SELECT s.*, $area_name_sql_snippet, av_g.lib AS groupname, av_sg.lib AS subgroupname,
 b.firstname AS borrowerfirstname, b.surname AS borrowersurname
 FROM saved_sql s
 LEFT JOIN saved_reports r ON r.report_id = s.id
@@ -675,11 +662,9 @@ sub get_saved_reports {
     if ($filter) {
         if (my $date = $filter->{date}) {
             $date = eval { output_pref( { dt => dt_from_string( $date ), dateonly => 1, dateformat => 'iso' }); };
-            push @cond, "DATE(date_run) = ? OR
-                         DATE(date_created) = ? OR
-                         DATE(last_modified) = ? OR
+            push @cond, "DATE(last_modified) = ? OR
                          DATE(last_run) = ?";
-            push @args, $date, $date, $date, $date;
+            push @args, $date, $date, $date;
         }
         if (my $author = $filter->{author}) {
             $author = "%$author%";
@@ -714,60 +699,6 @@ sub get_saved_reports {
     return $result;
 }
 
-sub get_saved_report {
-    my $dbh   = C4::Context->dbh();
-    my $query;
-    my $report_arg;
-    if ($#_ == 0 && ref $_[0] ne 'HASH') {
-        ($report_arg) = @_;
-        $query = " SELECT * FROM saved_sql WHERE id = ?";
-    } elsif (ref $_[0] eq 'HASH') {
-        my ($selector) = @_;
-        if ($selector->{name}) {
-            $query = " SELECT * FROM saved_sql WHERE report_name = ?";
-            $report_arg = $selector->{name};
-        } elsif ($selector->{id} || $selector->{id} eq '0') {
-            $query = " SELECT * FROM saved_sql WHERE id = ?";
-            $report_arg = $selector->{id};
-        } else {
-            return;
-        }
-    } else {
-        return;
-    }
-    return $dbh->selectrow_hashref($query, undef, $report_arg);
-}
-
-=head2 create_compound($masterID,$subreportID)
-
-This will take 2 reports and create a compound report using both of them
-
-=cut
-
-sub create_compound {
-    my ( $masterID, $subreportID ) = @_;
-    my $dbh = C4::Context->dbh();
-
-    # get the reports
-    my $master = get_saved_report($masterID);
-    my $mastersql = $master->{savedsql};
-    my $mastertype = $master->{type};
-    my $sub = get_saved_report($subreportID);
-    my $subsql = $master->{savedsql};
-    my $subtype = $master->{type};
-
-    # now we have to do some checking to see how these two will fit together
-    # or if they will
-    my ( $mastertables, $subtables );
-    if ( $mastersql =~ / from (.*) where /i ) {
-        $mastertables = $1;
-    }
-    if ( $subsql =~ / from (.*) where /i ) {
-        $subtables = $1;
-    }
-    return ( $mastertables, $subtables );
-}
-
 =head2 get_column_type($column)
 
 This takes a column name of the format table.column and will return what type it is
@@ -861,6 +792,13 @@ sub delete_definition {
        $sth->execute($id);
 }
 
+=head2 get_sql($report_id)
+
+Given a report id, return the SQL statement for that report.
+Otherwise, it just returns.
+
+=cut
+
 sub get_sql {
        my ($id) = @_ or return;
        my $dbh = C4::Context->dbh();
@@ -871,6 +809,16 @@ sub get_sql {
        return $data->{'savedsql'};
 }
 
+sub get_results {
+    my ( $report_id ) = @_;
+    my $dbh = C4::Context->dbh;
+    return $dbh->selectall_arrayref(q|
+        SELECT id, report, date_run
+        FROM saved_reports
+        WHERE report_id = ?
+    |, { Slice => {} }, $report_id);
+}
+
 sub _get_column_defs {
     my ($cgi) = @_;
     my %columns;
@@ -985,6 +933,99 @@ sub ValidateSQLParameters {
     return \@problematic_parameters;
 }
 
+=head2 EmailReport
+
+    my ( $emails, $arrayrefs ) = EmailReport($report_id, $letter_code, $module, $branch, $email)
+
+Take a report and use it to process a Template Toolkit formatted notice
+Returns arrayrefs containing prepared letters and errors respectively
+
+=cut
+
+sub EmailReport {
+
+    my $params     = shift;
+    my $report_id  = $params->{report_id};
+    my $from       = $params->{from};
+    my $email      = $params->{email};
+    my $module     = $params->{module};
+    my $code       = $params->{code};
+    my $branch     = $params->{branch} || "";
+
+    my @errors = ();
+    my @emails = ();
+
+    return ( undef, [{ FATAL => "MISSING_PARAMS" }] ) unless ($report_id && $module && $code);
+
+    return ( undef, [{ FATAL => "NO_LETTER" }] ) unless
+    my $letter = Koha::Notice::Templates->find({
+        module     => $module,
+        code       => $code,
+        branchcode => $branch,
+        message_transport_type => 'email',
+    });
+    $letter = $letter->unblessed;
+
+    my $report = Koha::Reports->find( $report_id );
+    my $sql = $report->savedsql;
+    return ( { FATAL => "NO_REPORT" } ) unless $sql;
+
+    my ( $sth, $errors ) = execute_query( $sql ); #don't pass offset or limit, hardcoded limit of 999,999 will be used
+    return ( undef, [{ FATAL => "REPORT_FAIL" }] ) if $errors;
+
+    my $counter = 1;
+    my $template = $letter->{content};
+
+    while ( my $row = $sth->fetchrow_hashref() ) {
+        my $email;
+        my $err_count = scalar @errors;
+        push ( @errors, { NO_BOR_COL => $counter } ) unless defined $row->{borrowernumber};
+        push ( @errors, { NO_EMAIL_COL => $counter } ) unless ( (defined $email && defined $row->{$email}) || defined $row->{email} );
+        push ( @errors, { NO_FROM_COL => $counter } ) unless defined ( $from || $row->{from} );
+        push ( @errors, { NO_BOR => $row->{borrowernumber} } ) unless Koha::Patrons->find({borrowernumber=>$row->{borrowernumber}});
+
+        my $from_address = $from || $row->{from};
+        my $to_address = $email ? $row->{$email} : $row->{email};
+        push ( @errors, { NOT_PARSE => $counter } ) unless my $content = _process_row_TT( $row, $template );
+        $counter++;
+        next if scalar @errors > $err_count; #If any problems, try next
+
+        $letter->{content}       = $content;
+        $email->{borrowernumber} = $row->{borrowernumber};
+        $email->{letter}         = $letter;
+        $email->{from_address}   = $from_address;
+        $email->{to_address}     = $to_address;
+
+        push ( @emails, $email );
+    }
+
+    return ( \@emails, \@errors );
+
+}
+
+
+
+=head2 ProcessRowTT
+
+   my $content = ProcessRowTT($row_hashref, $template);
+
+Accepts a hashref containing values and processes them against Template Toolkit
+to produce content
+
+=cut
+
+sub _process_row_TT {
+
+    my ($row, $template) = @_;
+
+    return 0 unless ($row && $template);
+    my $content;
+    my $processor = Template->new();
+    $processor->process( \$template, $row, \$content);
+    return $content;
+
+}
+
 sub _get_display_value {
     my ( $original_value, $column ) = @_;
     if ( $column eq 'periodicity' ) {
@@ -997,6 +1038,26 @@ sub _get_display_value {
     return $original_value;
 }
 
+
+=head3 convert_sql
+
+my $updated_sql = C4::Reports::Guided::convert_sql( $sql );
+
+Convert a sql query using biblioitems.marcxml to use the new
+biblio_metadata.metadata field instead
+
+=cut
+
+sub convert_sql {
+    my ( $sql ) = @_;
+    my $updated_sql = $sql;
+    if ( $sql =~ m|biblioitems| and $sql =~ m|marcxml| ) {
+        $updated_sql =~ s|biblioitems|biblio_metadata|g;
+        $updated_sql =~ s|marcxml|metadata|g;
+    }
+    return $updated_sql;
+}
+
 1;
 __END__