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 = get_sql($id);
103 elsif ( $phase eq 'Update SQL'){
104 my $id = $input->param('id');
105 my $sql = $input->param('sql');
107 if ($sql =~ /;?\W?(UPDATE|DELETE|DROP|INSERT|SHOW|CREATE)\W/i) {
108 push @errors, {sqlerr => $1};
110 elsif ($sql !~ /^(SELECT)/i) {
111 push @errors, {queryerr => 1};
115 'errors' => \@errors,
120 update_sql( $id, $sql );
122 'save_successful' => 1,
128 elsif ($phase eq 'retrieve results') {
129 my $id = $input->param('id');
130 my ($results,$name,$notes) = format_results($id);
134 'results' => $results,
140 elsif ( $phase eq 'Report on this Area' ) {
142 # they have choosen a new report and the area to report on
145 'area' => $input->param('areas'),
146 'types' => get_report_types(),
150 elsif ( $phase eq 'Choose this type' ) {
152 # they have chosen type and area
153 # get area and type and pass them to the template
154 my $area = $input->param('area');
155 my $type = $input->param('types');
160 columns => get_columns($area,$input),
164 elsif ( $phase eq 'Choose these columns' ) {
166 # we now know type, area, and columns
167 # next step is the constraints
168 my $area = $input->param('area');
169 my $type = $input->param('type');
170 my @columns = $input->param('columns');
171 my $column = join( ',', @columns );
177 definitions => get_from_dictionary($area),
178 criteria => get_criteria($area,$input),
182 elsif ( $phase eq 'Choose these criteria' ) {
183 my $area = $input->param('area');
184 my $type = $input->param('type');
185 my $column = $input->param('column');
186 my @definitions = $input->param('definition');
187 my $definition = join (',',@definitions);
188 my @criteria = $input->param('criteria_column');
190 foreach my $crit (@criteria) {
191 my $value = $input->param( $crit . "_value" );
193 if ($value =~ C4::Dates->regexp('syspref')) {
194 $value = C4::Dates->new($value)->output("iso");
196 $query_criteria .= " AND $crit='$value'";
204 'definition' => $definition,
205 'criteriastring' => $query_criteria,
209 my @columns = split( ',', $column );
212 # build structue for use by tmpl_loop to choose columns to order by
213 # need to do something about the order of the order :)
214 # we also want to use the %columns hash to get the plain english names
215 foreach my $col (@columns) {
216 my %total = (name => $col);
217 my @selects = map {+{ value => $_ }} (qw(sum min max avg count));
218 $total{'select'} = \@selects;
219 push @total_by, \%total;
222 $template->param( 'total_by' => \@total_by );
225 elsif ( $phase eq 'Choose These Operations' ) {
226 my $area = $input->param('area');
227 my $type = $input->param('type');
228 my $column = $input->param('column');
229 my $criteria = $input->param('criteria');
230 my $definition = $input->param('definition');
231 my @total_by = $input->param('total_by');
233 foreach my $total (@total_by) {
234 my $value = $input->param( $total . "_tvalue" );
235 $totals .= "$value($total),";
243 'criteriastring' => $criteria,
245 'definition' => $definition,
249 my @columns = split( ',', $column );
252 # build structue for use by tmpl_loop to choose columns to order by
253 # need to do something about the order of the order :)
254 foreach my $col (@columns) {
255 my %order = (name => $col);
256 my @selects = map {+{ value => $_ }} (qw(asc desc));
257 $order{'select'} = \@selects;
258 push @order_by, \%order;
261 $template->param( 'order_by' => \@order_by );
264 elsif ( $phase eq 'Build Report' ) {
266 # now we have all the info we need and can build the sql
267 my $area = $input->param('area');
268 my $type = $input->param('type');
269 my $column = $input->param('column');
270 my $crit = $input->param('criteria');
271 my $totals = $input->param('totals');
272 my $definition = $input->param('definition');
273 # my @criteria = split( ',', $crit );
274 my $query_criteria=$crit;
275 # split the columns up by ,
276 my @columns = split( ',', $column );
277 my @order_by = $input->param('order_by');
280 foreach my $order (@order_by) {
281 my $value = $input->param( $order . "_ovalue" );
282 if ($query_orderby) {
283 $query_orderby .= ",$order $value";
286 $query_orderby = " ORDER BY $order $value";
292 build_query( \@columns, $query_criteria, $query_orderby, $area, $totals, $definition );
300 elsif ( $phase eq 'Save' ) {
301 # Save the report that has just been built
302 my $sql = $input->param('sql');
303 my $type = $input->param('type');
311 elsif ( $phase eq 'Save Report' ) {
312 # save the sql pasted in by a user
313 my $sql = $input->param('sql');
314 my $name = $input->param('reportname');
315 my $type = $input->param('types');
316 my $notes = $input->param('notes');
317 if ($sql =~ /;?\W?(UPDATE|DELETE|DROP|INSERT|SHOW|CREATE)\W/i) {
318 push @errors, {sqlerr => $1};
320 elsif ($sql !~ /^(SELECT)/i) {
321 push @errors, {queryerr => 1};
325 'errors' => \@errors,
327 'reportname'=> $name,
333 save_report( $sql, $name, $type, $notes );
335 'save_successful' => 1,
340 elsif ($phase eq 'Run this report'){
341 # execute a saved report
342 my $limit = 20; # page size. # TODO: move to DB or syspref?
344 my $report = $input->param('reports');
346 if ($input->param('page')) {
347 $offset = ($input->param('page') - 1) * $limit;
349 my ($sql,$type,$name,$notes) = get_saved_report($report);
351 push @errors, {no_sql_for_id=>$report};
354 my ($sth, $errors) = execute_query($sql, $offset, $limit);
355 my $total = select_2_select_count_value($sql) || 0;
357 die "execute_query failed to return sth for report $report: $sql";
359 my $headref = $sth->{NAME} || [];
360 my @headers = map { +{ cell => $_ } } @$headref;
361 $template->param(header_row => \@headers);
362 while (my $row = $sth->fetchrow_arrayref()) {
363 my @cells = map { +{ cell => $_ } } @$row;
364 push @rows, { cells => \@cells };
368 my $totpages = int($total/$limit) + (($total % $limit) > 0 ? 1 : 0);
369 my $url = "/cgi-bin/koha/reports/guided_reports.pl?reports=$report&phase=Run%20this%20report";
377 'pagination_bar' => pagination_bar($url, $totpages, $input->param('page')),
378 'unlimited_total' => $total,
382 elsif ($phase eq 'Export'){
383 binmode STDOUT, ':utf8';
385 # export results to tab separated text or CSV
386 my $sql = $input->param('sql'); # FIXME: use sql from saved report ID#, not new user-supplied SQL!
387 my $format = $input->param('format');
388 my ($sth, $q_errors) = execute_query($sql);
389 unless ($q_errors and @$q_errors) {
390 print $input->header( -type => 'application/octet-stream',
391 -attachment=>"reportresults.$format"
393 if ($format eq 'tab') {
394 print join("\t", header_cell_values($sth)), "\n";
395 while (my $row = $sth->fetchrow_arrayref()) {
396 print join("\t", @$row), "\n";
399 my $csv = Text::CSV->new({binary => 1});
400 $csv or die "Text::CSV->new({binary => 1}) FAILED: " . Text::CSV->error_diag();
401 if ($csv->combine(header_cell_values($sth))) {
402 print $csv->string(), "\n";
404 push @$q_errors, { combine => 'HEADER ROW: ' . $csv->error_diag() } ;
406 while (my $row = $sth->fetchrow_arrayref()) {
407 if ($csv->combine(@$row)) {
408 print $csv->string(), "\n";
410 push @$q_errors, { combine => $csv->error_diag() } ;
414 foreach my $err (@$q_errors, @errors) {
415 print "# ERROR: " . (map {$_ . ": " . $err->{$_}} keys %$err) . "\n";
416 } # here we print all the non-fatal errors at the end. Not super smooth, but better than nothing.
422 'name' => 'Error exporting report!',
424 'errors' => $q_errors,
428 elsif ($phase eq 'Create report from SQL') {
429 # allow the user to paste in sql
430 if ($input->param('sql')) {
432 'sql' => $input->param('sql'),
433 'reportname' => $input->param('reportname'),
434 'notes' => $input->param('notes'),
437 $template->param('create' => 1);
440 elsif ($phase eq 'Create Compound Report'){
441 $template->param( 'savedreports' => get_saved_reports(),
446 elsif ($phase eq 'Save Compound'){
447 my $master = $input->param('master');
448 my $subreport = $input->param('subreport');
449 my ($mastertables,$subtables) = create_compound($master,$subreport);
450 $template->param( 'save_compound' => 1,
451 master=>$mastertables,
456 # pass $sth, get back an array of names for the column headers
457 sub header_cell_values {
458 my $sth = shift or return ();
459 return @{$sth->{NAME}};
462 # pass $sth, get back a TMPL_LOOP-able set of names for the column headers
463 sub header_cell_loop {
464 my @headers = map { +{ cell => $_ } } header_cell_values (shift);
469 $template->param('build' . $_) and $template->param(buildx => $_) and last;
471 $template->param( 'referer' => $input->referer(),
472 'DHTMLcalendar_dateformat' => C4::Dates->DHTMLcalendar(),
475 output_html_with_http_headers $input, $cookie, $template->output;