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_port = $doc->findvalue('/reporter/setup/database/port') || '5432';
43 my $db_name = $doc->findvalue('/reporter/setup/database/name');
44 my $db_user = $doc->findvalue('/reporter/setup/database/user');
45 my $db_pw = $doc->findvalue('/reporter/setup/database/password');
47 my $dsn = "dbi:" . $db_driver . ":dbname=" . $db_name .';host=' . $db_host . ';port=' . $db_port;
49 my ($dbh,$running,$sth,@reports,$run, $current_time);
51 daemonize("Clark Kent, waiting for trouble") if ($daemon);
55 $dbh = DBI->connect($dsn,$db_user,$db_pw, {pg_enable_utf8 => 1, RaiseError => 1});
57 $current_time = DateTime->from_epoch( epoch => time() )->strftime('%FT%T%z');
58 # Move new reports into the run queue
59 $dbh->do(<<'SQL', {}, $current_time);
60 INSERT INTO reporter.output ( stage3, state )
64 AND ( ( recurrence = '0 seconds'::INTERVAL
66 id NOT IN ( SELECT stage3 FROM reporter.output )
70 OR ( recurrence > '0 seconds'::INTERVAL
74 WHERE state <> 'complete')
80 # make sure we're not already running $count reports
81 ($running) = $dbh->selectrow_array(<<SQL);
84 WHERE state = 'running';
87 if ($count <= $running) {
91 POSIX::waitpid( -1, POSIX::WNOHANG );
95 print "Already running maximum ($running) concurrent reports\n";
99 # if we have some open slots then generate the sql
100 $run = $count - $running;
102 $sth = $dbh->prepare(<<SQL);
113 while (my $r = $sth->fetchrow_hashref) {
114 my $s3 = $dbh->selectrow_hashref(<<" SQL", {}, $r->{stage3});
115 SELECT * FROM reporter.stage3 WHERE id = ?;
118 my $s2 = $dbh->selectrow_hashref(<<" SQL", {}, $s3->{stage2});
119 SELECT * FROM reporter.stage2 WHERE id = ?;
125 generate_query( $r );
133 # Now we spaun the report runners
135 for my $r ( @reports ) {
136 next if (safe_fork());
138 # This is the child (runner) process;
139 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
140 daemonize("Clark Kent reporting: $p->{reportname}");
142 $dbh = DBI->connect($dsn,$db_user,$db_pw, {pg_enable_utf8 => 1, RaiseError => 1});
145 $dbh->do(<<' SQL',{}, $r->{sql}->{'select'}, $$, $r->{id});
146 UPDATE reporter.output
147 SET state = 'running',
154 my ($runtime) = $dbh->selectrow_array("SELECT run_time FROM reporter.output WHERE id = ?",{},$r->{id});
155 $r->{run_time} = $runtime;
157 $sth = $dbh->prepare($r->{sql}->{'select'});
159 $sth->execute(@{ $r->{sql}->{'bind'} });
160 $r->{data} = $sth->fetchall_arrayref;
164 my $base = $doc->findvalue('/reporter/setup/files/output_base');
165 my $s1 = $r->{stage3}->{stage2}->{stage1};
166 my $s2 = $r->{stage3}->{stage2}->{id};
167 my $s3 = $r->{stage3}->{id};
168 my $output = $r->{id};
172 mkdir("$base/$s1/$s2");
173 mkdir("$base/$s1/$s2/$s3");
174 mkdir("$base/$s1/$s2/$s3/$output");
177 if (ref $p->{output_format}) {
178 @formats = @{ $p->{output_format} };
180 @formats = ( $p->{output_format} );
183 if ( grep { $_ eq 'csv' } @formats ) {
184 build_csv("$base/$s1/$s2/$s3/$output/report-data.csv", $r);
187 if ( grep { $_ eq 'excel' } @formats ) {
188 build_excel("$base/$s1/$s2/$s3/$output/report-data.xls", $r);
191 if ( grep { $_ eq 'html' } @formats ) {
192 mkdir("$base/$s1/$s2/$s3/$output/html");
193 build_html("$base/$s1/$s2/$s3/$output/report-data.html", $r);
198 #$dbh->do(<<' SQL',{}, $r->{run_time}, $r->{stage3}->{id});
199 # UPDATE reporter.stage3
200 # SET runtime = CAST(? AS TIMESTAMP WITH TIME ZONE) + recurrence
201 # WHERE id = ? AND recurrence > '0 seconds'::INTERVAL;
203 $dbh->do(<<' SQL',{}, $r->{stage3}->{id});
204 UPDATE reporter.stage3
205 SET runtime = runtime + recurrence
206 WHERE id = ? AND recurrence > '0 seconds'::INTERVAL;
208 $dbh->do(<<' SQL',{}, $r->{stage3}->{id});
209 UPDATE reporter.stage3
211 WHERE id = ? AND rerun = TRUE;
213 $dbh->do(<<' SQL',{}, $r->{id});
214 UPDATE reporter.output
215 SET state = 'complete',
216 complete_time = 'now'
225 $dbh->do(<<' SQL',{}, $e, $r->{id});
226 UPDATE reporter.output
237 exit; # leave the child
242 POSIX::waitpid( -1, POSIX::WNOHANG );
247 #-------------------------------------------------------------------
251 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
252 my $settings = $r->{sql};
253 my $data = $r->{data};
255 return unless (defined($settings->{pivot}));
257 my @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
258 my @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
259 splice(@values,$_,1) for (reverse @groups);
261 # remove pivot from group-by
264 while ($count < scalar(@{$settings->{groupby}})) {
265 if (defined $pivot_groupby) {
266 $settings->{groupby}->[$count] -= 1;
267 if ($settings->{groupby}->[$count] >= $values[0] + 1) {
268 $settings->{groupby}->[$count] -= 1;
270 } elsif ($settings->{groupby}->[$count] == $settings->{pivot} + 1) {
271 $pivot_groupby = $count;
277 # grab positions of non-group-bys
278 @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
279 splice(@values,$_,1) for (reverse @groups);
281 # we're only doing one "value" for now, so grab that and remove from headings
282 my ($val_col) = @values;
286 ($val_col, $settings->{groupby}->[$pivot_groupby] - 1);
289 for my $row (@$data) {
290 $p_header{ $$row[$settings->{pivot}] } = [] unless exists($p_header{ $$row[$settings->{pivot}] });
292 push @{ $p_header{ $$row[$settings->{pivot}] } }, $$row[$val_col];
294 splice(@$row,$_,1) for (@remove_me);
297 push @{ $settings->{columns} }, sort keys %p_header;
299 # remove from headings;
300 splice(@{$settings->{columns}},$_,1) for (@remove_me);
302 # remove pivot from groupby
303 splice(@{$settings->{groupby}}, $pivot_groupby, 1);
304 @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
306 $count = scalar(keys %p_header);
310 for my $row (@$data) {
312 my $fingerprint = join('',@$row[@groups]);
313 next if $seenit{$fingerprint};
315 $seenit{$fingerprint}++;
317 for my $h ( sort keys %p_header ) {
318 push @$row, shift(@{ $p_header{$h} });
321 push @new_data, [@$row];
325 #replace old data with new
326 $r->{data} = \@new_data;
334 my $csv = Text::CSV_XS->new({ always_quote => 1, eol => "\015\012" });
336 return unless ($csv);
338 my $f = new FileHandle (">$file");
340 $csv->print($f, $r->{sql}->{columns});
341 $csv->print($f, $_) for (@{$r->{data}});
348 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
350 my $xls = Spreadsheet::WriteExcel->new($file);
352 my $sheetname = substr($p->{reportname},1,31);
353 $sheetname =~ s/\W/_/gos;
355 my $sheet = $xls->add_worksheet($sheetname);
357 $sheet->write_row('A1', $r->{sql}->{columns});
359 $sheet->write_col('A2', $r->{data});
367 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
369 my $index = new FileHandle (">$file");
370 my $raw = new FileHandle (">$file.raw.html");
373 print $index <<" HEADER";
376 <title>$$p{reportname}</title>
378 table { border-collapse: collapse; }
379 th { background-color: lightgray; }
380 td,th { border: solid black 1px; }
381 * { font-family: sans-serif; font-size: 10px; }
385 <h2><u>$$p{reportname}</u></h2>
389 # add a link to the raw output html
390 print $index "<a href='report-data.html.raw.html'>Raw output data</a><br/><br/><br/><br/>";
392 # create the raw output html file
393 print $raw "<html><head><title>$$p{reportname}</title>";
397 table { border-collapse: collapse; }
398 th { background-color: lightgray; }
399 td,th { border: solid black 1px; }
400 * { font-family: sans-serif; font-size: 10px; }
404 print $raw "</head><body><table>";
407 print $raw "<tr><th>".join('</th><th>',@{$r->{sql}->{columns}}).'</th></tr>';
408 print $raw "<tr><td>".join('</td><td>',@$_ ).'</td></tr>' for (@{$r->{data}});
411 print $raw '</table></body></html>';
415 # get the graph types
417 if (ref $$p{html_graph_type}) {
418 @graphs = @{ $$p{html_graph_type} };
420 @graphs = ( $$p{html_graph_type} );
423 # Time for a pie chart
424 if (grep {$_ eq 'pie'} @graphs) {
425 my $pics = draw_pie($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 'bar'} @graphs) {
434 my $pics = draw_bars($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/>";
440 print $index '<br/><br/><br/><br/>';
441 # Time for a bar chart
442 if (grep {$_ eq 'line'} @graphs) {
443 my $pics = draw_lines($r, $p, $file);
444 for my $pic (@$pics) {
445 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
451 print $index '</body></html>';
460 my $data = $r->{data};
461 my $settings = $r->{sql};
463 my @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
465 my @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
466 delete @values[@groups];
468 my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
471 for my $vcol (@values) {
472 next unless (defined $vcol);
474 my @pic_data = ([],[]);
475 for my $row (@$data) {
476 next if (!defined($$row[$vcol]) || $$row[$vcol] == 0);
477 my $val = $$row[$vcol];
478 push @{$pic_data[0]}, join(" -- ", @$row[@groups])." ($val)";
479 push @{$pic_data[1]}, $val;
482 next unless (@{$pic_data[0]});
485 my $split = int(scalar(@{$pic_data[0]}) / $size);
486 my $last = scalar(@{$pic_data[0]}) % $size;
488 for my $sub_graph (0 .. $split) {
490 if ($sub_graph == $split) {
495 for my $set (@pic_data) {
496 push @sub_data, [ splice(@$set,0,$size) ];
499 my $pic = new GD::Graph::pie;
502 label => $settings->{columns}->[$vcol],
504 legend_placement => 'R',
506 logo_position => 'TL',
511 my $format = $pic->export_format;
513 open(IMG, ">$file.pie.$vcol.$sub_graph.$format");
518 $pic->plot(\@sub_data) or die $pic->error;
519 print IMG $pic->gd->$format;
522 warn "Couldn't draw $file.pie.$vcol.$sub_graph.$format : $e";
530 { file => "pie.$vcol.$sub_graph.$format",
531 name => $settings->{columns}->[$vcol].' (Pie)',
532 } unless ($forgetit);
534 last if ($sub_graph == $split);
546 my $data = $r->{data};
547 my $settings = $r->{sql};
549 my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
551 my @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
554 my @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
555 splice(@values,$_,1) for (reverse @groups);
559 for my $row (@$data) {
560 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
570 for my $vcol (@values) {
571 next unless (defined $vcol);
575 for my $row (@$data) {
576 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
577 push @{$pic_data[$set]}, $val;
578 $max_y = $val if ($val > $max_y);
579 $trim_candidates{$pos}++ if ($val == 0);
585 my $set_count = scalar(@pic_data) - 1;
586 my @trim_cols = grep { $trim_candidates{$_} == $set_count } keys %trim_candidates;
592 for my $dataset (@pic_data) {
593 splice(@$dataset,$_,1) for (sort { $b <=> $a } @trim_cols);
595 if (grep { $_ } @$dataset) {
596 push @new_data, $dataset;
597 push @use_me, $set_index;
599 push @no_use, $set_index;
605 return [] unless ($new_data[0] && @{$new_data[0]});
607 for my $col (@use_me) {
608 push @leg, $settings->{columns}->[$col + @groups - 1] if (map { 1 } grep { $col == $_ } @values);
611 my $w = 100 + 10 * scalar(@{$new_data[0]});
612 $w = 400 if ($w < 400);
614 my $h = 10 * (scalar(@new_data) / 2);
618 my $pic = new GD::Graph::bars3d ($w + 250, $h + 500);
621 title => $p->{reportname},
622 x_labels_vertical => 1,
626 y_max_value => $max_y,
627 legend_placement => 'TR',
630 logo_position => 'R',
635 $pic->set_legend(@leg);
637 my $format = $pic->export_format;
639 open(IMG, ">$file.bar.$format");
643 $pic->plot(\@new_data) or die $pic->error;
644 print IMG $pic->gd->$format;
647 warn "Couldn't draw $file.bar.$format : $e";
652 return [{ file => "bar.$format",
653 name => $p->{reportname}.' (Bar)',
662 my $data = $r->{data};
663 my $settings = $r->{sql};
665 my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
667 my @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
670 my @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
671 splice(@values,$_,1) for (reverse @groups);
675 for my $row (@$data) {
676 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
684 for my $vcol (@values) {
685 next unless (defined $vcol);
688 for my $row (@$data) {
689 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
690 push @{$pic_data[$set]}, $val;
691 $max_y = $val if ($val > $max_y);
696 my $set_count = scalar(@pic_data) - 1;
702 for my $dataset (@pic_data) {
704 if (grep { $_ } @$dataset) {
705 push @new_data, $dataset;
706 push @use_me, $set_index;
708 push @no_use, $set_index;
714 for my $col (@use_me) {
715 push @leg, $settings->{columns}->[$col + @groups - 1] if (map { 1 } grep { $col == $_ } @values);
718 my $w = 100 + 10 * scalar(@{$new_data[0]});
719 $w = 400 if ($w < 400);
721 my $h = 10 * (scalar(@new_data) / 2);
725 my $pic = new GD::Graph::lines3d ($w + 250, $h + 500);
728 title => $p->{reportname},
729 x_labels_vertical => 1,
732 y_max_value => $max_y,
733 legend_placement => 'TR',
736 logo_position => 'R',
741 $pic->set_legend(@leg);
743 my $format = $pic->export_format;
745 open(IMG, ">$file.line.$format");
749 $pic->plot(\@new_data) or die $pic->error;
750 print IMG $pic->gd->$format;
753 warn "Couldn't draw $file.line.$format : $e";
758 return [{ file => "line.$format",
759 name => $p->{reportname}.' (Bar)',
766 my ($node) = $doc->findnodes("//*[\@id='$id']");
767 if ($node && $node->findvalue('@table')) {
768 ($node) = $doc->findnodes("//*[\@id='".$node->getAttribute('table')."']");
776 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
780 my $core = $r->{stage3}->{stage2}->{stage1};
783 for my $t (keys %{$$p{filter}}) {
789 for my $t (keys %{$$p{output}}) {
790 if ($t ne $core && !(grep { $t eq $_ } @dims) ) {
798 my $t = table_by_id($d);
799 my $t_name = $t->findvalue('tablename');
800 push @dim_from, "$t_name AS \"$d\""
801 unless ( grep {$_ eq "$t_name AS \"$d\""} @dim_from );
803 my $k = $doc->findvalue("//*[\@id='$d']/\@key");
804 push @dim_select, "\"$d\".\"$k\" AS \"${d}_${k}\""
805 unless ( grep {$_ eq "\"$d\".\"$k\" AS \"${d}_${k}\""} @dim_select );
807 for my $c ( keys %{$$p{output}{$d}} ) {
808 push @dim_select, "\"$d\".\"$c\" AS \"${d}_${c}\""
809 unless ( grep {$_ eq "\"$d\".\"$c\" AS \"${d}_${c}\""} @dim_select );
812 for my $c ( keys %{$$p{filter}{$d}} ) {
813 next if (exists $$p{output}{$d}{$c});
814 push @dim_select, "\"$d\".\"$c\" AS \"${d}_${c}\""
815 unless ( grep {$_ eq "\"$d\".\"$c\" AS \"${d}_${c}\""} @dim_select );
820 '(SELECT ' . join(',', @dim_select) .
821 ' FROM ' . join(',', @dim_from) . ') AS dims';
824 if (ref $$p{output_order}) {
825 @opord = @{ $$p{output_order} };
827 @opord = ( $$p{output_order} );
829 my @output_order = map { { (split ':')[1] => (split ':')[2] } } @opord;
830 my @p_col = split(':',$p->{pivot_col}) if $p->{pivot_col};
836 my @dim_col_names = ();
840 for my $pair (@output_order) {
841 my ($t_name) = keys %$pair;
844 $t_name = "dims" if ($t ne $core);
846 my $t_node = table_by_id($t);
848 for my $c ( values %$pair ) {
849 my $label = $t_node->findvalue("fields/field[\@name='$c']/label");
852 $full_col = "${t}_${c}" if ($t ne $t_name);
853 $full_col = "\"$t_name\".\"$full_col\"";
855 if (my $xform_type = $$p{xform}{type}{$t}{$c}) {
856 my $xform = $$OpenILS::WWW::Reporter::dtype_xforms{$xform_type};
857 if ($xform->{group}) {
860 $label = "$$xform{label} -- $label";
862 my $tmp = $xform->{'select'};
863 $tmp =~ s/\?COLNAME\?/$full_col/gs;
864 $tmp =~ s/\?PARAM\?/$$p{xform}{param}{$t}{$c}/gs;
870 push @output, "$full_col AS \"$label\"";
871 push @columns, $label;
872 $pivot = scalar(@columns) - 1 if (@p_col && $t eq $p_col[1] && $c eq $p_col[2]);
876 if ($t ne $t_name && (!@join_base || !grep{$t eq $_}@join_base)) {
877 my $k = $doc->findvalue("//*[\@id='$t']/\@key");
878 my $f = $doc->findvalue("//*[\@id='$t']/\@field");
879 push @join, "dims.\"${t}_${k}\" = \"$core\".\"$f\"";
886 for my $t ( keys %{$$p{filter}} ) {
888 $t_name = "dims" if ($t ne $core);
890 my $t_node = table_by_id($t);
892 for my $c ( keys %{$$p{filter}{$t}} ) {
893 my $label = $t_node->findvalue("fields/field[\@name='$c']/label");
896 $full_col = "${t}_${c}" if ($t ne $t_name);
897 $full_col = "\"$t_name\".\"$full_col\"";
899 my ($fam) = keys %{ $$p{filter}{$t}{$c} };
900 my ($w) = keys %{ $$p{filter}{$t}{$c}{$fam} };
901 my $val = $$p{filter}{$t}{$c}{$fam}{$w};
903 my $filter_code_xpath = "/reporter/widgets/widget-family[\@name='$fam']/widget[\@name='$w']/filter-code[\@type='perl']";
904 if (my $widget_code = $doc->findvalue($filter_code_xpath)) { # widget supplys it's own filter code
905 my ($where_clause, $bind_list) = ('',[]);
909 die "$@\n\n$widget_code" if ($@);
911 push @where, $where_clause;
912 push @bind, @$bind_list;
915 push @where, "$full_col IN (".join(",",map {'?'}@$val).")";
918 push @where, "$full_col = ?";
923 if ($t ne $t_name && (!@join_base || !grep{$t eq $_}@join_base)) {
924 my $k = $doc->findvalue("//*[\@id='$t']/\@key");
925 my $f = $doc->findvalue("//*[\@id='$t']/\@field");
926 push @join, "dims.\"${t}_${k}\" = \"$core\".\"$f\"";
931 my $t = table_by_id($core)->findvalue('tablename');
933 my $from = " FROM $t AS \"$core\" ";
934 $from .= "RIGHT JOIN $d_select ON (". join(' AND ', @join).")" if ( @join );
937 "SELECT ".join(',', @output). $from;
939 $select .= ' WHERE '.join(' AND ', @where) if (@where);
940 $select .= ' GROUP BY '.join(',',@groupby) if (@groupby);
942 $r->{sql}->{'pivot'} = $pivot;
943 $r->{sql}->{'select'} = $select;
944 $r->{sql}->{'bind'} = \@bind;
945 $r->{sql}->{columns} = \@columns;
946 $r->{sql}->{groupby} = \@groupby;