3 # Copyright 2007 Liblime Ltd
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA 02111-1307 USA
23 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
29 # use Smart::Comments;
33 # set the version for version checking
38 get_report_types get_report_areas get_columns build_query get_criteria
39 save_report get_saved_reports execute_query get_saved_report create_compound run_compound
40 get_column_type get_distinct_values save_dictionary get_from_dictionary
41 delete_definition delete_report format_results get_sql
47 [ 'borrowers', 'statistics','items', 'biblioitems' ]; # circulation
48 $table_areas{'2'} = [ 'items', 'biblioitems', 'biblio' ]; # catalogue
49 $table_areas{'3'} = [ 'borrowers' ]; # patrons
50 $table_areas{'4'} = ['aqorders', 'biblio', 'items']; # acquisitions
51 $table_areas{'5'} = [ 'borrowers', 'accountlines' ]; # accounts
54 'statistics.borrowernumber=borrowers.borrowernumber',
55 'items.itemnumber = statistics.itemnumber',
56 'biblioitems.biblioitemnumber = items.biblioitemnumber'
59 'items.biblioitemnumber=biblioitems.biblioitemnumber',
60 'biblioitems.biblionumber=biblio.biblionumber'
64 'aqorders.biblionumber=biblio.biblionumber',
65 'biblio.biblionumber=items.biblionumber'
67 $keys{'5'} = ['borrowers.borrowernumber=accountlines.borrowernumber'];
69 # have to do someting here to know if its dropdown, free text, date etc
73 'statistics.type', 'borrowers.categorycode',
75 'biblioitems.publicationyear|date',
76 'items.dateaccessioned|date'
79 [ 'items.holdingbranch', 'items.homebranch' ,'items.itemlost', 'items.location', 'items.ccode'];
80 $criteria{'3'} = ['borrowers.branchcode'];
81 $criteria{'4'} = ['aqorders.datereceived|date'];
82 $criteria{'5'} = ['borrowers.branchcode'];
84 if (C4::Context->preference('item-level_itypes')) {
85 unshift @{ $criteria{'1'} }, 'items.itype';
86 unshift @{ $criteria{'2'} }, 'items.itype';
88 unshift @{ $criteria{'1'} }, 'biblioitems.itemtype';
89 unshift @{ $criteria{'2'} }, 'biblioitems.itemtype';
94 C4::Reports - Module for generating reports
109 =item get_report_types()
111 This will return a list of all the available report types
115 sub get_report_types {
116 my $dbh = C4::Context->dbh();
118 # FIXME these should be in the database perhaps
119 my @reports = ( 'Tabular', 'Summary', 'Matrix' );
121 for ( my $i = 0 ; $i < 3 ; $i++ ) {
123 $hashrep{id} = $i + 1;
124 $hashrep{name} = $reports[$i];
125 push @reports2, \%hashrep;
127 return ( \@reports2 );
131 =item get_report_areas()
133 This will return a list of all the available report areas
137 sub get_report_areas {
138 my $dbh = C4::Context->dbh();
140 # FIXME these should be in the database
141 my @reports = ( 'Circulation', 'Catalog', 'Patrons', 'Acquisitions', 'Accounts');
143 for ( my $i = 0 ; $i < 5 ; $i++ ) {
145 $hashrep{id} = $i + 1;
146 $hashrep{name} = $reports[$i];
147 push @reports2, \%hashrep;
149 return ( \@reports2 );
153 =item get_all_tables()
155 This will return a list of all tables in the database
160 my $dbh = C4::Context->dbh();
161 my $query = "SHOW TABLES";
162 my $sth = $dbh->prepare($query);
165 while ( my $data = $sth->fetchrow_arrayref() ) {
166 push @tables, $data->[0];
173 =item get_columns($area)
175 This will return a list of all columns for a report area
181 # this calls the internal fucntion _get_columns
182 my ($area,$cgi) = @_;
183 my $tables = $table_areas{$area};
186 foreach my $table (@$tables) {
187 my @columns = _get_columns($table,$cgi, $first);
189 push @allcolumns, @columns;
191 return ( \@allcolumns );
195 my ($tablename,$cgi, $first) = @_;
196 my $dbh = C4::Context->dbh();
197 my $sth = $dbh->prepare("show columns from $tablename");
200 my $column_defs = _get_column_defs($cgi);
202 $tablehash{'table'}=$tablename;
203 $tablehash{'__first__'} = $first;
204 push @columns, \%tablehash;
205 while ( my $data = $sth->fetchrow_arrayref() ) {
207 $temphash{'name'} = "$tablename.$data->[0]";
208 $temphash{'description'} = $column_defs->{"$tablename.$data->[0]"};
209 push @columns, \%temphash;
215 =item build_query($columns,$criteria,$orderby,$area)
217 This will build the sql needed to return the results asked for,
218 $columns is expected to be of the format tablename.columnname.
219 This is what get_columns returns.
224 my ( $columns, $criteria, $orderby, $area, $totals, $definition ) = @_;
226 my $keys = $keys{$area};
227 my $tables = $table_areas{$area};
230 _build_query( $tables, $columns, $criteria, $keys, $orderby, $totals, $definition );
235 my ( $tables, $columns, $criteria, $keys, $orderby, $totals, $definition) = @_;
237 # $keys is an array of joining constraints
238 my $dbh = C4::Context->dbh();
239 my $joinedtables = join( ',', @$tables );
240 my $joinedcolumns = join( ',', @$columns );
241 my $joinedkeys = join( ' AND ', @$keys );
243 "SELECT $totals $joinedcolumns FROM $tables->[0] ";
244 for (my $i=1;$i<@$tables;$i++){
245 $query .= "LEFT JOIN $tables->[$i] on ($keys->[$i-1]) ";
249 $criteria =~ s/AND/WHERE/;
250 $query .= " $criteria";
253 my @definitions = split(',',$definition);
255 foreach my $def (@definitions){
256 my $defin=get_from_dictionary('',$def);
257 $deftext .=" ".$defin->[0]->{'saved_sql'};
259 if ($query =~ /WHERE/i){
263 $deftext =~ s/AND/WHERE/;
269 my @totcolumns = split( ',', $totals );
270 foreach my $total (@totcolumns) {
271 if ( $total =~ /\((.*)\)/ ) {
272 if ( $groupby eq '' ) {
273 $groupby = " GROUP BY $1";
288 =item get_criteria($area,$cgi);
290 Returns an arraref to hashrefs suitable for using in a tmpl_loop. With the criteria and available values.
295 my ($area,$cgi) = @_;
296 my $dbh = C4::Context->dbh();
297 my $crit = $criteria{$area};
298 my $column_defs = _get_column_defs($cgi);
300 foreach my $localcrit (@$crit) {
301 my ( $value, $type ) = split( /\|/, $localcrit );
302 my ( $table, $column ) = split( /\./, $value );
303 if ( $type eq 'date' ) {
305 $temp{'name'} = $value;
307 $temp{'description'} = $column_defs->{$value};
308 push @criteria_array, \%temp;
313 "SELECT distinct($column) as availablevalues FROM $table";
314 my $sth = $dbh->prepare($query);
317 while ( my $row = $sth->fetchrow_hashref() ) {
323 $temp{'name'} = $value;
324 $temp{'description'} = $column_defs->{$value};
325 $temp{'values'} = \@values;
326 push @criteria_array, \%temp;
329 return ( \@criteria_array );
336 ($results, $total) = execute_query($sql, $type, $offset, $limit, $format, $id)
340 When passed C<$sql>, this function returns an array ref containing a result set
341 suitably formatted for display in html or for output as a flat file when passed in
342 C<$format> and C<$id>. It also returns the C<$total> records available for the
343 supplied query. If passed any query other than a SELECT, or if there is a db error,
344 C<$errors> an array ref is returned containing the error after this manner:
346 C<$error->{'sqlerr'}> contains the offending SQL keyword.
347 C<$error->{'queryerr'}> contains the native db engine error returned for the query.
349 Valid values for C<$format> are 'text,' 'tab,' 'csv,' or 'url. C<$sql>, C<$type>,
350 C<$offset>, and C<$limit> are required parameters. If a valid C<$format> is passed
351 in, C<$offset> and C<$limit> are ignored for obvious reasons. A LIMIT specified by
352 the user in a user-supplied SQL query WILL apply in any case.
356 sub execute_query ($$$$;$$) {
357 my ( $sql, $type, $offset, $limit, $format, $id ) = @_;
360 my ($useroffset, $userlimit);
364 if ($sql =~ /;?\W?(UPDATE|DELETE|DROP|INSERT|SHOW|CREATE)\W/i) {
366 $error->{'sqlerr'} = $1;
367 push @errors, $error;
368 } elsif ($sql !~ /^(SELECT)/i) {
370 $error->{'queryerr'} = 'Missing SELECT';
371 push @errors, $error;
374 my $dbh = C4::Context->dbh();
375 unless ($format eq 'text' || $format eq 'tab' || $format eq 'csv' || $format eq 'url'){
376 # Grab offset/limit from user supplied LIMIT and drop the LIMIT so we can control pagination
377 if ($sql =~ /LIMIT/i) {
378 $sql =~ s/LIMIT\W?(\d+)?\,?\W+?(\d+)//ig;
379 $debug and warn "User has supplied LIMIT\n";
382 $debug and warn "User supplied offset = $useroffset, limit = $userlimit\n";
383 $offset += $useroffset if $useroffset;
384 # keep track of where we are if there is a user supplied LIMIT
385 if ( $offset + $limit > $userlimit ) {
386 $limit = $userlimit - $offset;
390 $sql .= " LIMIT ?, ?";
391 $debug and warn "Passing query with params offset = $offset, limit = $limit\n";
392 @params = ($offset, $limit);
393 # Modify the query passed in to create a count query... (I think this covers all cases -crn)
394 $countsql =~ s/\bSELECT\W+(?:\w+\W+){1,}?FROM\b|\bSELECT\W\*\WFROM\b/SELECT count(*) FROM /ig;
395 $debug and warn "original query: $sql\n";
396 $debug and warn "count query: $countsql\n";
397 my $sth1 = $dbh->prepare($countsql);
399 $total = $sth1->fetchrow();
400 $debug and warn "total records for this query: $total\n";
401 $total = $userlimit if defined($userlimit) and $userlimit < $total; # we will never exceed a user defined LIMIT and...
402 $userlimit = $total if defined($userlimit) and $userlimit > $total; # we will never exceed the total number of records available to satisfy the query
404 my $sth = $dbh->prepare($sql);
405 $sth->execute(@params);
406 my $colnames=$sth->{'NAME'};
410 $row = join ('</th><th>',@$colnames);
411 $row = "<tr><th>$row</th></tr>";
412 $temphash{'row'} = $row;
413 push @results, \%temphash;
415 if ($format eq 'tab') {
416 $string = join("\t",@$colnames);
418 if ($format eq 'csv') {
419 $string = join(",",@$colnames);
422 while ( my @data = $sth->fetchrow_array() ) {
423 # if the field is a date field, it needs formatting
424 foreach my $data (@data) {
425 next unless $data =~ C4::Dates->regexp("iso");
426 my $date = C4::Dates->new($data, "iso");
427 $data = $date->output();
431 my $row = join( '</td><td>', @data );
432 $row = "<tr><td>$row</td></tr>";
433 $temphash{'row'} = $row;
434 if ( $format eq 'text' ) {
435 $string .= "\n" . $row;
437 if ($format eq 'tab' ){
438 $row = join("\t",@data);
439 $string .="\n" . $row;
441 if ($format eq 'csv' ){
442 $row = join(",",@data);
443 $string .="\n" . $row;
445 if ($format eq 'url'){
447 @$temphash{@$colnames}=@data;
448 push @xmlarray,$temphash;
450 push @results, \%temphash;
452 if (defined($sth->errstr)) {
453 $error->{'queryerr'} = $sth->errstr;
454 push @errors, $error;
455 warn "Database returned: $sth->errstr";
457 if ( $format eq 'text' || $format eq 'tab' || $format eq 'csv' ) {
458 return $string, $total, \@errors;
460 elsif ($format eq 'url') {
461 my $url = "/cgi-bin/koha/reports/guided_reports.pl?phase=retrieve%20results&id=$id";
462 my $dump = new XML::Dumper;
463 my $xml = $dump->pl2xml( \@xmlarray );
464 store_results($id,$xml);
465 return $url, $total, \@errors;
468 return \@results, $total, \@errors;
471 return undef, undef, \@errors;
475 =item save_report($sql,$name,$type,$notes)
477 Given some sql and a name this will saved it so that it can resued
482 my ( $sql, $name, $type, $notes ) = @_;
483 my $dbh = C4::Context->dbh();
485 "INSERT INTO saved_sql (borrowernumber,date_created,last_modified,savedsql,report_name,type,notes) VALUES (?,now(),now(),?,?,?,?)";
486 my $sth = $dbh->prepare($query);
487 $sth->execute( 0, $sql, $name, $type, $notes );
494 my $dbh = C4::Context->dbh();
495 my $query = "SELECT * FROM saved_reports WHERE report_id=?";
496 my $sth = $dbh->prepare($query);
498 if (my $data=$sth->fetchrow_hashref()){
499 my $query2 = "UPDATE saved_reports SET report=?,date_run=now() WHERE report_id=?";
500 my $sth2 = $dbh->prepare($query2);
501 $sth2->execute($xml,$id);
505 my $query2 = "INSERT INTO saved_reports (report_id,report,date_run) VALUES (?,?,now())";
506 my $sth2 = $dbh->prepare($query2);
507 $sth2->execute($id,$xml);
515 my $dbh = C4::Context->dbh();
516 my $query = "SELECT * FROM saved_reports WHERE report_id = ?";
517 my $sth = $dbh->prepare($query);
519 my $data = $sth->fetchrow_hashref();
520 my $dump = new XML::Dumper;
521 my $perl = $dump->xml2pl( $data->{'report'} );
522 foreach my $row (@$perl) {
524 foreach my $key (keys %$row){
525 $htmlrow .= "<td>$row->{$key}</td>";
528 $row->{'row'} = $htmlrow;
531 $query = "SELECT * FROM saved_sql WHERE id = ?";
532 $sth = $dbh->prepare($query);
534 $data = $sth->fetchrow_hashref();
536 return ($perl,$data->{'report_name'},$data->{'notes'});
541 my $dbh = C4::Context->dbh();
542 my $query = "DELETE FROM saved_sql WHERE id = ?";
543 my $sth = $dbh->prepare($query);
548 sub get_saved_reports {
549 my $dbh = C4::Context->dbh();
550 my $query = "SELECT *,saved_sql.id AS id FROM saved_sql
551 LEFT JOIN saved_reports ON saved_reports.report_id = saved_sql.id
552 ORDER by date_created";
553 my $sth = $dbh->prepare($query);
556 while ( my $data = $sth->fetchrow_hashref() ) {
557 push @reports, $data;
560 return ( \@reports );
563 sub get_saved_report {
565 my $dbh = C4::Context->dbh();
566 my $query = " SELECT * FROM saved_sql WHERE id = ?";
567 my $sth = $dbh->prepare($query);
569 my $data = $sth->fetchrow_hashref();
571 return ( $data->{'savedsql'}, $data->{'type'}, $data->{'report_name'}, $data->{'notes'} );
574 =item create_compound($masterID,$subreportID)
576 This will take 2 reports and create a compound report using both of them
580 sub create_compound {
581 my ($masterID,$subreportID) = @_;
582 my $dbh = C4::Context->dbh();
584 my ($mastersql,$mastertype) = get_saved_report($masterID);
585 my ($subsql,$subtype) = get_saved_report($subreportID);
587 # now we have to do some checking to see how these two will fit together
589 my ($mastertables,$subtables);
590 if ($mastersql =~ / from (.*) where /i){
593 if ($subsql =~ / from (.*) where /i){
596 return ($mastertables,$subtables);
599 =item get_column_type($column)
601 This takes a column name of the format table.column and will return what type it is
602 (free text, set values, date)
606 sub get_column_type {
607 my ($tablecolumn) = @_;
608 my ($table,$column) = split(/\./,$tablecolumn);
609 my $dbh = C4::Context->dbh();
613 # mysql doesnt support a column selection, set column to %
615 my $sth = $dbh->column_info( $catalog, $schema, $table, $tempcolumn ) || die $dbh->errstr;
616 while (my $info = $sth->fetchrow_hashref()){
617 if ($info->{'COLUMN_NAME'} eq $column){
619 if ($info->{'TYPE_NAME'} eq 'CHAR' || $info->{'TYPE_NAME'} eq 'VARCHAR'){
620 $info->{'TYPE_NAME'} = 'distinct';
622 return $info->{'TYPE_NAME'};
628 =item get_distinct_values($column)
630 Given a column name, return an arrary ref of hashrefs suitable for use as a tmpl_loop
631 with the distinct values of the column
635 sub get_distinct_values {
636 my ($tablecolumn) = @_;
637 my ($table,$column) = split(/\./,$tablecolumn);
638 my $dbh = C4::Context->dbh();
640 "SELECT distinct($column) as availablevalues FROM $table";
641 my $sth = $dbh->prepare($query);
644 while ( my $row = $sth->fetchrow_hashref() ) {
651 sub save_dictionary {
652 my ($name,$description,$sql,$area) = @_;
653 my $dbh = C4::Context->dbh();
654 my $query = "INSERT INTO reports_dictionary (name,description,saved_sql,area,date_created,date_modified)
655 VALUES (?,?,?,?,now(),now())";
656 my $sth = $dbh->prepare($query);
657 $sth->execute($name,$description,$sql,$area) || return 0;
662 sub get_from_dictionary {
664 my $dbh = C4::Context->dbh();
665 my $query = "SELECT * FROM reports_dictionary";
667 $query.= " WHERE area = ?";
670 $query.= " WHERE id = ?"
672 my $sth = $dbh->prepare($query);
677 $sth->execute($area);
683 my @reports = ( 'Circulation', 'Catalog', 'Patrons', 'Acquisitions', 'Accounts');
684 while (my $data = $sth->fetchrow_hashref()){
685 $data->{'areaname'}=$reports[$data->{'area'}-1];
693 sub delete_definition {
695 my $dbh = C4::Context->dbh();
696 my $query = "DELETE FROM reports_dictionary WHERE id = ?";
697 my $sth = $dbh->prepare($query);
704 my $dbh = C4::Context->dbh();
705 my $query = "SELECT * FROM saved_sql WHERE id = ?";
706 my $sth = $dbh->prepare($query);
708 my $data=$sth->fetchrow_hashref();
710 return $data->{'savedsql'};
713 sub _get_column_defs {
716 my $columns_def_file = "columns.def";
717 my $htdocs = C4::Context->config('intrahtdocs');
718 my $section='intranet';
719 my ($theme, $lang) = themelanguage($htdocs, $columns_def_file, $section,$cgi);
721 my $full_path_to_columns_def_file="$htdocs/$theme/$lang/$columns_def_file";
722 open (COLUMNS,$full_path_to_columns_def_file);
723 while (my $input = <COLUMNS>){
724 my @row =split(/\t/,$input);
725 $columns{$row[0]}=$row[1];
738 Chris Cormack <crc@liblime.com>