Bug 20663: Add some POD, so koha test tools don't complain
[srvgit] / C4 / Reports / Guided.pm
index 916d373..ecebe86 100644 (file)
@@ -17,38 +17,37 @@ package C4::Reports::Guided;
 # You should have received a copy of the GNU General Public License
 # along with Koha; if not, see <http://www.gnu.org/licenses>.
 
-use strict;
-#use warnings; FIXME - Bug 2505 this module needs a lot of repair to run clean under warnings
+use Modern::Perl;
 use CGI qw ( -utf8 );
 use Carp;
+use JSON qw( from_json );
 
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
+use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
 use C4::Context;
-use C4::Dates qw/format_date format_date_in_iso/;
 use C4::Templates qw/themelanguage/;
 use C4::Koha;
+use Koha::DateUtils;
 use C4::Output;
-use XML::Simple;
-use XML::Dumper;
 use C4::Debug;
-# use Smart::Comments;
-# use Data::Dumper;
+use C4::Log;
+
+use Koha::AuthorisedValues;
+use Koha::Patron::Categories;
 
 BEGIN {
-    # set the version for version checking
-    $VERSION = 3.07.00.049;
     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_saved_report
       get_column_type get_distinct_values save_dictionary get_from_dictionary
       delete_definition delete_report format_results get_sql
-      nb_rows update_sql build_authorised_value_list
+      nb_rows update_sql
       GetReservedAuthorisedValues
       GetParametersFromSQL
       IsAuthorisedValueValid
       ValidateSQLParameters
+      nb_rows update_sql
     );
 }
 
@@ -79,6 +78,7 @@ sub get_area_name_sql_snippet {
         [PAT  => "Patrons"],
         [ACQ  => "Acquisition"],
         [ACC  => "Accounts"],
+        [SER  => "Serials"],
     );
 
     return "CASE report_area " .
@@ -88,7 +88,7 @@ sub get_area_name_sql_snippet {
 
 sub get_report_areas {
 
-    my $report_areas = [ 'CIRC', 'CAT', 'PAT', 'ACQ', 'ACC' ];
+    my $report_areas = [ 'CIRC', 'CAT', 'PAT', 'ACQ', 'ACC', 'SER' ];
 
     return $report_areas;
 }
@@ -100,6 +100,7 @@ sub get_table_areas {
     PAT  => ['borrowers'],
     ACQ  => [ 'aqorders', 'biblio', 'items' ],
     ACC  => [ 'borrowers', 'accountlines' ],
+    SER  => [ 'serial', 'serialitems', 'subscription', 'subscriptionhistory', 'subscriptionroutinglist', 'biblioitems', 'biblio', 'aqbooksellers' ],
     );
 }
 
