[Koha-patches] [PATCH] fix for bug 2543: report output by tabulation a bit too literal
Jesse Weaver
jesse.weaver at liblime.com
Wed Sep 10 02:31:31 CEST 2008
This repurposes the Reports module for general reports, and moves its functionality to a different module, Reports::Guided. It also updates all of the reports that can export to correctly treat the 'tabulation' value of the 'delimiter' syspref.
---
C4/Reports.pm | 710 +------------------
C4/Reports/Guided.pm | 742 ++++++++++++++++++++
.../prog/en/modules/reports/bor_issues_top.tmpl | 8 +-
.../prog/en/modules/reports/catalogue_stats.tmpl | 6 +-
reports/acquisitions_stats.pl | 16 +-
reports/bor_issues_top.pl | 10 +-
reports/borrowers_out.pl | 14 +-
reports/borrowers_stats.pl | 14 +-
reports/cat_issues_top.pl | 13 +-
reports/catalogue_out.pl | 14 +-
reports/catalogue_stats.pl | 8 +-
reports/dictionary.pl | 8 +-
reports/guided_reports.pl | 8 +-
reports/issues_avg_stats.pl | 13 +-
reports/issues_stats.pl | 13 +-
tools/runreport.pl | 2 +-
tools/scheduler.pl | 2 +-
17 files changed, 823 insertions(+), 778 deletions(-)
create mode 100644 C4/Reports/Guided.pm
diff --git a/C4/Reports.pm b/C4/Reports.pm
index 3032e29..d0bbe70 100644
--- a/C4/Reports.pm
+++ b/C4/Reports.pm
@@ -22,719 +22,71 @@ use CGI;
use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
use C4::Context;
-use C4::Output;
-use XML::Simple;
-use XML::Dumper;
use C4::Debug;
# use Smart::Comments;
# use Data::Dumper;
BEGIN {
- # set the version for version checking
- $VERSION = 0.12;
- require Exporter;
- @ISA = qw(Exporter);
- @EXPORT = qw(
- get_report_types get_report_areas get_columns build_query get_criteria
- save_report get_saved_reports execute_query get_saved_report create_compound run_compound
- get_column_type get_distinct_values save_dictionary get_from_dictionary
- delete_definition delete_report format_results get_sql
- );
-}
-
-our %table_areas;
-$table_areas{'1'} =
- [ 'borrowers', 'statistics','items', 'biblioitems' ]; # circulation
-$table_areas{'2'} = [ 'items', 'biblioitems', 'biblio' ]; # catalogue
-$table_areas{'3'} = [ 'borrowers' ]; # patrons
-$table_areas{'4'} = ['aqorders', 'biblio', 'items']; # acquisitions
-$table_areas{'5'} = [ 'borrowers', 'accountlines' ]; # accounts
-our %keys;
-$keys{'1'} = [
- 'statistics.borrowernumber=borrowers.borrowernumber',
- 'items.itemnumber = statistics.itemnumber',
- 'biblioitems.biblioitemnumber = items.biblioitemnumber'
-];
-$keys{'2'} = [
- 'items.biblioitemnumber=biblioitems.biblioitemnumber',
- 'biblioitems.biblionumber=biblio.biblionumber'
-];
-$keys{'3'} = [ ];
-$keys{'4'} = [
- 'aqorders.biblionumber=biblio.biblionumber',
- 'biblio.biblionumber=items.biblionumber'
-];
-$keys{'5'} = ['borrowers.borrowernumber=accountlines.borrowernumber'];
-
-# have to do someting here to know if its dropdown, free text, date etc
-
-our %criteria;
-$criteria{'1'} = [
- 'statistics.type', 'borrowers.categorycode',
- 'statistics.branch',
- 'biblioitems.publicationyear|date',
- 'items.dateaccessioned|date'
-];
-$criteria{'2'} =
- [ 'items.holdingbranch', 'items.homebranch' ,'items.itemlost', 'items.location', 'items.ccode'];
-$criteria{'3'} = ['borrowers.branchcode'];
-$criteria{'4'} = ['aqorders.datereceived|date'];
-$criteria{'5'} = ['borrowers.branchcode'];
-
-if (C4::Context->preference('item-level_itypes')) {
- unshift @{ $criteria{'1'} }, 'items.itype';
- unshift @{ $criteria{'2'} }, 'items.itype';
-} else {
- unshift @{ $criteria{'1'} }, 'biblioitems.itemtype';
- unshift @{ $criteria{'2'} }, 'biblioitems.itemtype';
+ # set the version for version checking
+ $VERSION = 0.13;
+ require Exporter;
+ @ISA = qw(Exporter);
+ @EXPORT = qw(
+ GetDelimiterChoices
+ );
}
=head1 NAME
C4::Reports - Module for generating reports
-=head1 SYNOPSIS
-
- use C4::Reports;
-
=head1 DESCRIPTION
+This module contains functions common to reports.
-=head1 METHODS
-
-=over 2
-
-=cut
-
-=item get_report_types()
-
-This will return a list of all the available report types
-
-=cut
-
-sub get_report_types {
- my $dbh = C4::Context->dbh();
-
- # FIXME these should be in the database perhaps
- my @reports = ( 'Tabular', 'Summary', 'Matrix' );
- my @reports2;
- for ( my $i = 0 ; $i < 3 ; $i++ ) {
- my %hashrep;
- $hashrep{id} = $i + 1;
- $hashrep{name} = $reports[$i];
- push @reports2, \%hashrep;
- }
- return ( \@reports2 );
-
-}
-
-=item get_report_areas()
-
-This will return a list of all the available report areas
-
-=cut
-
-sub get_report_areas {
- my $dbh = C4::Context->dbh();
-
- # FIXME these should be in the database
- my @reports = ( 'Circulation', 'Catalog', 'Patrons', 'Acquisitions', 'Accounts');
- my @reports2;
- for ( my $i = 0 ; $i < 5 ; $i++ ) {
- my %hashrep;
- $hashrep{id} = $i + 1;
- $hashrep{name} = $reports[$i];
- push @reports2, \%hashrep;
- }
- return ( \@reports2 );
-
-}
-
-=item get_all_tables()
+=head1 EXPORTED FUNCTIONS
-This will return a list of all tables in the database
-
-=cut
-
-sub get_all_tables {
- my $dbh = C4::Context->dbh();
- my $query = "SHOW TABLES";
- my $sth = $dbh->prepare($query);
- $sth->execute();
- my @tables;
- while ( my $data = $sth->fetchrow_arrayref() ) {
- push @tables, $data->[0];
- }
- $sth->finish();
- return ( \@tables );
-
-}
-
-=item get_columns($area)
-
-This will return a list of all columns for a report area
-
-=cut
-
-sub get_columns {
-
- # this calls the internal fucntion _get_columns
- my ($area,$cgi) = @_;
- my $tables = $table_areas{$area};
- my @allcolumns;
- my $first = 1;
- foreach my $table (@$tables) {
- my @columns = _get_columns($table,$cgi, $first);
- $first = 0;
- push @allcolumns, @columns;
- }
- return ( \@allcolumns );
-}
-
-sub _get_columns {
- my ($tablename,$cgi, $first) = @_;
- my $dbh = C4::Context->dbh();
- my $sth = $dbh->prepare("show columns from $tablename");
- $sth->execute();
- my @columns;
- my $column_defs = _get_column_defs($cgi);
- my %tablehash;
- $tablehash{'table'}=$tablename;
- $tablehash{'__first__'} = $first;
- push @columns, \%tablehash;
- while ( my $data = $sth->fetchrow_arrayref() ) {
- my %temphash;
- $temphash{'name'} = "$tablename.$data->[0]";
- $temphash{'description'} = $column_defs->{"$tablename.$data->[0]"};
- push @columns, \%temphash;
- }
- $sth->finish();
- return (@columns);
-}
-
-=item build_query($columns,$criteria,$orderby,$area)
-
-This will build the sql needed to return the results asked for,
-$columns is expected to be of the format tablename.columnname.
-This is what get_columns returns.
-
-=cut
-
-sub build_query {
- my ( $columns, $criteria, $orderby, $area, $totals, $definition ) = @_;
-### $orderby
- my $keys = $keys{$area};
- my $tables = $table_areas{$area};
-
- my $sql =
- _build_query( $tables, $columns, $criteria, $keys, $orderby, $totals, $definition );
- return ($sql);
-}
-
-sub _build_query {
- my ( $tables, $columns, $criteria, $keys, $orderby, $totals, $definition) = @_;
-### $orderby
- # $keys is an array of joining constraints
- my $dbh = C4::Context->dbh();
- my $joinedtables = join( ',', @$tables );
- my $joinedcolumns = join( ',', @$columns );
- my $joinedkeys = join( ' AND ', @$keys );
- my $query =
- "SELECT $totals $joinedcolumns FROM $tables->[0] ";
- for (my $i=1;$i<@$tables;$i++){
- $query .= "LEFT JOIN $tables->[$i] on ($keys->[$i-1]) ";
- }
-
- if ($criteria) {
- $criteria =~ s/AND/WHERE/;
- $query .= " $criteria";
- }
- if ($definition){
- my @definitions = split(',',$definition);
- my $deftext;
- foreach my $def (@definitions){
- my $defin=get_from_dictionary('',$def);
- $deftext .=" ".$defin->[0]->{'saved_sql'};
- }
- if ($query =~ /WHERE/i){
- $query .= $deftext;
- }
- else {
- $deftext =~ s/AND/WHERE/;
- $query .= $deftext;
- }
- }
- if ($totals) {
- my $groupby;
- my @totcolumns = split( ',', $totals );
- foreach my $total (@totcolumns) {
- if ( $total =~ /\((.*)\)/ ) {
- if ( $groupby eq '' ) {
- $groupby = " GROUP BY $1";
- }
- else {
- $groupby .= ",$1";
- }
- }
- }
- $query .= $groupby;
- }
- if ($orderby) {
- $query .= $orderby;
- }
- return ($query);
-}
+=head2 GetDelimiterChoices
-=item get_criteria($area,$cgi);
+=over 4
-Returns an arraref to hashrefs suitable for using in a tmpl_loop. With the criteria and available values.
-
-=cut
-
-sub get_criteria {
- my ($area,$cgi) = @_;
- my $dbh = C4::Context->dbh();
- my $crit = $criteria{$area};
- my $column_defs = _get_column_defs($cgi);
- my @criteria_array;
- foreach my $localcrit (@$crit) {
- my ( $value, $type ) = split( /\|/, $localcrit );
- my ( $table, $column ) = split( /\./, $value );
- if ( $type eq 'date' ) {
- my %temp;
- $temp{'name'} = $value;
- $temp{'date'} = 1;
- $temp{'description'} = $column_defs->{$value};
- push @criteria_array, \%temp;
- }
- else {
-
- my $query =
- "SELECT distinct($column) as availablevalues FROM $table";
- my $sth = $dbh->prepare($query);
- $sth->execute();
- my @values;
- while ( my $row = $sth->fetchrow_hashref() ) {
- push @values, $row;
- ### $row;
- }
- $sth->finish();
- my %temp;
- $temp{'name'} = $value;
- $temp{'description'} = $column_defs->{$value};
- $temp{'values'} = \@values;
- push @criteria_array, \%temp;
- }
- }
- return ( \@criteria_array );
-}
-
-=item execute_query
-
-=over
-
-($results, $total) = execute_query($sql, $type, $offset, $limit, $format, $id)
+my $delims = GetDelimiterChoices;
=back
- When passed C<$sql>, this function returns an array ref containing a result set
- suitably formatted for display in html or for output as a flat file when passed in
- C<$format> and C<$id>. It also returns the C<$total> records available for the
- supplied query. If passed any query other than a SELECT, or if there is a db error,
- C<$errors> an array ref is returned containing the error after this manner:
-
- C<$error->{'sqlerr'}> contains the offending SQL keyword.
- C<$error->{'queryerr'}> contains the native db engine error returned for the query.
-
- Valid values for C<$format> are 'text,' 'tab,' 'csv,' or 'url. C<$sql>, C<$type>,
- C<$offset>, and C<$limit> are required parameters. If a valid C<$format> is passed
- in, C<$offset> and C<$limit> are ignored for obvious reasons. A LIMIT specified by
- the user in a user-supplied SQL query WILL apply in any case.
-
-=cut
-
-sub execute_query ($$$$;$$) {
- my ( $sql, $type, $offset, $limit, $format, $id ) = @_;
- my @params;
- my $total = 0;
- my ($useroffset, $userlimit);
- my @errors = ();
- my $error = {};
- my $sqlerr = 0;
- if ($sql =~ /;?\W?(UPDATE|DELETE|DROP|INSERT|SHOW|CREATE)\W/i) {
- $sqlerr = 1;
- $error->{'sqlerr'} = $1;
- push @errors, $error;
- } elsif ($sql !~ /^(SELECT)/i) {
- $sqlerr = 1;
- $error->{'queryerr'} = 'Missing SELECT';
- push @errors, $error;
- }
- if ($sqlerr == 0) {
- my $dbh = C4::Context->dbh();
- unless ($format eq 'text' || $format eq 'tab' || $format eq 'csv' || $format eq 'url'){
- # Grab offset/limit from user supplied LIMIT and drop the LIMIT so we can control pagination
- if ($sql =~ /LIMIT/i) {
- $sql =~ s/LIMIT\W?(\d+)?\,?\W+?(\d+)//ig;
- $debug and warn "User has supplied LIMIT\n";
- $useroffset = $1;
- $userlimit = $2;
- $debug and warn "User supplied offset = $useroffset, limit = $userlimit\n";
- $offset += $useroffset if $useroffset;
- # keep track of where we are if there is a user supplied LIMIT
- if ( $offset + $limit > $userlimit ) {
- $limit = $userlimit - $offset;
- }
- }
- my $countsql = $sql;
- $sql .= " LIMIT ?, ?";
- $debug and warn "Passing query with params offset = $offset, limit = $limit\n";
- @params = ($offset, $limit);
- # Modify the query passed in to create a count query... (I think this covers all cases -crn)
- $countsql =~ s/\bSELECT\W+(?:\w+\W+){1,}?FROM\b|\bSELECT\W\*\WFROM\b/SELECT count(*) FROM /ig;
- $debug and warn "original query: $sql\n";
- $debug and warn "count query: $countsql\n";
- my $sth1 = $dbh->prepare($countsql);
- $sth1->execute();
- $total = $sth1->fetchrow();
- $debug and warn "total records for this query: $total\n";
- $total = $userlimit if defined($userlimit) and $userlimit < $total; # we will never exceed a user defined LIMIT and...
- $userlimit = $total if defined($userlimit) and $userlimit > $total; # we will never exceed the total number of records available to satisfy the query
- }
- my $sth = $dbh->prepare($sql);
- $sth->execute(@params);
- my $colnames=$sth->{'NAME'};
- my @results;
- my $row;
- my %temphash;
- $row = join ('</th><th>',@$colnames);
- $row = "<tr><th>$row</th></tr>";
- $temphash{'row'} = $row;
- push @results, \%temphash;
- my $string;
- if ($format eq 'tab') {
- $string = join("\t",@$colnames);
- }
- if ($format eq 'csv') {
- $string = join(",",@$colnames);
- }
- my @xmlarray;
- while ( my @data = $sth->fetchrow_array() ) {
- # if the field is a date field, it needs formatting
- foreach my $data (@data) {
- next unless $data =~ C4::Dates->regexp("iso");
- my $date = C4::Dates->new($data, "iso");
- $data = $date->output();
- }
- # tabular
- my %temphash;
- my $row = join( '</td><td>', @data );
- $row = "<tr><td>$row</td></tr>";
- $temphash{'row'} = $row;
- if ( $format eq 'text' ) {
- $string .= "\n" . $row;
- }
- if ($format eq 'tab' ){
- $row = join("\t", at data);
- $string .="\n" . $row;
- }
- if ($format eq 'csv' ){
- $row = join(",", at data);
- $string .="\n" . $row;
- }
- if ($format eq 'url'){
- my $temphash;
- @$temphash{@$colnames}=@data;
- push @xmlarray,$temphash;
- }
- push @results, \%temphash;
- }
- if (defined($sth->errstr)) {
- $error->{'queryerr'} = $sth->errstr;
- push @errors, $error;
- warn "Database returned: $sth->errstr";
- }
- if ( $format eq 'text' || $format eq 'tab' || $format eq 'csv' ) {
- return $string, $total, \@errors;
- }
- elsif ($format eq 'url') {
- my $url = "/cgi-bin/koha/reports/guided_reports.pl?phase=retrieve%20results&id=$id";
- my $dump = new XML::Dumper;
- my $xml = $dump->pl2xml( \@xmlarray );
- store_results($id,$xml);
- return $url, $total, \@errors;
- }
- else {
- return \@results, $total, \@errors;
- }
- } else {
- return undef, undef, \@errors;
- }
-}
-
-=item save_report($sql,$name,$type,$notes)
-
-Given some sql and a name this will saved it so that it can resued
+This will return a list of all the available delimiters.
=cut
-sub save_report {
- my ( $sql, $name, $type, $notes ) = @_;
- my $dbh = C4::Context->dbh();
- my $query =
-"INSERT INTO saved_sql (borrowernumber,date_created,last_modified,savedsql,report_name,type,notes) VALUES (?,now(),now(),?,?,?,?)";
- my $sth = $dbh->prepare($query);
- $sth->execute( 0, $sql, $name, $type, $notes );
- $sth->finish();
-
-}
-
-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);
- $sth2->finish();
- }
- else {
- my $query2 = "INSERT INTO saved_reports (report_id,report,date_run) VALUES (?,?,now())";
- my $sth2 = $dbh->prepare($query2);
- $sth2->execute($id,$xml);
- $sth2->finish();
- }
- $sth->finish();
-}
-
-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();
- $sth->finish();
- return ($perl,$data->{'report_name'},$data->{'notes'});
-}
+sub GetDelimiterChoices {
+ my $dbh = C4::Context->dbh;
-sub delete_report {
- my ( $id ) = @_;
- my $dbh = C4::Context->dbh();
- my $query = "DELETE FROM saved_sql WHERE id = ?";
- my $sth = $dbh->prepare($query);
- $sth->execute($id);
- $sth->finish();
-}
+ my $sth = $dbh->prepare("
+ SELECT options, value
+ FROM systempreferences
+ WHERE variable = 'delimiter'
+ ");
-sub get_saved_reports {
- my $dbh = C4::Context->dbh();
- my $query = "SELECT *,saved_sql.id AS id FROM saved_sql
- LEFT JOIN saved_reports ON saved_reports.report_id = saved_sql.id
- ORDER by date_created";
- my $sth = $dbh->prepare($query);
$sth->execute();
- my @reports;
- while ( my $data = $sth->fetchrow_hashref() ) {
- push @reports, $data;
- }
- $sth->finish();
- return ( \@reports );
-}
-
-sub get_saved_report {
- my ($id) = @_;
- my $dbh = C4::Context->dbh();
- my $query = " SELECT * FROM saved_sql WHERE id = ?";
- my $sth = $dbh->prepare($query);
- $sth->execute($id);
- my $data = $sth->fetchrow_hashref();
- $sth->finish();
- return ( $data->{'savedsql'}, $data->{'type'}, $data->{'report_name'}, $data->{'notes'} );
-}
-
-=item 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 ($mastersql,$mastertype) = get_saved_report($masterID);
- my ($subsql,$subtype) = get_saved_report($subreportID);
-
- # 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);
-}
-
-=item get_column_type($column)
-
-This takes a column name of the format table.column and will return what type it is
-(free text, set values, date)
-
-=cut
-
-sub get_column_type {
- my ($tablecolumn) = @_;
- my ($table,$column) = split(/\./,$tablecolumn);
- my $dbh = C4::Context->dbh();
- my $catalog;
- my $schema;
-
- # mysql doesnt 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()){
- if ($info->{'COLUMN_NAME'} eq $column){
- #column we want
- if ($info->{'TYPE_NAME'} eq 'CHAR' || $info->{'TYPE_NAME'} eq 'VARCHAR'){
- $info->{'TYPE_NAME'} = 'distinct';
- }
- return $info->{'TYPE_NAME'};
- }
- }
- $sth->finish();
-}
-
-=item get_distinct_values($column)
-
-Given a column name, return an arrary ref of hashrefs suitable for use as a tmpl_loop
-with the distinct values of the column
-
-=cut
-
-sub get_distinct_values {
- my ($tablecolumn) = @_;
- my ($table,$column) = split(/\./,$tablecolumn);
- my $dbh = C4::Context->dbh();
- my $query =
- "SELECT distinct($column) as availablevalues FROM $table";
- my $sth = $dbh->prepare($query);
- $sth->execute();
- my @values;
- while ( my $row = $sth->fetchrow_hashref() ) {
- push @values, $row;
- }
- $sth->finish();
- return \@values;
-}
-
-sub save_dictionary {
- my ($name,$description,$sql,$area) = @_;
- my $dbh = C4::Context->dbh();
- my $query = "INSERT INTO reports_dictionary (name,description,saved_sql,area,date_created,date_modified)
- VALUES (?,?,?,?,now(),now())";
- my $sth = $dbh->prepare($query);
- $sth->execute($name,$description,$sql,$area) || return 0;
- $sth->finish();
- return 1;
-}
-sub get_from_dictionary {
- my ($area,$id) = @_;
- my $dbh = C4::Context->dbh();
- my $query = "SELECT * FROM reports_dictionary";
- if ($area){
- $query.= " WHERE area = ?";
- }
- elsif ($id){
- $query.= " WHERE id = ?"
- }
- my $sth = $dbh->prepare($query);
- if ($id){
- $sth->execute($id);
- }
- elsif ($area) {
- $sth->execute($area);
- }
- else {
- $sth->execute();
- }
- my @loop;
- my @reports = ( 'Circulation', 'Catalog', 'Patrons', 'Acquisitions', 'Accounts');
- while (my $data = $sth->fetchrow_hashref()){
- $data->{'areaname'}=$reports[$data->{'area'}-1];
- push @loop,$data;
-
- }
- $sth->finish();
- return (\@loop);
-}
-
-sub delete_definition {
- my ($id) = @_;
- my $dbh = C4::Context->dbh();
- my $query = "DELETE FROM reports_dictionary WHERE id = ?";
- my $sth = $dbh->prepare($query);
- $sth->execute($id);
- $sth->finish();
-}
+ my ($choices, $default) = $sth->fetchrow;
+ my @dels = split /\|/, $choices;
-sub get_sql {
- my ($id) = @_;
- my $dbh = C4::Context->dbh();
- my $query = "SELECT * FROM saved_sql WHERE id = ?";
- my $sth = $dbh->prepare($query);
- $sth->execute($id);
- my $data=$sth->fetchrow_hashref();
- $sth->finish();
- return $data->{'savedsql'};
+ return CGI::scrolling_list(
+ -name => 'sep',
+ -id => 'sep',
+ -default => $default,
+ -values => \@dels,
+ -size => 1,
+ -multiple => 0 );
}
-sub _get_column_defs {
- my ($cgi) = @_;
- my %columns;
- my $columns_def_file = "columns.def";
- my $htdocs = C4::Context->config('intrahtdocs');
- my $section='intranet';
- my ($theme, $lang) = themelanguage($htdocs, $columns_def_file, $section,$cgi);
-
- my $full_path_to_columns_def_file="$htdocs/$theme/$lang/$columns_def_file";
- open (COLUMNS,$full_path_to_columns_def_file);
- while (my $input = <COLUMNS>){
- my @row =split(/\t/,$input);
- $columns{$row[0]}=$row[1];
- }
-
- close COLUMNS;
- return \%columns;
-}
1;
-__END__
-=back
+__END__
=head1 AUTHOR
-Chris Cormack <crc at liblime.com>
+Jesse Weaver <jesse.weaver at liblime.com>
=cut
diff --git a/C4/Reports/Guided.pm b/C4/Reports/Guided.pm
new file mode 100644
index 0000000..ce5876e
--- /dev/null
+++ b/C4/Reports/Guided.pm
@@ -0,0 +1,742 @@
+package C4::Reports::Guided;
+
+# Copyright 2007 Liblime Ltd
+#
+# This file is part of Koha.
+#
+# Koha is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later
+# version.
+#
+# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
+# Suite 330, Boston, MA 02111-1307 USA
+
+use strict;
+use CGI;
+
+use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
+use C4::Context;
+use C4::Output;
+use XML::Simple;
+use XML::Dumper;
+use C4::Debug;
+# use Smart::Comments;
+# use Data::Dumper;
+
+BEGIN {
+ # set the version for version checking
+ $VERSION = 0.12;
+ require Exporter;
+ @ISA = qw(Exporter);
+ @EXPORT = qw(
+ get_report_types get_report_areas get_columns build_query get_criteria
+ save_report get_saved_reports execute_query get_saved_report create_compound run_compound
+ get_column_type get_distinct_values save_dictionary get_from_dictionary
+ delete_definition delete_report format_results get_sql
+ );
+}
+
+our %table_areas;
+$table_areas{'1'} =
+ [ 'borrowers', 'statistics','items', 'biblioitems' ]; # circulation
+$table_areas{'2'} = [ 'items', 'biblioitems', 'biblio' ]; # catalogue
+$table_areas{'3'} = [ 'borrowers' ]; # patrons
+$table_areas{'4'} = ['aqorders', 'biblio', 'items']; # acquisitions
+$table_areas{'5'} = [ 'borrowers', 'accountlines' ]; # accounts
+our %keys;
+$keys{'1'} = [
+ 'statistics.borrowernumber=borrowers.borrowernumber',
+ 'items.itemnumber = statistics.itemnumber',
+ 'biblioitems.biblioitemnumber = items.biblioitemnumber'
+];
+$keys{'2'} = [
+ 'items.biblioitemnumber=biblioitems.biblioitemnumber',
+ 'biblioitems.biblionumber=biblio.biblionumber'
+];
+$keys{'3'} = [ ];
+$keys{'4'} = [
+ 'aqorders.biblionumber=biblio.biblionumber',
+ 'biblio.biblionumber=items.biblionumber'
+];
+$keys{'5'} = ['borrowers.borrowernumber=accountlines.borrowernumber'];
+
+# have to do someting here to know if its dropdown, free text, date etc
+
+our %criteria;
+$criteria{'1'} = [
+ 'statistics.type', 'borrowers.categorycode',
+ 'statistics.branch',
+ 'biblioitems.publicationyear|date',
+ 'items.dateaccessioned|date'
+];
+$criteria{'2'} =
+ [ 'items.holdingbranch', 'items.homebranch' ,'items.itemlost', 'items.location', 'items.ccode'];
+$criteria{'3'} = ['borrowers.branchcode'];
+$criteria{'4'} = ['aqorders.datereceived|date'];
+$criteria{'5'} = ['borrowers.branchcode'];
+
+if (C4::Context->preference('item-level_itypes')) {
+ unshift @{ $criteria{'1'} }, 'items.itype';
+ unshift @{ $criteria{'2'} }, 'items.itype';
+} else {
+ unshift @{ $criteria{'1'} }, 'biblioitems.itemtype';
+ unshift @{ $criteria{'2'} }, 'biblioitems.itemtype';
+}
+
+=head1 NAME
+
+C4::Reports::Guided - Module for generating guided reports
+
+=head1 SYNOPSIS
+
+ use C4::Reports::Guided;
+
+=head1 DESCRIPTION
+
+
+=head1 METHODS
+
+=over 2
+
+=cut
+
+=item get_report_types()
+
+This will return a list of all the available report types
+
+=cut
+
+sub get_report_types {
+ my $dbh = C4::Context->dbh();
+
+ # FIXME these should be in the database perhaps
+ my @reports = ( 'Tabular', 'Summary', 'Matrix' );
+ my @reports2;
+ for ( my $i = 0 ; $i < 3 ; $i++ ) {
+ my %hashrep;
+ $hashrep{id} = $i + 1;
+ $hashrep{name} = $reports[$i];
+ push @reports2, \%hashrep;
+ }
+ return ( \@reports2 );
+
+}
+
+=item get_report_areas()
+
+This will return a list of all the available report areas
+
+=cut
+
+sub get_report_areas {
+ my $dbh = C4::Context->dbh();
+
+ # FIXME these should be in the database
+ my @reports = ( 'Circulation', 'Catalog', 'Patrons', 'Acquisitions', 'Accounts');
+ my @reports2;
+ for ( my $i = 0 ; $i < 5 ; $i++ ) {
+ my %hashrep;
+ $hashrep{id} = $i + 1;
+ $hashrep{name} = $reports[$i];
+ push @reports2, \%hashrep;
+ }
+ return ( \@reports2 );
+
+}
+
+=item get_all_tables()
+
+This will return a list of all tables in the database
+
+=cut
+
+sub get_all_tables {
+ my $dbh = C4::Context->dbh();
+ my $query = "SHOW TABLES";
+ my $sth = $dbh->prepare($query);
+ $sth->execute();
+ my @tables;
+ while ( my $data = $sth->fetchrow_arrayref() ) {
+ push @tables, $data->[0];
+ }
+ $sth->finish();
+ return ( \@tables );
+
+}
+
+=item get_columns($area)
+
+This will return a list of all columns for a report area
+
+=cut
+
+sub get_columns {
+
+ # this calls the internal fucntion _get_columns
+ my ($area,$cgi) = @_;
+ my $tables = $table_areas{$area};
+ my @allcolumns;
+ my $first = 1;
+ foreach my $table (@$tables) {
+ my @columns = _get_columns($table,$cgi, $first);
+ $first = 0;
+ push @allcolumns, @columns;
+ }
+ return ( \@allcolumns );
+}
+
+sub _get_columns {
+ my ($tablename,$cgi, $first) = @_;
+ my $dbh = C4::Context->dbh();
+ my $sth = $dbh->prepare("show columns from $tablename");
+ $sth->execute();
+ my @columns;
+ my $column_defs = _get_column_defs($cgi);
+ my %tablehash;
+ $tablehash{'table'}=$tablename;
+ $tablehash{'__first__'} = $first;
+ push @columns, \%tablehash;
+ while ( my $data = $sth->fetchrow_arrayref() ) {
+ my %temphash;
+ $temphash{'name'} = "$tablename.$data->[0]";
+ $temphash{'description'} = $column_defs->{"$tablename.$data->[0]"};
+ push @columns, \%temphash;
+ }
+ $sth->finish();
+ return (@columns);
+}
+
+=item build_query($columns,$criteria,$orderby,$area)
+
+This will build the sql needed to return the results asked for,
+$columns is expected to be of the format tablename.columnname.
+This is what get_columns returns.
+
+=cut
+
+sub build_query {
+ my ( $columns, $criteria, $orderby, $area, $totals, $definition ) = @_;
+### $orderby
+ my $keys = $keys{$area};
+ my $tables = $table_areas{$area};
+
+ my $sql =
+ _build_query( $tables, $columns, $criteria, $keys, $orderby, $totals, $definition );
+ return ($sql);
+}
+
+sub _build_query {
+ my ( $tables, $columns, $criteria, $keys, $orderby, $totals, $definition) = @_;
+### $orderby
+ # $keys is an array of joining constraints
+ my $dbh = C4::Context->dbh();
+ my $joinedtables = join( ',', @$tables );
+ my $joinedcolumns = join( ',', @$columns );
+ my $joinedkeys = join( ' AND ', @$keys );
+ my $query =
+ "SELECT $totals $joinedcolumns FROM $tables->[0] ";
+ for (my $i=1;$i<@$tables;$i++){
+ $query .= "LEFT JOIN $tables->[$i] on ($keys->[$i-1]) ";
+ }
+
+ if ($criteria) {
+ $criteria =~ s/AND/WHERE/;
+ $query .= " $criteria";
+ }
+ if ($definition){
+ my @definitions = split(',',$definition);
+ my $deftext;
+ foreach my $def (@definitions){
+ my $defin=get_from_dictionary('',$def);
+ $deftext .=" ".$defin->[0]->{'saved_sql'};
+ }
+ if ($query =~ /WHERE/i){
+ $query .= $deftext;
+ }
+ else {
+ $deftext =~ s/AND/WHERE/;
+ $query .= $deftext;
+ }
+ }
+ if ($totals) {
+ my $groupby;
+ my @totcolumns = split( ',', $totals );
+ foreach my $total (@totcolumns) {
+ if ( $total =~ /\((.*)\)/ ) {
+ if ( $groupby eq '' ) {
+ $groupby = " GROUP BY $1";
+ }
+ else {
+ $groupby .= ",$1";
+ }
+ }
+ }
+ $query .= $groupby;
+ }
+ if ($orderby) {
+ $query .= $orderby;
+ }
+ return ($query);
+}
+
+=item get_criteria($area,$cgi);
+
+Returns an arraref to hashrefs suitable for using in a tmpl_loop. With the criteria and available values.
+
+=cut
+
+sub get_criteria {
+ my ($area,$cgi) = @_;
+ my $dbh = C4::Context->dbh();
+ my $crit = $criteria{$area};
+ my $column_defs = _get_column_defs($cgi);
+ my @criteria_array;
+ foreach my $localcrit (@$crit) {
+ my ( $value, $type ) = split( /\|/, $localcrit );
+ my ( $table, $column ) = split( /\./, $value );
+ if ( $type eq 'date' ) {
+ my %temp;
+ $temp{'name'} = $value;
+ $temp{'date'} = 1;
+ $temp{'description'} = $column_defs->{$value};
+ push @criteria_array, \%temp;
+ }
+ else {
+
+ my $query =
+ "SELECT distinct($column) as availablevalues FROM $table";
+ my $sth = $dbh->prepare($query);
+ $sth->execute();
+ my @values;
+ while ( my $row = $sth->fetchrow_hashref() ) {
+ push @values, $row;
+ ### $row;
+ }
+ $sth->finish();
+ my %temp;
+ $temp{'name'} = $value;
+ $temp{'description'} = $column_defs->{$value};
+ $temp{'values'} = \@values;
+ push @criteria_array, \%temp;
+ }
+ }
+ return ( \@criteria_array );
+}
+
+=item execute_query
+
+=over
+
+($results, $total) = execute_query($sql, $type, $offset, $limit, $format, $id)
+
+=back
+
+ When passed C<$sql>, this function returns an array ref containing a result set
+ suitably formatted for display in html or for output as a flat file when passed in
+ C<$format> and C<$id>. It also returns the C<$total> records available for the
+ supplied query. If passed any query other than a SELECT, or if there is a db error,
+ C<$errors> an array ref is returned containing the error after this manner:
+
+ C<$error->{'sqlerr'}> contains the offending SQL keyword.
+ C<$error->{'queryerr'}> contains the native db engine error returned for the query.
+
+ Valid values for C<$format> are 'text,' 'tab,' 'csv,' or 'url. C<$sql>, C<$type>,
+ C<$offset>, and C<$limit> are required parameters. If a valid C<$format> is passed
+ in, C<$offset> and C<$limit> are ignored for obvious reasons. A LIMIT specified by
+ the user in a user-supplied SQL query WILL apply in any case.
+
+=cut
+
+# FIXME: This needs to be generalized to reports in general
+
+sub execute_query ($$$$;$$) {
+ my ( $sql, $type, $offset, $limit, $format, $id ) = @_;
+ my @params;
+ my $total = 0;
+ my ($useroffset, $userlimit);
+ my @errors = ();
+ my $error = {};
+ my $sqlerr = 0;
+ if ($sql =~ /;?\W?(UPDATE|DELETE|DROP|INSERT|SHOW|CREATE)\W/i) {
+ $sqlerr = 1;
+ $error->{'sqlerr'} = $1;
+ push @errors, $error;
+ } elsif ($sql !~ /^(SELECT)/i) {
+ $sqlerr = 1;
+ $error->{'queryerr'} = 'Missing SELECT';
+ push @errors, $error;
+ }
+ if ($sqlerr == 0) {
+ my $dbh = C4::Context->dbh();
+ unless ($format eq 'text' || $format eq 'tab' || $format eq 'csv' || $format eq 'url'){
+ # Grab offset/limit from user supplied LIMIT and drop the LIMIT so we can control pagination
+ if ($sql =~ /LIMIT/i) {
+ $sql =~ s/LIMIT\W?(\d+)?\,?\W+?(\d+)//ig;
+ $debug and warn "User has supplied LIMIT\n";
+ $useroffset = $1;
+ $userlimit = $2;
+ $debug and warn "User supplied offset = $useroffset, limit = $userlimit\n";
+ $offset += $useroffset if $useroffset;
+ # keep track of where we are if there is a user supplied LIMIT
+ if ( $offset + $limit > $userlimit ) {
+ $limit = $userlimit - $offset;
+ }
+ }
+ my $countsql = $sql;
+ $sql .= " LIMIT ?, ?";
+ $debug and warn "Passing query with params offset = $offset, limit = $limit\n";
+ @params = ($offset, $limit);
+ # Modify the query passed in to create a count query... (I think this covers all cases -crn)
+ $countsql =~ s/\bSELECT\W+(?:\w+\W+){1,}?FROM\b|\bSELECT\W\*\WFROM\b/SELECT count(*) FROM /ig;
+ $debug and warn "original query: $sql\n";
+ $debug and warn "count query: $countsql\n";
+ my $sth1 = $dbh->prepare($countsql);
+ $sth1->execute();
+ $total = $sth1->fetchrow();
+ $debug and warn "total records for this query: $total\n";
+ $total = $userlimit if defined($userlimit) and $userlimit < $total; # we will never exceed a user defined LIMIT and...
+ $userlimit = $total if defined($userlimit) and $userlimit > $total; # we will never exceed the total number of records available to satisfy the query
+ }
+ my $sth = $dbh->prepare($sql);
+ $sth->execute(@params);
+ my $colnames=$sth->{'NAME'};
+ my @results;
+ my $row;
+ my %temphash;
+ $row = join ('</th><th>',@$colnames);
+ $row = "<tr><th>$row</th></tr>";
+ $temphash{'row'} = $row;
+ push @results, \%temphash;
+ my $string;
+ if ($format eq 'tab') {
+ $string = join("\t",@$colnames);
+ }
+ if ($format eq 'csv') {
+ $string = join(",",@$colnames);
+ }
+ my @xmlarray;
+ while ( my @data = $sth->fetchrow_array() ) {
+ # if the field is a date field, it needs formatting
+ foreach my $data (@data) {
+ next unless $data =~ C4::Dates->regexp("iso");
+ my $date = C4::Dates->new($data, "iso");
+ $data = $date->output();
+ }
+ # tabular
+ my %temphash;
+ my $row = join( '</td><td>', @data );
+ $row = "<tr><td>$row</td></tr>";
+ $temphash{'row'} = $row;
+ if ( $format eq 'text' ) {
+ $string .= "\n" . $row;
+ }
+ if ($format eq 'tab' ){
+ $row = join("\t", at data);
+ $string .="\n" . $row;
+ }
+ if ($format eq 'csv' ){
+ $row = join(",", at data);
+ $string .="\n" . $row;
+ }
+ if ($format eq 'url'){
+ my $temphash;
+ @$temphash{@$colnames}=@data;
+ push @xmlarray,$temphash;
+ }
+ push @results, \%temphash;
+ }
+ if (defined($sth->errstr)) {
+ $error->{'queryerr'} = $sth->errstr;
+ push @errors, $error;
+ warn "Database returned: $sth->errstr";
+ }
+ if ( $format eq 'text' || $format eq 'tab' || $format eq 'csv' ) {
+ return $string, $total, \@errors;
+ }
+ elsif ($format eq 'url') {
+ my $url = "/cgi-bin/koha/reports/guided_reports.pl?phase=retrieve%20results&id=$id";
+ my $dump = new XML::Dumper;
+ my $xml = $dump->pl2xml( \@xmlarray );
+ store_results($id,$xml);
+ return $url, $total, \@errors;
+ }
+ else {
+ return \@results, $total, \@errors;
+ }
+ } else {
+ return undef, undef, \@errors;
+ }
+}
+
+=item save_report($sql,$name,$type,$notes)
+
+Given some sql and a name this will saved it so that it can resued
+
+=cut
+
+sub save_report {
+ my ( $sql, $name, $type, $notes ) = @_;
+ my $dbh = C4::Context->dbh();
+ my $query =
+"INSERT INTO saved_sql (borrowernumber,date_created,last_modified,savedsql,report_name,type,notes) VALUES (?,now(),now(),?,?,?,?)";
+ my $sth = $dbh->prepare($query);
+ $sth->execute( 0, $sql, $name, $type, $notes );
+ $sth->finish();
+
+}
+
+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);
+ $sth2->finish();
+ }
+ else {
+ my $query2 = "INSERT INTO saved_reports (report_id,report,date_run) VALUES (?,?,now())";
+ my $sth2 = $dbh->prepare($query2);
+ $sth2->execute($id,$xml);
+ $sth2->finish();
+ }
+ $sth->finish();
+}
+
+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();
+ $sth->finish();
+ return ($perl,$data->{'report_name'},$data->{'notes'});
+}
+
+sub delete_report {
+ my ( $id ) = @_;
+ my $dbh = C4::Context->dbh();
+ my $query = "DELETE FROM saved_sql WHERE id = ?";
+ my $sth = $dbh->prepare($query);
+ $sth->execute($id);
+ $sth->finish();
+}
+
+sub get_saved_reports {
+ my $dbh = C4::Context->dbh();
+ my $query = "SELECT *,saved_sql.id AS id FROM saved_sql
+ LEFT JOIN saved_reports ON saved_reports.report_id = saved_sql.id
+ ORDER by date_created";
+ my $sth = $dbh->prepare($query);
+ $sth->execute();
+ my @reports;
+ while ( my $data = $sth->fetchrow_hashref() ) {
+ push @reports, $data;
+ }
+ $sth->finish();
+ return ( \@reports );
+}
+
+sub get_saved_report {
+ my ($id) = @_;
+ my $dbh = C4::Context->dbh();
+ my $query = " SELECT * FROM saved_sql WHERE id = ?";
+ my $sth = $dbh->prepare($query);
+ $sth->execute($id);
+ my $data = $sth->fetchrow_hashref();
+ $sth->finish();
+ return ( $data->{'savedsql'}, $data->{'type'}, $data->{'report_name'}, $data->{'notes'} );
+}
+
+=item 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 ($mastersql,$mastertype) = get_saved_report($masterID);
+ my ($subsql,$subtype) = get_saved_report($subreportID);
+
+ # 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);
+}
+
+=item get_column_type($column)
+
+This takes a column name of the format table.column and will return what type it is
+(free text, set values, date)
+
+=cut
+
+sub get_column_type {
+ my ($tablecolumn) = @_;
+ my ($table,$column) = split(/\./,$tablecolumn);
+ my $dbh = C4::Context->dbh();
+ my $catalog;
+ my $schema;
+
+ # mysql doesnt 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()){
+ if ($info->{'COLUMN_NAME'} eq $column){
+ #column we want
+ if ($info->{'TYPE_NAME'} eq 'CHAR' || $info->{'TYPE_NAME'} eq 'VARCHAR'){
+ $info->{'TYPE_NAME'} = 'distinct';
+ }
+ return $info->{'TYPE_NAME'};
+ }
+ }
+ $sth->finish();
+}
+
+=item get_distinct_values($column)
+
+Given a column name, return an arrary ref of hashrefs suitable for use as a tmpl_loop
+with the distinct values of the column
+
+=cut
+
+sub get_distinct_values {
+ my ($tablecolumn) = @_;
+ my ($table,$column) = split(/\./,$tablecolumn);
+ my $dbh = C4::Context->dbh();
+ my $query =
+ "SELECT distinct($column) as availablevalues FROM $table";
+ my $sth = $dbh->prepare($query);
+ $sth->execute();
+ my @values;
+ while ( my $row = $sth->fetchrow_hashref() ) {
+ push @values, $row;
+ }
+ $sth->finish();
+ return \@values;
+}
+
+sub save_dictionary {
+ my ($name,$description,$sql,$area) = @_;
+ my $dbh = C4::Context->dbh();
+ my $query = "INSERT INTO reports_dictionary (name,description,saved_sql,area,date_created,date_modified)
+ VALUES (?,?,?,?,now(),now())";
+ my $sth = $dbh->prepare($query);
+ $sth->execute($name,$description,$sql,$area) || return 0;
+ $sth->finish();
+ return 1;
+}
+
+sub get_from_dictionary {
+ my ($area,$id) = @_;
+ my $dbh = C4::Context->dbh();
+ my $query = "SELECT * FROM reports_dictionary";
+ if ($area){
+ $query.= " WHERE area = ?";
+ }
+ elsif ($id){
+ $query.= " WHERE id = ?"
+ }
+ my $sth = $dbh->prepare($query);
+ if ($id){
+ $sth->execute($id);
+ }
+ elsif ($area) {
+ $sth->execute($area);
+ }
+ else {
+ $sth->execute();
+ }
+ my @loop;
+ my @reports = ( 'Circulation', 'Catalog', 'Patrons', 'Acquisitions', 'Accounts');
+ while (my $data = $sth->fetchrow_hashref()){
+ $data->{'areaname'}=$reports[$data->{'area'}-1];
+ push @loop,$data;
+
+ }
+ $sth->finish();
+ return (\@loop);
+}
+
+sub delete_definition {
+ my ($id) = @_;
+ my $dbh = C4::Context->dbh();
+ my $query = "DELETE FROM reports_dictionary WHERE id = ?";
+ my $sth = $dbh->prepare($query);
+ $sth->execute($id);
+ $sth->finish();
+}
+
+sub get_sql {
+ my ($id) = @_;
+ my $dbh = C4::Context->dbh();
+ my $query = "SELECT * FROM saved_sql WHERE id = ?";
+ my $sth = $dbh->prepare($query);
+ $sth->execute($id);
+ my $data=$sth->fetchrow_hashref();
+ $sth->finish();
+ return $data->{'savedsql'};
+}
+
+sub _get_column_defs {
+ my ($cgi) = @_;
+ my %columns;
+ my $columns_def_file = "columns.def";
+ my $htdocs = C4::Context->config('intrahtdocs');
+ my $section='intranet';
+ my ($theme, $lang) = themelanguage($htdocs, $columns_def_file, $section,$cgi);
+
+ my $full_path_to_columns_def_file="$htdocs/$theme/$lang/$columns_def_file";
+ open (COLUMNS,$full_path_to_columns_def_file);
+ while (my $input = <COLUMNS>){
+ my @row =split(/\t/,$input);
+ $columns{$row[0]}=$row[1];
+ }
+
+ close COLUMNS;
+ return \%columns;
+}
+1;
+__END__
+
+=back
+
+=head1 AUTHOR
+
+Chris Cormack <crc at liblime.com>
+
+=cut
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/reports/bor_issues_top.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/reports/bor_issues_top.tmpl
index 9f5ffba..300e491 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/reports/bor_issues_top.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/reports/bor_issues_top.tmpl
@@ -256,12 +256,8 @@ function Dopop(link) {
<option value="<!-- TMPL_VAR NAME="type" -->"><!-- TMPL_VAR NAME="type" --></option>
<!-- /TMPL_LOOP -->
</select>
- <!-- <label class="inline" for="sep">Delimiter: </label> -->
- <select name="sep" id="sep">
- <!-- TMPL_LOOP NAME="seploop" -->
- <option value="<!-- TMPL_VAR NAME="delim" -->"><!-- TMPL_VAR NAME="delim" --></option>
- <!-- /TMPL_LOOP -->
- </select>
+ <label class="inline" for="sep">Delimiter: </label>
+ <!-- TMPL_VAR NAME="CGIseplist" -->
</li>
</ol>
</fieldset>
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/reports/catalogue_stats.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/reports/catalogue_stats.tmpl
index d8a5cc5..e4ea2d3 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/reports/catalogue_stats.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/reports/catalogue_stats.tmpl
@@ -200,11 +200,7 @@
<!-- /TMPL_LOOP -->
</select>
<!-- <label class="inline" for="sep">Delimiter: </label> -->
- <select name="sep" id="sep">
- <!-- TMPL_LOOP NAME="CGIsepChoice" -->
- <option value="<!-- TMPL_VAR NAME="delim" -->"><!-- TMPL_VAR NAME="delim" --></option>
- <!-- /TMPL_LOOP -->
- </select>
+ <!-- TMPL_VAR NAME="CGIsepChoice" -->
</li>
</ol>
</fieldset>
diff --git a/reports/acquisitions_stats.pl b/reports/acquisitions_stats.pl
index efa7bf2..ef827ca 100755
--- a/reports/acquisitions_stats.pl
+++ b/reports/acquisitions_stats.pl
@@ -24,7 +24,7 @@ use strict;
use C4::Auth;
use CGI;
use C4::Context;
-
+use C4::Reports;
use C4::Output;
use C4::Koha;
use C4::Circulation;
@@ -57,7 +57,6 @@ my $calc = $input->param("Cellvalue");
my $output = $input->param("output");
my $basename = $input->param("basename");
my $mime = $input->param("MIME");
-my $del = $input->param("sep");
#warn "calcul : ".$calc;
my ($template, $borrowernumber, $cookie)
@@ -68,6 +67,8 @@ my ($template, $borrowernumber, $cookie)
flagsrequired => {reports => 1},
debug => 1,
});
+our $sep = $input->param("sep");
+$sep = "\t" if ($sep eq 'tabulation');
$template->param(do_it => $do_it,
DHTMLcalendar_dateformat => C4::Dates->DHTMLcalendar(),
);
@@ -88,8 +89,6 @@ if ($do_it) {
);
my $cols = @$results[0]->{loopcol};
my $lines = @$results[0]->{looprow};
- my $sep;
- $sep = C4::Context->preference("delimiter");
print @$results[0]->{line} . "/" . @$results[0]->{column} . $sep;
foreach my $col (@$cols) {
print $col->{coltitle} . $sep;
@@ -243,14 +242,7 @@ else {
-multiple => 0
);
- my @dels = ( C4::Context->preference("delimiter") );
- my $CGIsepChoice = CGI::scrolling_list(
- -name => 'sep',
- -id => 'sep',
- -values => \@dels,
- -size => 1,
- -multiple => 0
- );
+ my $CGIsepChoice = GetDelimiterChoices;
$template->param(
CGIBookSeller => $CGIBookSellers,
diff --git a/reports/bor_issues_top.pl b/reports/bor_issues_top.pl
index f9cf661..12a6168 100755
--- a/reports/bor_issues_top.pl
+++ b/reports/bor_issues_top.pl
@@ -26,6 +26,7 @@ use C4::Branch; # GetBranches
use C4::Koha;
use C4::Circulation;
use C4::Members;
+use C4::Reports;
use C4::Debug;
use C4::Dates qw(format_date format_date_in_iso);
@@ -54,7 +55,6 @@ foreach ( @filters[0..3] ) {
my $output = $input->param("output");
my $basename = $input->param("basename");
# my $mime = $input->param("MIME");
-my $del = $input->param("sep");
my ($template, $borrowernumber, $cookie)
= get_template_and_user({template_name => $fullreportname,
query => $input,
@@ -63,6 +63,8 @@ my ($template, $borrowernumber, $cookie)
flagsrequired => {reports => 1},
debug => 1,
});
+our $sep = $input->param("sep");
+$sep = "\t" if ($sep eq 'tabulation');
$template->param(do_it => $do_it,
DHTMLcalendar_dateformat => C4::Dates->DHTMLcalendar(),
);
@@ -81,8 +83,6 @@ if ($do_it) {
-filename=>"$basename.csv" );
my $cols = @$results[0]->{loopcol};
my $lines = @$results[0]->{looprow};
- my $sep;
- $sep =C4::Context->preference("delimiter");
# header top-right
print @$results[0]->{line} ."/". @$results[0]->{column} .$sep;
# Other header
@@ -110,7 +110,7 @@ my @values;
# here each element returned by map is a hashref, get it?
my @mime = ( map { +{type =>$_} } (split /[;:]/,C4::Context->preference("MIME")) );
-my @delim = ( map { +{delim=>$_} } (split //,C4::Context->preference("delimiter")) );
+my $delims = GetDelimiterChoices;
my $branches = GetBranches;
my @branchloop;
foreach (sort keys %$branches) {
@@ -142,7 +142,7 @@ foreach (sort keys %$labels) {
$template->param(
mimeloop => \@mime,
- seploop => \@delim,
+ CGIseplist => $delims,
branchloop => \@branchloop,
itemtypeloop => \@itemtypeloop,
borcatloop => \@borcatloop,
diff --git a/reports/borrowers_out.pl b/reports/borrowers_out.pl
index 763fa7e..939e673 100755
--- a/reports/borrowers_out.pl
+++ b/reports/borrowers_out.pl
@@ -24,6 +24,7 @@ use C4::Context;
use C4::Koha;
use C4::Output;
use C4::Circulation;
+use C4::Reports;
use C4::Members;
use C4::Dates qw/format_date_in_iso/;
@@ -46,7 +47,8 @@ my @filters = $input->param("Filter");
my $output = $input->param("output");
my $basename = $input->param("basename");
my $mime = $input->param("MIME");
-my $del = $input->param("sep");
+our $sep = $input->param("sep");
+$sep = "\t" if ($sep eq 'tabulation');
my ($template, $borrowernumber, $cookie)
= get_template_and_user({template_name => $fullreportname,
query => $input,
@@ -74,8 +76,6 @@ if ($do_it) {
-filename=>"$basename.csv" );
my $cols = @$results[0]->{loopcol};
my $lines = @$results[0]->{looprow};
- my $sep;
- $sep =C4::Context->preference("delimiter");
# header top-right
print "num /". @$results[0]->{column} .$sep;
# Other header
@@ -122,13 +122,7 @@ if ($do_it) {
-size => 1,
-multiple => 0 );
- my @dels = ( C4::Context->preference("delimiter") );
- my $CGIsepChoice=CGI::scrolling_list(
- -name => 'sep',
- -id => 'sep',
- -values => \@dels,
- -size => 1,
- -multiple => 0 );
+ my $CGIsepChoice = GetDelimiterChoices;
my ($codes,$labels) = GetborCatFromCatType(undef,undef);
my @borcatloop;
diff --git a/reports/borrowers_stats.pl b/reports/borrowers_stats.pl
index b379067..7578d80 100755
--- a/reports/borrowers_stats.pl
+++ b/reports/borrowers_stats.pl
@@ -26,6 +26,7 @@ use C4::Koha;
use C4::Dates;
use C4::Acquisition;
use C4::Output;
+use C4::Reports;
use C4::Circulation;
use Date::Calc qw(
Today
@@ -55,7 +56,8 @@ my $borstat1 = $input->param("activity");
my $output = $input->param("output");
my $basename = $input->param("basename");
my $mime = $input->param("MIME");
-my $del = $input->param("sep");
+our $sep = $input->param("sep");
+$sep = "\t" if ($sep eq 'tabulation');
my $selected_branch; # = $input->param("?");
our $branches = GetBranches;
@@ -81,8 +83,6 @@ if ($do_it) {
-attachment => "$basename.csv");
my $cols = @$results[0]->{loopcol};
my $lines = @$results[0]->{looprow};
- my $sep;
- $sep =C4::Context->preference("delimiter");
print @$results[0]->{line} ."/". @$results[0]->{column} .$sep;
foreach my $col ( @$cols ) {
print $col->{coltitle}.$sep;
@@ -135,13 +135,7 @@ if ($do_it) {
-values => \@mime,
-size => 1,
-multiple => 0 );
- my @dels = ( C4::Context->preference("delimiter") );
- my $CGIsepChoice=CGI::scrolling_list(
- -name => 'sep',
- -id => 'sep',
- -values => \@dels,
- -size => 1,
- -multiple => 0 );
+ my $CGIsepChoice=GetDelimiterChoices;
$template->param(
CGIextChoice => $CGIextChoice,
CGIsepChoice => $CGIsepChoice,
diff --git a/reports/cat_issues_top.pl b/reports/cat_issues_top.pl
index c11c899..d19533b 100755
--- a/reports/cat_issues_top.pl
+++ b/reports/cat_issues_top.pl
@@ -50,7 +50,6 @@ $filters[1]=format_date_in_iso($filters[1]);
my $output = $input->param("output");
my $basename = $input->param("basename");
my $mime = $input->param("MIME");
-my $del = $input->param("sep");
#warn "calcul : ".$calc;
my ($template, $borrowernumber, $cookie)
= get_template_and_user({template_name => $fullreportname,
@@ -60,6 +59,8 @@ my ($template, $borrowernumber, $cookie)
flagsrequired => { reports => 1},
debug => 1,
});
+our $sep = $input->param("sep");
+$sep = "\t" if ($sep eq 'tabulation');
$template->param(do_it => $do_it,
DHTMLcalendar_dateformat => C4::Dates->DHTMLcalendar(),
);
@@ -80,8 +81,6 @@ if ($do_it) {
-filename=>"$basename.csv" );
my $cols = @$results[0]->{loopcol};
my $lines = @$results[0]->{looprow};
- my $sep;
- $sep =C4::Context->preference("delimiter");
# header top-right
print @$results[0]->{line} ."/". @$results[0]->{column} .$sep;
# Other header
@@ -128,13 +127,7 @@ if ($do_it) {
-size => 1,
-multiple => 0 );
- my @dels = ( C4::Context->preference("delimiter") );
- my $CGIsepChoice=CGI::scrolling_list(
- -name => 'sep',
- -id => 'sep',
- -values => \@dels,
- -size => 1,
- -multiple => 0 );
+ my $CGIsepChoice=GetDelimiterChoices;
#branch
my $branches = GetBranches;
my @branchloop;
diff --git a/reports/catalogue_out.pl b/reports/catalogue_out.pl
index 0821e2f..cfdde8d 100755
--- a/reports/catalogue_out.pl
+++ b/reports/catalogue_out.pl
@@ -25,6 +25,7 @@ use C4::Debug;
use C4::Branch; # GetBranches
use C4::Output;
use C4::Koha;
+use C4::Reports;
use C4::Circulation;
use Date::Manip;
use Data::Dumper;
@@ -52,6 +53,10 @@ my ($template, $borrowernumber, $cookie)
flagsrequired => {reports => 1},
debug => 1,
});
+
+our $sep = $input->param("sep");
+$sep = "\t" if ($sep eq 'tabulation');
+
$template->param(do_it => $do_it);
if ($do_it) {
my $results = calculate($limit, $column, \@filters);
@@ -68,7 +73,6 @@ if ($do_it) {
-filename =>"$basename.csv" );
my $cols = @$results[0]->{loopcol};
my $lines = @$results[0]->{looprow};
- my $sep = $input->param("sep") || C4::Context->preference("delimiter");
# header
print "num /". @$results[0]->{column} .$sep;
# Other header
@@ -108,13 +112,7 @@ my $CGIextChoice = CGI::scrolling_list(
-size => 1,
-multiple => 0 );
-my @dels = (C4::Context->preference("delimiter"));
-my $CGIsepChoice = CGI::scrolling_list(
- -name => 'sep',
- -id => 'sep',
- -values => \@dels,
- -size => 1,
- -multiple => 0 );
+my $CGIsepChoice = GetDelimiterChoices;
my $itemtypes = GetItemTypes;
my @itemtypeloop;
diff --git a/reports/catalogue_stats.pl b/reports/catalogue_stats.pl
index 3addbe7..d624bdc 100755
--- a/reports/catalogue_stats.pl
+++ b/reports/catalogue_stats.pl
@@ -25,6 +25,7 @@ use C4::Context;
use C4::Branch; # GetBranches
use C4::Output;
use C4::Koha;
+use C4::Reports;
use C4::Circulation;
=head1 NAME
@@ -50,7 +51,8 @@ my $cotedigits = $input->param("cotedigits");
my $output = $input->param("output");
my $basename = $input->param("basename");
my $mime = $input->param("MIME");
-my $del = $input->param("sep");
+our $sep = $input->param("sep");
+$sep = "\t" if ($sep eq 'tabulation');
my ($template, $borrowernumber, $cookie)
= get_template_and_user({template_name => $fullreportname,
@@ -74,7 +76,6 @@ if ($do_it) {
-name=>"$basename.csv" );
my $cols = @$results[0]->{loopcol};
my $lines = @$results[0]->{looprow};
- my $sep = C4::Context->preference("delimiter");
print @$results[0]->{line} ."/". @$results[0]->{column} .$sep;
foreach my $col ( @$cols ) {
print $col->{coltitle}.$sep;
@@ -164,7 +165,6 @@ if ($do_it) {
}
my @mime = ( map { +{type =>$_} } (split /[;:]/,C4::Context->preference("MIME")) );
- my @delim = ( map { +{delim=>$_} } (split //,C4::Context->preference("delimiter")) );
$template->param(hasdewey=>$hasdewey,
haslccn => $haslccn,
@@ -174,7 +174,7 @@ if ($do_it) {
locationloop => \@locations,
authvals => \@authvals,
CGIextChoice => \@mime,
- CGIsepChoice => \@delim,
+ CGIsepChoice => GetDelimiterChoices,
);
}
diff --git a/reports/dictionary.pl b/reports/dictionary.pl
index 7edd1d4..061ff9f 100755
--- a/reports/dictionary.pl
+++ b/reports/dictionary.pl
@@ -21,7 +21,7 @@ use strict;
use C4::Auth;
use CGI;
use C4::Output;
-use C4::Reports;
+use C4::Reports::Guided;
use C4::Dates qw( DHTMLcalendar );
=head1 NAME
@@ -53,7 +53,7 @@ my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
if ($phase eq 'View Dictionary'){
# view the dictionary we use to set up abstract variables such as all borrowers over fifty who live in a certain town
- my $areas = C4::Reports::get_report_areas();
+ my $areas = get_report_areas();
my $definitions = get_from_dictionary();
$template->param( 'areas' => $areas ,
'start_dictionary' => 1,
@@ -68,7 +68,7 @@ elsif ($phase eq 'Add New Definition'){
elsif ($phase eq 'New Term step 2'){
# Choosing the area
- my $areas = C4::Reports::get_report_areas();
+ my $areas = C4::Reports::Guided::get_report_areas();
my $definition_name=$input->param('definition_name');
my $definition_description=$input->param('definition_description');
$template->param( 'step_2' => 1,
@@ -134,7 +134,7 @@ elsif ($phase eq 'New Term step 4'){
elsif ($phase eq 'New Term step 5'){
# Confirmation screen
- my $areas = C4::Reports::get_report_areas();
+ my $areas = C4::Reports::Guided::get_report_areas();
my $area = $input->param('area');
my $areaname = $areas->[$area - 1]->{'name'};
my $columnstring = $input->param('columnstring');
diff --git a/reports/guided_reports.pl b/reports/guided_reports.pl
index 0c5d94b..6485d45 100755
--- a/reports/guided_reports.pl
+++ b/reports/guided_reports.pl
@@ -19,7 +19,7 @@
use strict;
use CGI;
-use C4::Reports;
+use C4::Reports::Guided;
use C4::Auth;
use C4::Output;
use C4::Dates qw( DHTMLcalendar );
@@ -65,7 +65,7 @@ elsif ( $phase eq 'Build new' ) {
$template->param( 'build1' => 1 );
# get report areas
- my $areas = C4::Reports::get_report_areas();
+ my $areas = get_report_areas();
$template->param( 'areas' => $areas );
}
@@ -123,7 +123,7 @@ elsif ( $phase eq 'Report on this Area' ) {
);
# get report types
- my $types = C4::Reports::get_report_types();
+ my $types = get_report_types();
$template->param( 'types' => $types );
}
@@ -428,7 +428,7 @@ elsif ($phase eq 'Create report from SQL') {
);
}
$template->param('create' => 1);
- my $types = C4::Reports::get_report_types();
+ my $types = get_report_types();
if (my $type = $input->param('type')) {
for my $i ( 0 .. $#{@$types}) {
@$types[$i]->{'selected'} = 1 if @$types[$i]->{'id'} eq $type;
diff --git a/reports/issues_avg_stats.pl b/reports/issues_avg_stats.pl
index 1153aa3..60d198a 100755
--- a/reports/issues_avg_stats.pl
+++ b/reports/issues_avg_stats.pl
@@ -55,7 +55,6 @@ my $calc = $input->param("Cellvalue");
my $output = $input->param("output");
my $basename = $input->param("basename");
my $mime = $input->param("MIME");
-my $del = $input->param("sep");
#warn "calcul : ".$calc;
my ($template, $borrowernumber, $cookie)
= get_template_and_user({template_name => $fullreportname,
@@ -65,6 +64,8 @@ my ($template, $borrowernumber, $cookie)
flagsrequired => {reports => 1},
debug => 1,
});
+our $sep = $input->param("sep");
+$sep = "\t" if ($sep eq 'tabulation');
$template->param(do_it => $do_it,
DHTMLcalendar_dateformat => C4::Dates->DHTMLcalendar(),
);
@@ -84,8 +85,6 @@ if ($do_it) {
-filename=>"$basename.csv" );
my $cols = @$results[0]->{loopcol};
my $lines = @$results[0]->{looprow};
- my $sep;
- $sep =C4::Context->preference("delimiter");
# header top-right
print @$results[0]->{line} ."/". @$results[0]->{column} .$sep;
# Other header
@@ -212,13 +211,7 @@ if ($do_it) {
-size => 1,
-multiple => 0 );
- my @dels = ( C4::Context->preference("delimiter") );
- my $CGIsepChoice=CGI::scrolling_list(
- -name => 'sep',
- -id => 'sep',
- -values => \@dels,
- -size => 1,
- -multiple => 0 );
+ my $CGIsepChoice=GetDelimiterChoices;
$template->param(
CGIBorCat => $CGIBorCat,
diff --git a/reports/issues_stats.pl b/reports/issues_stats.pl
index 201c676..df848bd 100755
--- a/reports/issues_stats.pl
+++ b/reports/issues_stats.pl
@@ -30,6 +30,7 @@ use C4::Branch; # GetBranches
use C4::Koha;
use C4::Output;
use C4::Circulation;
+use C4::Reports;
use C4::Dates qw/format_date format_date_in_iso/;
use C4::Members;
@@ -60,7 +61,6 @@ my $calc = $input->param("Cellvalue");
my $output = $input->param("output");
my $basename = $input->param("basename");
my $mime = $input->param("MIME");
-my $del = $input->param("sep");
my ($template, $borrowernumber, $cookie) = get_template_and_user({
template_name => $fullreportname,
query => $input,
@@ -69,6 +69,8 @@ my ($template, $borrowernumber, $cookie) = get_template_and_user({
flagsrequired => {reports => 1},
debug => 0,
});
+our $sep = $input->param("sep");
+$sep = "\t" if ($sep eq 'tabulation');
$template->param(do_it => $do_it,
DHTMLcalendar_dateformat => C4::Dates->DHTMLcalendar(),
);
@@ -101,7 +103,6 @@ if ($do_it) {
-filename=>"$basename.csv" );
my $cols = @$results[0]->{loopcol};
my $lines = @$results[0]->{looprow};
- my $sep = C4::Context->preference("delimiter");
# header top-right
print @$results[0]->{line} ."/". @$results[0]->{column} .$sep;
# Other header
@@ -170,13 +171,7 @@ my $CGIextChoice=CGI::scrolling_list(
-size => 1,
-multiple => 0 );
-my @dels = ( C4::Context->preference("delimiter") );
-my $CGIsepChoice=CGI::scrolling_list(
- -name => 'sep',
- -id => 'sep',
- -values => \@dels,
- -size => 1,
- -multiple => 0 );
+my $CGIsepChoice=GetDelimiterChoices;
$template->param(
categoryloop => $categoryloop,
diff --git a/tools/runreport.pl b/tools/runreport.pl
index d2d85a2..9801a4a 100755
--- a/tools/runreport.pl
+++ b/tools/runreport.pl
@@ -1,7 +1,7 @@
#!/usr/bin/perl
# fix this line
-use C4::Reports;
+use C4::Reports::Guided;
use C4::Context;
use Mail::Sendmail;
diff --git a/tools/scheduler.pl b/tools/scheduler.pl
index ad2f5a3..e985bd3 100755
--- a/tools/scheduler.pl
+++ b/tools/scheduler.pl
@@ -20,7 +20,7 @@
use strict;
use C4::Context;
use C4::Scheduler;
-use C4::Reports;
+use C4::Reports::Guided;
use C4::Auth;
use CGI;
use C4::Output;
--
1.5.5.GIT
More information about the Koha-patches
mailing list