10 use DateTime::Format::ISO8601;
13 use OpenILS::WWW::Reporter::transforms;
15 use Spreadsheet::WriteExcel;
16 use OpenSRF::EX qw/:try/;
17 use OpenSRF::Utils qw/:daemon/;
18 use OpenSRF::Utils::Logger qw/:level/;
21 use GD::Graph::bars3d;
22 use GD::Graph::lines3d;
27 my ($base_xml, $count, $daemon) = ('/openils/conf/reporter.xml', 1);
30 "file=s" => \$base_xml,
32 "concurrency=i" => \$count,
35 my $parser = XML::LibXML->new;
36 $parser->expand_xinclude(1);
38 my $doc = $parser->parse_file($base_xml);
40 my $db_driver = $doc->findvalue('/reporter/setup/database/driver');
41 my $db_host = $doc->findvalue('/reporter/setup/database/host');
42 my $db_name = $doc->findvalue('/reporter/setup/database/name');
43 my $db_user = $doc->findvalue('/reporter/setup/database/user');
44 my $db_pw = $doc->findvalue('/reporter/setup/database/password');
46 my $dsn = "dbi:" . $db_driver . ":dbname=" . $db_name .';host=' . $db_host;
48 my ($dbh,$running,$sth,@reports,$run, $current_time);
50 daemonize("Clark Kent, waiting for trouble") if ($daemon);
54 $dbh = DBI->connect($dsn,$db_user,$db_pw, {pg_enable_utf8 => 1, RaiseError => 1});
56 $current_time = DateTime->from_epoch( epoch => time() )->strftime('%FT%T%z');
57 # Move new reports into the run queue
58 $dbh->do(<<'SQL', {}, $current_time);
59 INSERT INTO reporter.output ( stage3, state )
63 AND ( ( recurrence = '0 seconds'::INTERVAL
65 id NOT IN ( SELECT stage3 FROM reporter.output )
69 OR ( recurrence > '0 seconds'::INTERVAL
73 WHERE state <> 'complete')
79 # make sure we're not already running $count reports
80 ($running) = $dbh->selectrow_array(<<SQL);
83 WHERE state = 'running';
86 if ($count <= $running) {
90 POSIX::waitpid( -1, POSIX::WNOHANG );
94 print "Already running maximum ($running) concurrent reports\n";
98 # if we have some open slots then generate the sql
99 $run = $count - $running;
101 $sth = $dbh->prepare(<<SQL);
112 while (my $r = $sth->fetchrow_hashref) {
113 my $s3 = $dbh->selectrow_hashref(<<" SQL", {}, $r->{stage3});
114 SELECT * FROM reporter.stage3 WHERE id = ?;
117 my $s2 = $dbh->selectrow_hashref(<<" SQL", {}, $s3->{stage2});
118 SELECT * FROM reporter.stage2 WHERE id = ?;
124 generate_query( $r );
132 # Now we spaun the report runners
134 for my $r ( @reports ) {
135 next if (safe_fork());
137 # This is the child (runner) process;
138 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
139 daemonize("Clark Kent reporting: $p->{reportname}");
141 $dbh = DBI->connect($dsn,$db_user,$db_pw, {pg_enable_utf8 => 1, RaiseError => 1});
144 $dbh->do(<<' SQL',{}, $r->{sql}->{'select'}, $$, $r->{id});
145 UPDATE reporter.output
146 SET state = 'running',
153 my ($runtime) = $dbh->selectrow_array("SELECT run_time FROM reporter.output WHERE id = ?",{},$r->{id});
154 $r->{run_time} = $runtime;
156 $sth = $dbh->prepare($r->{sql}->{'select'});
158 $sth->execute(@{ $r->{sql}->{'bind'} });
159 $r->{data} = $sth->fetchall_arrayref;
163 my $base = $doc->findvalue('/reporter/setup/files/output_base');
164 my $s1 = $r->{stage3}->{stage2}->{stage1};
165 my $s2 = $r->{stage3}->{stage2}->{id};
166 my $s3 = $r->{stage3}->{id};
167 my $output = $r->{id};
171 mkdir("$base/$s1/$s2");
172 mkdir("$base/$s1/$s2/$s3");
173 mkdir("$base/$s1/$s2/$s3/$output");
176 if (ref $p->{output_format}) {
177 @formats = @{ $p->{output_format} };
179 @formats = ( $p->{output_format} );
182 if ( grep { $_ eq 'csv' } @formats ) {
183 build_csv("$base/$s1/$s2/$s3/$output/report-data.csv", $r);
186 if ( grep { $_ eq 'excel' } @formats ) {
187 build_excel("$base/$s1/$s2/$s3/$output/report-data.xls", $r);
190 if ( grep { $_ eq 'html' } @formats ) {
191 mkdir("$base/$s1/$s2/$s3/$output/html");
192 build_html("$base/$s1/$s2/$s3/$output/report-data.html", $r);
197 $dbh->do(<<' SQL',{}, $r->{run_time}, $r->{stage3}->{id});
198 UPDATE reporter.stage3
199 SET runtime = CAST(? AS TIMESTAMP WITH TIME ZONE) + recurrence
200 WHERE id = ? AND recurrence > '0 seconds'::INTERVAL;
202 $dbh->do(<<' SQL',{}, $r->{stage3}->{id});
203 UPDATE reporter.stage3
205 WHERE id = ? AND rerun = TRUE;
207 $dbh->do(<<' SQL',{}, $r->{id});
208 UPDATE reporter.output
209 SET state = 'complete',
210 complete_time = 'now'
219 $dbh->do(<<' SQL',{}, $e, $r->{id});
220 UPDATE reporter.output
231 exit; # leave the child
236 POSIX::waitpid( -1, POSIX::WNOHANG );
241 #-------------------------------------------------------------------
245 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
246 my $settings = $r->{sql};
247 my $data = $r->{data};
249 return unless (defined($settings->{pivot}));
251 my @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
252 my @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
253 splice(@values,$_,1) for (reverse @groups);
255 # remove pivot from group-by
258 while ($count < scalar(@{$settings->{groupby}})) {
259 if (defined $pivot_groupby) {
260 $settings->{groupby}->[$count] -= 1;
261 if ($settings->{groupby}->[$count] >= $values[0] + 1) {
262 $settings->{groupby}->[$count] -= 1;
264 } elsif ($settings->{groupby}->[$count] == $settings->{pivot} + 1) {
265 $pivot_groupby = $count;
271 # grab positions of non-group-bys
272 @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
273 splice(@values,$_,1) for (reverse @groups);
275 # we're only doing one "value" for now, so grab that and remove from headings
276 my ($val_col) = @values;
280 ($val_col, $settings->{groupby}->[$pivot_groupby] - 1);
283 for my $row (@$data) {
284 $p_header{ $$row[$settings->{pivot}] } = [] unless exists($p_header{ $$row[$settings->{pivot}] });
286 push @{ $p_header{ $$row[$settings->{pivot}] } }, $$row[$val_col];
288 splice(@$row,$_,1) for (@remove_me);
291 push @{ $settings->{columns} }, sort keys %p_header;
293 # remove from headings;
294 splice(@{$settings->{columns}},$_,1) for (@remove_me);
296 # remove pivot from groupby
297 splice(@{$settings->{groupby}}, $pivot_groupby, 1);
298 @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
300 $count = scalar(keys %p_header);
304 for my $row (@$data) {
306 my $fingerprint = join('',@$row[@groups]);
307 next if $seenit{$fingerprint};
309 $seenit{$fingerprint}++;
311 for my $h ( sort keys %p_header ) {
312 push @$row, shift(@{ $p_header{$h} });
315 push @new_data, [@$row];
319 #replace old data with new
320 $r->{data} = \@new_data;
328 my $csv = Text::CSV_XS->new({ always_quote => 1, eol => "\015\012" });
329 my $f = new FileHandle (">$file");
331 $csv->print($f, $r->{sql}->{columns});
332 $csv->print($f, $_) for (@{$r->{data}});
339 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
341 my $xls = Spreadsheet::WriteExcel->new($file);
343 my $sheetname = substr($p->{reportname},1,31);
344 $sheetname =~ s/\W/_/gos;
346 my $sheet = $xls->add_worksheet($sheetname);
348 $sheet->write_row('A1', $r->{sql}->{columns});
350 $sheet->write_col('A2', $r->{data});
358 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
360 my $index = new FileHandle (">$file");
361 my $raw = new FileHandle (">$file.raw.html");
364 print $index <<" HEADER";
367 <title>$$p{reportname}</title>
369 table { border-collapse: collapse; }
370 th { background-color: lightgray; }
371 td,th { border: solid black 1px; }
372 * { font-family: sans-serif; font-size: 10px; }
376 <h2><u>$$p{reportname}</u></h2>
380 # add a link to the raw output html
381 print $index "<a href='report-data.html.raw.html'>Raw output data</a><br/><br/><br/><br/>";
383 # create the raw output html file
384 print $raw "<html><head><title>$$p{reportname}</title>";
388 table { border-collapse: collapse; }
389 th { background-color: lightgray; }
390 td,th { border: solid black 1px; }
391 * { font-family: sans-serif; font-size: 10px; }
395 print $raw "</head><body><table>";
398 print $raw "<tr><th>".join('</th><th>',@{$r->{sql}->{columns}}).'</th></tr>';
399 print $raw "<tr><td>".join('</td><td>',@$_ ).'</td></tr>' for (@{$r->{data}});
402 print $raw '</table></body></html>';
406 # get the graph types
408 if (ref $$p{html_graph_type}) {
409 @graphs = @{ $$p{html_graph_type} };
411 @graphs = ( $$p{html_graph_type} );
414 # Time for a pie chart
415 if (grep {$_ eq 'pie'} @graphs) {
416 my $pics = draw_pie($r, $p, $file);
417 for my $pic (@$pics) {
418 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
422 print $index '<br/><br/><br/><br/>';
423 # Time for a bar chart
424 if (grep {$_ eq 'bar'} @graphs) {
425 my $pics = draw_bars($r, $p, $file);
426 for my $pic (@$pics) {
427 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
431 print $index '<br/><br/><br/><br/>';
432 # Time for a bar chart
433 if (grep {$_ eq 'line'} @graphs) {
434 my $pics = draw_lines($r, $p, $file);
435 for my $pic (@$pics) {
436 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
442 print $index '</body></html>';
451 my $data = $r->{data};
452 my $settings = $r->{sql};
454 my @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
456 my @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
457 delete @values[@groups];
459 my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
462 for my $vcol (@values) {
463 next unless (defined $vcol);
465 my @pic_data = ([],[]);
466 for my $row (@$data) {
467 next if (!defined($$row[$vcol]) || $$row[$vcol] == 0);
468 my $val = $$row[$vcol];
469 push @{$pic_data[0]}, join(" -- ", @$row[@groups])." ($val)";
470 push @{$pic_data[1]}, $val;
473 next unless (@{$pic_data[0]});
476 my $split = int(scalar(@{$pic_data[0]}) / $size);
477 my $last = scalar(@{$pic_data[0]}) % $size;
479 for my $sub_graph (0 .. $split) {
481 if ($sub_graph == $split) {
486 for my $set (@pic_data) {
487 push @sub_data, [ splice(@$set,0,$size) ];
490 my $pic = new GD::Graph::pie;
493 label => $settings->{columns}->[$vcol],
495 legend_placement => 'R',
497 logo_position => 'TL',
502 my $format = $pic->export_format;
504 open(IMG, ">$file.pie.$vcol.$sub_graph.$format");
509 $pic->plot(\@sub_data) or die $pic->error;
510 print IMG $pic->gd->$format;
513 warn "Couldn't draw $file.pie.$vcol.$sub_graph.$format : $e";
521 { file => "pie.$vcol.$sub_graph.$format",
522 name => $settings->{columns}->[$vcol].' (Pie)',
523 } unless ($forgetit);
525 last if ($sub_graph == $split);
537 my $data = $r->{data};
538 my $settings = $r->{sql};
540 my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
542 my @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
545 my @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
546 splice(@values,$_,1) for (reverse @groups);
550 for my $row (@$data) {
551 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
561 for my $vcol (@values) {
562 next unless (defined $vcol);
566 for my $row (@$data) {
567 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
568 push @{$pic_data[$set]}, $val;
569 $max_y = $val if ($val > $max_y);
570 $trim_candidates{$pos}++ if ($val == 0);
576 my $set_count = scalar(@pic_data) - 1;
577 my @trim_cols = grep { $trim_candidates{$_} == $set_count } keys %trim_candidates;
583 for my $dataset (@pic_data) {
584 splice(@$dataset,$_,1) for (sort { $b <=> $a } @trim_cols);
586 if (grep { $_ } @$dataset) {
587 push @new_data, $dataset;
588 push @use_me, $set_index;
590 push @no_use, $set_index;
596 for my $col (@use_me) {
597 push @leg, $settings->{columns}->[$col + @groups - 1] if (map { 1 } grep { $col == $_ } @values);
600 my $w = 100 + 10 * scalar(@{$new_data[0]});
601 $w = 400 if ($w < 400);
603 my $h = 10 * (scalar(@new_data) / 2);
607 my $pic = new GD::Graph::bars3d ($w + 250, $h + 500);
610 title => $p->{reportname},
611 x_labels_vertical => 1,
615 y_max_value => $max_y,
616 legend_placement => 'TR',
619 logo_position => 'R',
624 $pic->set_legend(@leg);
626 my $format = $pic->export_format;
628 open(IMG, ">$file.bar.$format");
632 $pic->plot(\@new_data) or die $pic->error;
633 print IMG $pic->gd->$format;
636 warn "Couldn't draw $file.bar.$format : $e";
641 return [{ file => "bar.$format",
642 name => $p->{reportname}.' (Bar)',
651 my $data = $r->{data};
652 my $settings = $r->{sql};
654 my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
656 my @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
659 my @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
660 splice(@values,$_,1) for (reverse @groups);
664 for my $row (@$data) {
665 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
673 for my $vcol (@values) {
674 next unless (defined $vcol);
677 for my $row (@$data) {
678 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
679 push @{$pic_data[$set]}, $val;
680 $max_y = $val if ($val > $max_y);
685 my $set_count = scalar(@pic_data) - 1;
691 for my $dataset (@pic_data) {
693 if (grep { $_ } @$dataset) {
694 push @new_data, $dataset;
695 push @use_me, $set_index;
697 push @no_use, $set_index;
703 for my $col (@use_me) {
704 push @leg, $settings->{columns}->[$col + @groups - 1] if (map { 1 } grep { $col == $_ } @values);
707 my $w = 100 + 10 * scalar(@{$new_data[0]});
708 $w = 400 if ($w < 400);
710 my $h = 10 * (scalar(@new_data) / 2);
714 my $pic = new GD::Graph::lines3d ($w + 250, $h + 500);
717 title => $p->{reportname},
718 x_labels_vertical => 1,
721 y_max_value => $max_y,
722 legend_placement => 'TR',
725 logo_position => 'R',
730 $pic->set_legend(@leg);
732 my $format = $pic->export_format;
734 open(IMG, ">$file.line.$format");
738 $pic->plot(\@new_data) or die $pic->error;
739 print IMG $pic->gd->$format;
742 warn "Couldn't draw $file.line.$format : $e";
747 return [{ file => "line.$format",
748 name => $p->{reportname}.' (Bar)',
755 my ($node) = $doc->findnodes("//*[\@id='$id']");
756 if ($node && $node->findvalue('@table')) {
757 ($node) = $doc->findnodes("//*[\@id='".$node->getAttribute('table')."']");
765 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
769 my $core = $r->{stage3}->{stage2}->{stage1};
772 for my $t (keys %{$$p{filter}}) {
778 for my $t (keys %{$$p{output}}) {
779 if ($t ne $core && !(grep { $t eq $_ } @dims) ) {
787 my $t = table_by_id($d);
788 my $t_name = $t->findvalue('tablename');
789 push @dim_from, "$t_name AS \"$d\""
790 unless ( grep {$_ eq "$t_name AS \"$d\""} @dim_from );
792 my $k = $doc->findvalue("//*[\@id='$d']/\@key");
793 push @dim_select, "\"$d\".\"$k\" AS \"${d}_${k}\""
794 unless ( grep {$_ eq "\"$d\".\"$k\" AS \"${d}_${k}\""} @dim_select );
796 for my $c ( keys %{$$p{output}{$d}} ) {
797 push @dim_select, "\"$d\".\"$c\" AS \"${d}_${c}\""
798 unless ( grep {$_ eq "\"$d\".\"$c\" AS \"${d}_${c}\""} @dim_select );
801 for my $c ( keys %{$$p{filter}{$d}} ) {
802 next if (exists $$p{output}{$d}{$c});
803 push @dim_select, "\"$d\".\"$c\" AS \"${d}_${c}\""
804 unless ( grep {$_ eq "\"$d\".\"$c\" AS \"${d}_${c}\""} @dim_select );
809 '(SELECT ' . join(',', @dim_select) .
810 ' FROM ' . join(',', @dim_from) . ') AS dims';
813 if (ref $$p{output_order}) {
814 @opord = @{ $$p{output_order} };
816 @opord = ( $$p{output_order} );
818 my @output_order = map { { (split ':')[1] => (split ':')[2] } } @opord;
819 my @p_col = split(':',$p->{pivot_col}) if $p->{pivot_col};
825 my @dim_col_names = ();
829 for my $pair (@output_order) {
830 my ($t_name) = keys %$pair;
833 $t_name = "dims" if ($t ne $core);
835 my $t_node = table_by_id($t);
837 for my $c ( values %$pair ) {
838 my $label = $t_node->findvalue("fields/field[\@name='$c']/label");
841 $full_col = "${t}_${c}" if ($t ne $t_name);
842 $full_col = "\"$t_name\".\"$full_col\"";
844 if (my $xform_type = $$p{xform}{type}{$t}{$c}) {
845 my $xform = $$OpenILS::WWW::Reporter::dtype_xforms{$xform_type};
846 if ($xform->{group}) {
849 $label = "$$xform{label} -- $label";
851 my $tmp = $xform->{'select'};
852 $tmp =~ s/\?COLNAME\?/$full_col/gs;
853 $tmp =~ s/\?PARAM\?/$$p{xform}{param}{$t}{$c}/gs;
859 push @output, "$full_col AS \"$label\"";
860 push @columns, $label;
861 $pivot = scalar(@columns) - 1 if (@p_col && $t eq $p_col[1] && $c eq $p_col[2]);
865 if ($t ne $t_name && (!@join_base || !grep{$t eq $_}@join_base)) {
866 my $k = $doc->findvalue("//*[\@id='$t']/\@key");
867 my $f = $doc->findvalue("//*[\@id='$t']/\@field");
868 push @join, "dims.\"${t}_${k}\" = \"$core\".\"$f\"";
875 for my $t ( keys %{$$p{filter}} ) {
877 $t_name = "dims" if ($t ne $core);
879 my $t_node = table_by_id($t);
881 for my $c ( keys %{$$p{filter}{$t}} ) {
882 my $label = $t_node->findvalue("fields/field[\@name='$c']/label");
885 $full_col = "${t}_${c}" if ($t ne $t_name);
886 $full_col = "\"$t_name\".\"$full_col\"";
888 my ($fam) = keys %{ $$p{filter}{$t}{$c} };
889 my ($w) = keys %{ $$p{filter}{$t}{$c}{$fam} };
890 my $val = $$p{filter}{$t}{$c}{$fam}{$w};
892 my $filter_code_xpath = "/reporter/widgets/widget-family[\@name='$fam']/widget[\@name='$w']/filter-code[\@type='perl']";
893 if (my $widget_code = $doc->findvalue($filter_code_xpath)) { # widget supplys it's own filter code
894 my ($where_clause, $bind_list) = ('',[]);
898 die "$@\n\n$widget_code" if ($@);
900 push @where, $where_clause;
901 push @bind, @$bind_list;
904 push @where, "$full_col IN (".join(",",map {'?'}@$val).")";
907 push @where, "$full_col = ?";
912 if ($t ne $t_name && (!@join_base || !grep{$t eq $_}@join_base)) {
913 my $k = $doc->findvalue("//*[\@id='$t']/\@key");
914 my $f = $doc->findvalue("//*[\@id='$t']/\@field");
915 push @join, "dims.\"${t}_${k}\" = \"$core\".\"$f\"";
920 my $t = table_by_id($core)->findvalue('tablename');
922 my $from = " FROM $t AS \"$core\" ";
923 $from .= "RIGHT JOIN $d_select ON (". join(' AND ', @join).")" if ( @join );
926 "SELECT ".join(',', @output). $from;
928 $select .= ' WHERE '.join(' AND ', @where) if (@where);
929 $select .= ' GROUP BY '.join(',',@groupby) if (@groupby);
931 $r->{sql}->{'pivot'} = $pivot;
932 $r->{sql}->{'select'} = $select;
933 $r->{sql}->{'bind'} = \@bind;
934 $r->{sql}->{columns} = \@columns;
935 $r->{sql}->{groupby} = \@groupby;