@@ -182,7 +183,7 @@ This will return a list of all columns for a report area
 
 sub get_columns {
 
-    # this calls the internal fucntion _get_columns
+    # this calls the internal function _get_columns
     my ( $area, $cgi ) = @_;
     my %table_areas = get_table_areas;
     my $tables = $table_areas{$area}
@@ -240,6 +241,7 @@ sub build_query {
         ACQ  => [ 'aqorders.biblionumber=biblio.biblionumber',
                   'biblio.biblionumber=items.biblionumber' ],
         ACC  => ['borrowers.borrowernumber=accountlines.borrowernumber'],
+        SER  => [ 'serial.serialid=serialitems.serialid', 'serial.subscriptionid=subscription.subscriptionid', 'serial.subscriptionid=subscriptionhistory.subscriptionid', 'serial.subscriptionid=subscriptionroutinglist.subscriptionid', 'biblioitems.biblionumber=serial.biblionumber', 'biblio.biblionumber=biblioitems.biblionumber', 'subscription.aqbooksellerid=aqbooksellers.id'],
     );
 
 
@@ -330,6 +332,7 @@ sub get_criteria {
         PAT  => [ 'borrowers.branchcode', 'borrowers.categorycode' ],
         ACQ  => ['aqorders.datereceived|date'],
         ACC  => [ 'borrowers.branchcode', 'borrowers.categorycode' ],
+        SER  => ['subscription.startdate|date', 'subscription.enddate|date', 'subscription.periodicity', 'subscription.callnumber', 'subscription.location', 'subscription.branchcode'],
     );
 
     # Adds itemtypes to criteria, according to the syspref
@@ -386,10 +389,14 @@ sub get_criteria {
             $list='itemtypes' if $column eq 'itype';
             $list='ccode' if $column eq 'ccode';
             # TODO : improve to let the librarian choose the description at runtime
-            push @values, { availablevalues => "<<$column".($list?"|$list":'').">>" };
+            push @values, {
+                availablevalues => "<<$column" . ( $list ? "|$list" : '' ) . ">>",
+                display_value   => "<<$column" . ( $list ? "|$list" : '' ) . ">>",
+            };
             while ( my $row = $sth->fetchrow_hashref() ) {
+                if ($row->{'availablevalues'} eq '') { $row->{'default'} = 1 }
+                else { $row->{display_value} = _get_display_value( $row->{'availablevalues'}, $column ); }
                 push @values, $row;
-                if ($row->{'availablevalues'} eq '') { $row->{'default'} = 1 };
             }
             $sth->finish();
 
@@ -400,7 +407,6 @@ sub get_criteria {
 
             push @criteria_array, \%temp;
         }
-
     }
     return ( \@criteria_array );
 }
@@ -432,7 +438,7 @@ for the query.
 C<$offset>, and C<$limit> are required parameters.
 
 C<\@sql_params> is an optional list of parameter values to paste in.
-The caller is reponsible for making sure that C<$sql> has placeholders
+The caller is responsible for making sure that C<$sql> has placeholders
 and that the number placeholders matches the number of parameters.
 
 =cut
@@ -490,7 +496,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;
 
@@ -525,14 +531,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)
@@ -587,51 +594,37 @@ 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 $dbh = C4::Context->dbh;
     my $query = 'DELETE FROM saved_sql WHERE id IN (' . join( ',', ('?') x @ids ) . ')';
     my $sth = $dbh->prepare($query);
