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
21 # use warnings; # FIXME
24 use C4::Reports::Guided;
36 Script to control the guided report creation
44 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
46 template_name => "reports/guided_reports_start.tmpl",
50 flagsrequired => { reports => 1 },
56 my $phase = $input->param('phase');
58 $template->param( 'start' => 1 );
61 elsif ( $phase eq 'Build new' ) {
63 $template->param( 'build1' => 1 );
64 $template->param( 'areas' => get_report_areas() );
66 elsif ( $phase eq 'Use saved' ) {
68 # get list of reports and display them
69 $template->param( 'saved1' => 1 );
70 $template->param( 'savedreports' => get_saved_reports() );
73 elsif ( $phase eq 'Delete Saved') {
75 # delete a report from the saved reports list
76 my $id = $input->param('reports');
78 print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved");
82 elsif ( $phase eq 'Show SQL'){
84 my $id = $input->param('reports');
85 my $sql = get_sql($id);
92 elsif ( $phase eq 'Edit SQL'){
94 my $id = $input->param('reports');
95 my ($sql,$type,$reportname,$notes) = get_saved_report($id);
98 'reportname' => $reportname,
105 elsif ( $phase eq 'Update SQL'){
106 my $id = $input->param('id');
107 my $sql = $input->param('sql');
108 my $reportname = $input->param('reportname');
109 my $notes = $input->param('notes');
111 if ($sql =~ /;?\W?(UPDATE|DELETE|DROP|INSERT|SHOW|CREATE)\W/i) {
112 push @errors, {sqlerr => $1};
114 elsif ($sql !~ /^(SELECT)/i) {
115 push @errors, {queryerr => 1};
119 'errors' => \@errors,
124 update_sql( $id, $sql, $reportname, $notes );
126 'save_successful' => 1,
132 elsif ($phase eq 'retrieve results') {
133 my $id = $input->param('id');
134 my ($results,$name,$notes) = format_results($id);
138 'results' => $results,
144 elsif ( $phase eq 'Report on this Area' ) {
146 # they have choosen a new report and the area to report on
149 'area' => $input->param('areas'),
150 'types' => get_report_types(),
154 elsif ( $phase eq 'Choose this type' ) {
156 # they have chosen type and area
157 # get area and type and pass them to the template
158 my $area = $input->param('area');
159 my $type = $input->param('types');
164 columns => get_columns($area,$input),
168 elsif ( $phase eq 'Choose these columns' ) {
170 # we now know type, area, and columns
171 # next step is the constraints
172 my $area = $input->param('area');
173 my $type = $input->param('type');
174 my @columns = $input->param('columns');
175 my $column = join( ',', @columns );
181 definitions => get_from_dictionary($area),
182 criteria => get_criteria($area,$input),
186 elsif ( $phase eq 'Choose these criteria' ) {
187 my $area = $input->param('area');
188 my $type = $input->param('type');
189 my $column = $input->param('column');
190 my @definitions = $input->param('definition');
191 my $definition = join (',',@definitions);
192 my @criteria = $input->param('criteria_column');
194 foreach my $crit (@criteria) {
195 my $value = $input->param( $crit . "_value" );
197 if ($value =~ C4::Dates->regexp('syspref')) {
198 $value = C4::Dates->new($value)->output("iso");
200 $query_criteria .= " AND $crit='$value'";
208 'definition' => $definition,
209 'criteriastring' => $query_criteria,
213 my @columns = split( ',', $column );
216 # build structue for use by tmpl_loop to choose columns to order by
217 # need to do something about the order of the order :)
218 # we also want to use the %columns hash to get the plain english names
219 foreach my $col (@columns) {
220 my %total = (name => $col);
221 my @selects = map {+{ value => $_ }} (qw(sum min max avg count));
222 $total{'select'} = \@selects;
223 push @total_by, \%total;
226 $template->param( 'total_by' => \@total_by );
229 elsif ( $phase eq 'Choose These Operations' ) {
230 my $area = $input->param('area');
231 my $type = $input->param('type');
232 my $column = $input->param('column');
233 my $criteria = $input->param('criteria');
234 my $definition = $input->param('definition');
235 my @total_by = $input->param('total_by');
237 foreach my $total (@total_by) {
238 my $value = $input->param( $total . "_tvalue" );
239 $totals .= "$value($total),";
247 'criteriastring' => $criteria,
249 'definition' => $definition,
253 my @columns = split( ',', $column );
256 # build structue for use by tmpl_loop to choose columns to order by
257 # need to do something about the order of the order :)
258 foreach my $col (@columns) {
259 my %order = (name => $col);
260 my @selects = map {+{ value => $_ }} (qw(asc desc));
261 $order{'select'} = \@selects;
262 push @order_by, \%order;
265 $template->param( 'order_by' => \@order_by );
268 elsif ( $phase eq 'Build Report' ) {
270 # now we have all the info we need and can build the sql
271 my $area = $input->param('area');
272 my $type = $input->param('type');
273 my $column = $input->param('column');
274 my $crit = $input->param('criteria');
275 my $totals = $input->param('totals');
276 my $definition = $input->param('definition');
277 # my @criteria = split( ',', $crit );
278 my $query_criteria=$crit;
279 # split the columns up by ,
280 my @columns = split( ',', $column );
281 my @order_by = $input->param('order_by');
284 foreach my $order (@order_by) {
285 my $value = $input->param( $order . "_ovalue" );
286 if ($query_orderby) {
287 $query_orderby .= ",$order $value";
290 $query_orderby = " ORDER BY $order $value";
296 build_query( \@columns, $query_criteria, $query_orderby, $area, $totals, $definition );
304 elsif ( $phase eq 'Save' ) {
305 # Save the report that has just been built
306 my $sql = $input->param('sql');
307 my $type = $input->param('type');
315 elsif ( $phase eq 'Save Report' ) {
316 # save the sql pasted in by a user
317 my $sql = $input->param('sql');
318 my $name = $input->param('reportname');
319 my $type = $input->param('types');
320 my $notes = $input->param('notes');
321 if ($sql =~ /;?\W?(UPDATE|DELETE|DROP|INSERT|SHOW|CREATE)\W/i) {
322 push @errors, {sqlerr => $1};
324 elsif ($sql !~ /^(SELECT)/i) {
325 push @errors, {queryerr => 1};
329 'errors' => \@errors,
331 'reportname'=> $name,
337 save_report( $borrowernumber, $sql, $name, $type, $notes );
339 'save_successful' => 1,
344 elsif ($phase eq 'Run this report'){
345 # execute a saved report
346 my $limit = 20; # page size. # TODO: move to DB or syspref?
348 my $report = $input->param('reports');
350 if ($input->param('page')) {
351 $offset = ($input->param('page') - 1) * $limit;
353 my ($sql,$type,$name,$notes) = get_saved_report($report);
355 push @errors, {no_sql_for_id=>$report};
358 my ($sth, $errors) = execute_query($sql, $offset, $limit);
359 my $total = select_2_select_count_value($sql) || 0;
361 die "execute_query failed to return sth for report $report: $sql";
363 my $headref = $sth->{NAME} || [];
364 my @headers = map { +{ cell => $_ } } @$headref;
365 $template->param(header_row => \@headers);
366 while (my $row = $sth->fetchrow_arrayref()) {
367 my @cells = map { +{ cell => $_ } } @$row;
368 push @rows, { cells => \@cells };
372 my $totpages = int($total/$limit) + (($total % $limit) > 0 ? 1 : 0);
373 my $url = "/cgi-bin/koha/reports/guided_reports.pl?reports=$report&phase=Run%20this%20report";
381 'pagination_bar' => pagination_bar($url, $totpages, $input->param('page')),
382 'unlimited_total' => $total,
386 elsif ($phase eq 'Export'){
387 binmode STDOUT, ':utf8';
389 # export results to tab separated text or CSV
390 my $sql = $input->param('sql'); # FIXME: use sql from saved report ID#, not new user-supplied SQL!
391 my $format = $input->param('format');
392 my ($sth, $q_errors) = execute_query($sql);
393 unless ($q_errors and @$q_errors) {
394 print $input->header( -type => 'application/octet-stream',
395 -attachment=>"reportresults.$format"
397 if ($format eq 'tab') {
398 print join("\t", header_cell_values($sth)), "\n";
399 while (my $row = $sth->fetchrow_arrayref()) {
400 print join("\t", @$row), "\n";
403 my $csv = Text::CSV->new({binary => 1});
404 $csv or die "Text::CSV->new({binary => 1}) FAILED: " . Text::CSV->error_diag();
405 if ($csv->combine(header_cell_values($sth))) {
406 print $csv->string(), "\n";
408 push @$q_errors, { combine => 'HEADER ROW: ' . $csv->error_diag() } ;
410 while (my $row = $sth->fetchrow_arrayref()) {
411 if ($csv->combine(@$row)) {
412 print $csv->string(), "\n";
414 push @$q_errors, { combine => $csv->error_diag() } ;
418 foreach my $err (@$q_errors, @errors) {
419 print "# ERROR: " . (map {$_ . ": " . $err->{$_}} keys %$err) . "\n";
420 } # here we print all the non-fatal errors at the end. Not super smooth, but better than nothing.
426 'name' => 'Error exporting report!',
428 'errors' => $q_errors,
432 elsif ($phase eq 'Create report from SQL') {
433 # allow the user to paste in sql
434 if ($input->param('sql')) {
436 'sql' => $input->param('sql'),
437 'reportname' => $input->param('reportname'),
438 'notes' => $input->param('notes'),
441 $template->param('create' => 1);
444 elsif ($phase eq 'Create Compound Report'){
445 $template->param( 'savedreports' => get_saved_reports(),
450 elsif ($phase eq 'Save Compound'){
451 my $master = $input->param('master');
452 my $subreport = $input->param('subreport');
453 my ($mastertables,$subtables) = create_compound($master,$subreport);
454 $template->param( 'save_compound' => 1,
455 master=>$mastertables,
460 # pass $sth, get back an array of names for the column headers
461 sub header_cell_values {
462 my $sth = shift or return ();
463 return @{$sth->{NAME}};
466 # pass $sth, get back a TMPL_LOOP-able set of names for the column headers
467 sub header_cell_loop {
468 my @headers = map { +{ cell => $_ } } header_cell_values (shift);
473 $template->param('build' . $_) and $template->param(buildx => $_) and last;
475 $template->param( 'referer' => $input->referer(),
476 'DHTMLcalendar_dateformat' => C4::Dates->DHTMLcalendar(),
479 output_html_with_http_headers $input, $cookie, $template->output;