use C4::Output;
use XML::Simple;
use XML::Dumper;
+use C4::Debug;
# use Smart::Comments;
# use Data::Dumper;
our %criteria;
$criteria{'1'} = [
'statistics.type', 'borrowers.categorycode',
- 'statistics.branch', 'biblioitems.itemtype',
+ 'statistics.branch',
'biblioitems.publicationyear|date',
'items.dateaccessioned|date'
];
$criteria{'2'} =
- [ 'biblioitems.itemtype', 'items.holdingbranch', 'items.homebranch' ,'items.itemlost'];
+ [ 'items.holdingbranch', 'items.homebranch' ,'items.itemlost', 'items.location', 'items.ccode'];
$criteria{'3'} = ['borrowers.branchcode'];
$criteria{'4'} = ['aqorders.datereceived|date'];
$criteria{'5'} = ['borrowers.branchcode'];
-our %columns;
-my $columns_def_file = "columns.def";
-my $htdocs = C4::Context->config('intrahtdocs');
-my $section='intranet';
-my $cgi = new CGI;
-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];
+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';
}
-close COLUMNS;
-
=head1 NAME
C4::Reports - Module for generating reports
sub get_columns {
# this calls the internal fucntion _get_columns
- my ($area) = @_;
+ my ($area,$cgi) = @_;
my $tables = $table_areas{$area};
my @allcolumns;
+ my $first = 1;
foreach my $table (@$tables) {
- my @columns = _get_columns($table);
+ my @columns = _get_columns($table,$cgi, $first);
+ $first = 0;
push @allcolumns, @columns;
}
return ( \@allcolumns );
}
sub _get_columns {
- my ($tablename) = @_;
+ 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'} = $columns{"$tablename.$data->[0]"};
+ $temphash{'description'} = $column_defs->{"$tablename.$data->[0]"};
push @columns, \%temphash;
}
$sth->finish();
return ($query);
}
-=item get_criteria($area);
+=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) = @_;
+ 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 %temp;
$temp{'name'} = $value;
$temp{'date'} = 1;
- $temp{'description'} = $columns{$value};
+ $temp{'description'} = $column_defs->{$value};
push @criteria_array, \%temp;
}
else {
$sth->finish();
my %temp;
$temp{'name'} = $value;
- $temp{'description'} = $columns{$value};
+ $temp{'description'} = $column_defs->{$value};
$temp{'values'} = \@values;
push @criteria_array, \%temp;
}
return ( \@criteria_array );
}
-sub execute_query {
- my ( $sql, $type, $format, $id ) = @_;
- my $dbh = C4::Context->dbh();
+=item execute_query
- # take this line out when in production
- if ($format eq 'url'){
- }
- else {
- $sql .= " LIMIT 10";
- }
- my $sth = $dbh->prepare($sql);
- $sth->execute();
- 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;
- my @xmlarray;
- while ( my @data = $sth->fetchrow_array() ) {
+=head2 ($results, $total) = execute_query($sql, $type, $offset, $limit, $format, $id)
+
+ 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 );
if ( $format eq 'text' ) {
$string .= "\n" . $row;
}
- if ($format eq 'tab' ){
- $row = join("\t",@data);
- $string .="\n" . $row;
- }
- if ($format eq 'csv' ){
- $row = join(",",@data);
- $string .="\n" . $row;
- }
- if ($format eq 'url'){
- my $temphash;
- @$temphash{@$colnames}=@data;
- push @xmlarray,$temphash;
- }
+ if ($format eq 'tab' ){
+ $row = join("\t",@data);
+ $string .="\n" . $row;
+ }
+ if ($format eq 'csv' ){
+ $row = join(",",@data);
+ $string .="\n" . $row;
+ }
+ if ($format eq 'url'){
+ my $temphash;
+ @$temphash{@$colnames}=@data;
+ push @xmlarray,$temphash;
+ }
push @results, \%temphash;
-# }
- }
- $sth->finish();
- if ( $format eq 'text' || $format eq 'tab' || $format eq 'csv' ) {
- return $string;
- }
- 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;
- }
- else {
- return ( \@results );
+ }
+ 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;
}
}
$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);
}
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__
projects / koha_fer / blobdiff