@@ -639,10 +632,9 @@ 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
@@ -664,12 +656,10 @@ sub get_saved_reports {
     my (@cond,@args);
     if ($filter) {
         if (my $date = $filter->{date}) {
-            $date = format_date_in_iso($date);
-            push @cond, "DATE(date_run) = ? OR
-                         DATE(date_created) = ? OR
-                         DATE(last_modified) = ? OR
+            $date = eval { output_pref( { dt => dt_from_string( $date ), dateonly => 1, dateformat => 'iso' }); };
+            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%";
@@ -728,35 +718,6 @@ sub get_saved_report {
     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)
 
@@ -772,7 +733,7 @@ sub get_column_type {
        my $catalog;
        my $schema;
 
-       # mysql doesnt support a column selection, set column to %
+    # mysql doesn't support a column selection, set column to %
        my $tempcolumn='%';
        my $sth = $dbh->column_info( $catalog, $schema, $table, $tempcolumn ) || die $dbh->errstr;
        while (my $info = $sth->fetchrow_hashref()){
@@ -851,6 +812,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();
@@ -861,6 +829,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;
@@ -873,7 +851,7 @@ sub _get_column_defs {
     my ($theme, $lang, $availablethemes) = C4::Templates::themelanguage($htdocs, 'about.tt', $section, $cgi);
 
     my $full_path_to_columns_def_file="$htdocs/$theme/$lang/$columns_def_file";
-    open (my $fh, $full_path_to_columns_def_file);
+    open (my $fh, '<:encoding(utf-8)', $full_path_to_columns_def_file);
     while ( my $input = <$fh> ){
         chomp $input;
         if ( $input =~ m|<field name="(.*)">(.*)</field>| ) {
@@ -885,71 +863,6 @@ sub _get_column_defs {
     return \%columns;
 }
 
-=head2 build_authorised_value_list($authorised_value)
-
-Returns an arrayref - hashref pair. The hashref consists of
-various code => name lists depending on the $authorised_value.
-The arrayref is the hashref keys, in appropriate order
-
-=cut
-
-sub build_authorised_value_list {
-    my ( $authorised_value ) = @_;
-
-    my $dbh = C4::Context->dbh;
-    my @authorised_values;
-    my %authorised_lib;
-
-    # builds list, depending on authorised value...
-    if ( $authorised_value eq "branches" ) {
-        my $branches = GetBranchesLoop();
-        foreach my $thisbranch (@$branches) {
-            push @authorised_values, $thisbranch->{value};
-            $authorised_lib{ $thisbranch->{value} } = $thisbranch->{branchname};
-        }
-    } elsif ( $authorised_value eq "itemtypes" ) {
-        my $sth = $dbh->prepare("SELECT itemtype,description FROM itemtypes ORDER BY description");
-        $sth->execute;
-        while ( my ( $itemtype, $description ) = $sth->fetchrow_array ) {
-            push @authorised_values, $itemtype;
-            $authorised_lib{$itemtype} = $description;
-        }
-    } elsif ( $authorised_value eq "cn_source" ) {
-        my $class_sources  = GetClassSources();
-        my $default_source = C4::Context->preference("DefaultClassificationSource");
-        foreach my $class_source ( sort keys %$class_sources ) {
-            next
-              unless $class_sources->{$class_source}->{'used'}
-                  or ( $class_source eq $default_source );
-            push @authorised_values, $class_source;
-            $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
-        }
-    } elsif ( $authorised_value eq "categorycode" ) {
-        my $sth = $dbh->prepare("SELECT categorycode, description FROM categories ORDER BY description");
-        $sth->execute;
-        while ( my ( $categorycode, $description ) = $sth->fetchrow_array ) {
-            push @authorised_values, $categorycode;
-            $authorised_lib{$categorycode} = $description;
-        }
-
-        #---- "true" authorised value
-    } else {
-        my $authorised_values_sth = $dbh->prepare("SELECT authorised_value,lib FROM authorised_values WHERE category=? ORDER BY lib");
-
-        $authorised_values_sth->execute($authorised_value);
-
-        while ( my ( $value, $lib ) = $authorised_values_sth->fetchrow_array ) {
-            push @authorised_values, $value;
-            $authorised_lib{$value} = $lib;
-
-            # For item location, we show the code and the libelle
-            $authorised_lib{$value} = $lib;
-        }
-    }
-
-    return (\@authorised_values, \%authorised_lib);
-}
-
 =head2 GetReservedAuthorisedValues
 
     my %reserved_authorised_values = GetReservedAuthorisedValues();
@@ -986,7 +899,7 @@ sub IsAuthorisedValueValid {
     my $reserved_authorised_values = GetReservedAuthorisedValues();
 
     if ( exists $reserved_authorised_values->{$authorised_value} ||
-         C4::Koha::IsAuthorisedValueCategory($authorised_value)   ) {
+         Koha::AuthorisedValues->search({ category => $authorised_value })->count ) {
         return 1;
     }
 
@@ -1040,6 +953,38 @@ sub ValidateSQLParameters {
     return \@problematic_parameters;
 }
 
+sub _get_display_value {
+    my ( $original_value, $column ) = @_;
+    if ( $column eq 'periodicity' ) {
+        my $dbh = C4::Context->dbh();
+        my $query = "SELECT description FROM subscription_frequencies WHERE id = ?";
+        my $sth   = $dbh->prepare($query);
+        $sth->execute($original_value);
+        return $sth->fetchrow;
+    }
+    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__