9 use DateTime::Format::ISO8601;
12 use OpenILS::WWW::Reporter::transforms;
14 use Spreadsheet::WriteExcel;
15 use OpenSRF::EX qw/:try/;
16 use OpenSRF::Utils qw/:daemon/;
17 use OpenSRF::Utils::Logger qw/:level/;
20 use GD::Graph::bars3d;
26 my ($base_xml, $count, $daemon) = ('/openils/conf/reporter.xml', 1);
29 "file=s" => \$base_xml,
31 "concurrency=i" => \$count,
34 my $parser = XML::LibXML->new;
35 $parser->expand_xinclude(1);
37 my $doc = $parser->parse_file($base_xml);
39 my $db_driver = $doc->findvalue('/reporter/setup/database/driver');
40 my $db_host = $doc->findvalue('/reporter/setup/database/host');
41 my $db_name = $doc->findvalue('/reporter/setup/database/name');
42 my $db_user = $doc->findvalue('/reporter/setup/database/user');
43 my $db_pw = $doc->findvalue('/reporter/setup/database/password');
45 my $dsn = "dbi:" . $db_driver . ":dbname=" . $db_name .';host=' . $db_host;
47 my ($dbh,$running,$sth,@reports,$run, $current_time);
49 daemonize("Clark Kent, waiting for trouble") if ($daemon);
53 $dbh = DBI->connect($dsn,$db_user,$db_pw, {pg_enable_utf8 => 1, RaiseError => 1});
55 $current_time = DateTime->from_epoch( epoch => time() )->strftime('%FT%T%z');
56 # Move new reports into the run queue
57 $dbh->do(<<'SQL', {}, $current_time);
58 INSERT INTO reporter.output ( stage3, state )
62 AND ( ( recurrence = '0 seconds'::INTERVAL
64 id NOT IN ( SELECT stage3 FROM reporter.output )
68 OR ( recurrence > '0 seconds'::INTERVAL
72 WHERE state <> 'complete')
78 # make sure we're not already running $count reports
79 ($running) = $dbh->selectrow_array(<<SQL);
82 WHERE state = 'running';
85 if ($count <= $running) {
89 POSIX::waitpid( -1, POSIX::WNOHANG );
93 print "Already running maximum ($running) concurrent reports\n";
97 # if we have some open slots then generate the sql
98 $run = $count - $running;
100 $sth = $dbh->prepare(<<SQL);
111 while (my $r = $sth->fetchrow_hashref) {
112 my $s3 = $dbh->selectrow_hashref(<<" SQL", {}, $r->{stage3});
113 SELECT * FROM reporter.stage3 WHERE id = ?;
116 my $s2 = $dbh->selectrow_hashref(<<" SQL", {}, $s3->{stage2});
117 SELECT * FROM reporter.stage2 WHERE id = ?;
123 generate_query( $r );
131 # Now we spaun the report runners
133 for my $r ( @reports ) {
134 next if (safe_fork());
136 # This is the child (runner) process;
137 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
138 daemonize("Clark Kent reporting: $p->{reportname}");
140 $dbh = DBI->connect($dsn,$db_user,$db_pw, {pg_enable_utf8 => 1, RaiseError => 1});
143 $dbh->do(<<' SQL',{}, $r->{sql}->{'select'}, $$, $r->{id});
144 UPDATE reporter.output
145 SET state = 'running',
152 my ($runtime) = $dbh->selectrow_array("SELECT run_time FROM reporter.output WHERE id = ?",{},$r->{id});
153 $r->{run_time} = $runtime;
155 $sth = $dbh->prepare($r->{sql}->{'select'});
157 $sth->execute(@{ $r->{sql}->{'bind'} });
158 $r->{data} = $sth->fetchall_arrayref;
162 my $base = $doc->findvalue('/reporter/setup/files/output_base');
163 my $s1 = $r->{stage3}->{stage2}->{stage1};
164 my $s2 = $r->{stage3}->{stage2}->{id};
165 my $s3 = $r->{stage3}->{id};
166 my $output = $r->{id};
170 mkdir("$base/$s1/$s2");
171 mkdir("$base/$s1/$s2/$s3");
172 mkdir("$base/$s1/$s2/$s3/$output");
175 if (ref $p->{output_format}) {
176 @formats = @{ $p->{output_format} };
178 @formats = ( $p->{output_format} );
181 if ( grep { $_ eq 'csv' } @formats ) {
182 build_csv("$base/$s1/$s2/$s3/$output/report-data.csv", $r);
185 if ( grep { $_ eq 'excel' } @formats ) {
186 build_excel("$base/$s1/$s2/$s3/$output/report-data.xls", $r);
189 if ( grep { $_ eq 'html' } @formats ) {
190 mkdir("$base/$s1/$s2/$s3/$output/html");
191 build_html("$base/$s1/$s2/$s3/$output/report-data.html", $r);
196 $dbh->do(<<' SQL',{}, $r->{run_time}, $r->{stage3}->{id});
197 UPDATE reporter.stage3
198 SET runtime = CAST(? AS TIMESTAMP WITH TIME ZONE) + recurrence
199 WHERE id = ? AND recurrence > '0 seconds'::INTERVAL;
201 $dbh->do(<<' SQL',{}, $r->{stage3}->{id});
202 UPDATE reporter.stage3
204 WHERE id = ? AND rerun = TRUE;
206 $dbh->do(<<' SQL',{}, $r->{id});
207 UPDATE reporter.output
208 SET state = 'complete',
209 complete_time = 'now'
218 $dbh->do(<<' SQL',{}, $e, $r->{id});
219 UPDATE reporter.output
230 exit; # leave the child
235 POSIX::waitpid( -1, POSIX::WNOHANG );
240 #-------------------------------------------------------------------
244 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
245 my $settings = $r->{sql};
246 my $data = $r->{data};
248 return unless (defined($settings->{pivot}));
250 my @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
251 my @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
252 splice(@values,$_,1) for (reverse @groups);
254 # remove pivot from group-by
257 while ($count < scalar(@{$settings->{groupby}})) {
258 if (defined $pivot_groupby) {
259 $settings->{groupby}->[$count] -= 1;
260 if ($settings->{groupby}->[$count] >= $values[0] + 1) {
261 $settings->{groupby}->[$count] -= 1;
263 } elsif ($settings->{groupby}->[$count] == $settings->{pivot} + 1) {
264 $pivot_groupby = $count;
270 # grab positions of non-group-bys
271 @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
272 splice(@values,$_,1) for (reverse @groups);
274 # we're only doing one "value" for now, so grab that and remove from headings
275 my ($val_col) = @values;
279 ($val_col, $settings->{groupby}->[$pivot_groupby] - 1);
282 for my $row (@$data) {
283 $p_header{ $$row[$settings->{pivot}] } = [] unless exists($p_header{ $$row[$settings->{pivot}] });
285 push @{ $p_header{ $$row[$settings->{pivot}] } }, $$row[$val_col];
287 splice(@$row,$_,1) for (@remove_me);
290 push @{ $settings->{columns} }, sort keys %p_header;
292 # remove from headings;
293 splice(@{$settings->{columns}},$_,1) for (@remove_me);
295 # remove pivot from groupby
296 splice(@{$settings->{groupby}}, $pivot_groupby, 1);
297 @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
299 $count = scalar(keys %p_header);
303 for my $row (@$data) {
305 my $fingerprint = join('',@$row[@groups]);
306 next if $seenit{$fingerprint};
308 $seenit{$fingerprint}++;
310 for my $h ( sort keys %p_header ) {
311 push @$row, shift(@{ $p_header{$h} });
314 push @new_data, [@$row];
318 #replace old data with new
319 $r->{data} = \@new_data;
327 my $csv = Text::CSV_XS->new({ always_quote => 1, eol => "\015\012" });
328 my $f = new FileHandle (">$file");
330 $csv->print($f, $r->{sql}->{columns});
331 $csv->print($f, $_) for (@{$r->{data}});
338 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
340 my $xls = Spreadsheet::WriteExcel->new($file);
342 my $sheetname = substr($p->{reportname},1,31);
343 $sheetname =~ s/\W/_/gos;
345 my $sheet = $xls->add_worksheet($sheetname);
347 $sheet->write_row('A1', $r->{sql}->{columns});
349 $sheet->write_col('A2', $r->{data});
357 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
359 my $index = new FileHandle (">$file");
360 my $raw = new FileHandle (">$file.raw.html");
363 print $index <<" HEADER";
366 <title>$$p{reportname}</title>
368 table { border-collapse: collapse; }
369 th { background-color: lightgray; }
370 td,th { border: solid black 1px; }
371 * { font-family: sans-serif; font-size: 10px; }
375 <h2><u>$$p{reportname}</u></h2>
379 # add a link to the raw output html
380 print $index "<a href='report-data.html.raw.html'>Raw output data</a><br/><br/><br/><br/>";
382 # create the raw output html file
383 print $raw "<html><head><title>$$p{reportname}</title>";
387 table { border-collapse: collapse; }
388 th { background-color: lightgray; }
389 td,th { border: solid black 1px; }
390 * { font-family: sans-serif; font-size: 10px; }
394 print $raw "</head><body><table>";
397 print $raw "<tr><th>".join('</th><th>',@{$r->{sql}->{columns}}).'</th></tr>';
398 print $raw "<tr><td>".join('</td><td>',@$_ ).'</td></tr>' for (@{$r->{data}});
401 print $raw '</table></body></html>';
405 # get the graph types
407 if (ref $$p{html_graph_type}) {
408 @graphs = @{ $$p{html_graph_type} };
410 @graphs = ( $$p{html_graph_type} );
413 # Time for a pie chart
414 if (grep {$_ eq 'pie'} @graphs) {
415 my $pics = draw_pie($r, $p, $file);
416 for my $pic (@$pics) {
417 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
421 print $index '<br/><br/><br/><br/>';
422 # Time for a bar chart
423 if (grep {$_ eq 'bar'} @graphs) {
424 my $pics = draw_bars($r, $p, $file);
425 for my $pic (@$pics) {
426 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
432 print $index '</body></html>';
441 my $data = $r->{data};
442 my $settings = $r->{sql};
444 my @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
446 my @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
447 delete @values[@groups];
449 my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
452 for my $vcol (@values) {
453 next unless (defined $vcol);
455 my @pic_data = ([],[]);
456 for my $row (@$data) {
457 next if (!defined($$row[$vcol]) || $$row[$vcol] == 0);
458 my $val = $$row[$vcol];
459 push @{$pic_data[0]}, join(" -- ", @$row[@groups])." ($val)";
460 push @{$pic_data[1]}, $val;
463 next unless (@{$pic_data[0]});
466 my $split = int(scalar(@{$pic_data[0]}) / $size);
467 my $last = scalar(@{$pic_data[0]}) % $size;
469 for my $sub_graph (0 .. $split) {
471 if ($sub_graph == $split) {
476 for my $set (@pic_data) {
477 push @sub_data, [ splice(@$set,0,$size) ];
480 my $pic = new GD::Graph::pie;
483 label => $settings->{columns}->[$vcol],
485 legend_placement => 'R',
487 logo_position => 'TL',
492 my $format = $pic->export_format;
494 open(IMG, ">$file.pie.$vcol.$sub_graph.$format");
499 $pic->plot(\@sub_data) or die $pic->error;
500 print IMG $pic->gd->$format;
503 warn "Couldn't draw $file.pie.$vcol.$sub_graph.$format : $e";
511 { file => "pie.$vcol.$sub_graph.$format",
512 name => $settings->{columns}->[$vcol].' (Pie)',
513 } unless ($forgetit);
515 last if ($sub_graph == $split);
527 my $data = $r->{data};
528 my $settings = $r->{sql};
530 my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
532 my @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
535 my @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
536 splice(@values,$_,1) for (reverse @groups);
540 for my $row (@$data) {
541 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
551 for my $vcol (@values) {
552 next unless (defined $vcol);
556 for my $row (@$data) {
557 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
558 push @{$pic_data[$set]}, $val;
559 $max_y = $val if ($val > $max_y);
560 $trim_candidates{$pos}++ if ($val == 0);
566 my $set_count = scalar(@pic_data) - 1;
567 my @trim_cols = grep { $trim_candidates{$_} == $set_count } keys %trim_candidates;
573 for my $dataset (@pic_data) {
574 splice(@$dataset,$_,1) for (sort { $b <=> $a } @trim_cols);
576 if (grep { $_ } @$dataset) {
577 push @new_data, $dataset;
578 push @use_me, $set_index;
580 push @no_use, $set_index;
586 for my $col (@use_me) {
587 push @leg, $settings->{columns}->[$col + @groups - 1] if (map { 1 } grep { $col == $_ } @values);
590 my $w = 100 + 10 * scalar(@{$new_data[0]});
591 $w = 400 if ($w < 400);
593 my $h = 10 * (scalar(@new_data) / 2);
597 my $pic = new GD::Graph::bars3d ($w + 250, $h + 500);
600 title => $p->{reportname},
601 x_labels_vertical => 1,
605 y_max_value => $max_y,
606 legend_placement => 'TR',
609 logo_position => 'R',
614 $pic->set_legend(@leg);
616 my $format = $pic->export_format;
618 open(IMG, ">$file.bar.$format");
622 $pic->plot(\@new_data) or die $pic->error;
623 print IMG $pic->gd->$format;
626 warn "Couldn't draw $file.bar.$format : $e";
631 return [{ file => "bar.$format",
632 name => $p->{reportname}.' (Bar)',
639 my ($node) = $doc->findnodes("//*[\@id='$id']");
640 if ($node && $node->findvalue('@table')) {
641 ($node) = $doc->findnodes("//*[\@id='".$node->getAttribute('table')."']");
649 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
653 my $core = $r->{stage3}->{stage2}->{stage1};
656 for my $t (keys %{$$p{filter}}) {
662 for my $t (keys %{$$p{output}}) {
663 if ($t ne $core && !(grep { $t eq $_ } @dims) ) {
671 my $t = table_by_id($d);
672 my $t_name = $t->findvalue('tablename');
673 push @dim_from, "$t_name AS \"$d\"";
675 my $k = $doc->findvalue("//*[\@id='$d']/\@key");
676 push @dim_select, "\"$d\".\"$k\" AS \"${d}_${k}\"";
678 for my $c ( keys %{$$p{output}{$d}} ) {
679 push @dim_select, "\"$d\".\"$c\" AS \"${d}_${c}\"";
682 for my $c ( keys %{$$p{filter}{$d}} ) {
683 next if (exists $$p{output}{$d}{$c});
684 push @dim_select, "\"$d\".\"$c\" AS \"${d}_${c}\"";
689 '(SELECT ' . join(',', @dim_select) .
690 ' FROM ' . join(',', @dim_from) . ') AS dims';
693 if (ref $$p{output_order}) {
694 @opord = @{ $$p{output_order} };
696 @opord = ( $$p{output_order} );
698 my @output_order = map { { (split ':')[1] => (split ':')[2] } } @opord;
699 my @p_col = split(':',$p->{pivot_col}) if $p->{pivot_col};
708 for my $pair (@output_order) {
709 my ($t_name) = keys %$pair;
712 $t_name = "dims" if ($t ne $core);
714 my $t_node = table_by_id($t);
716 for my $c ( values %$pair ) {
717 my $label = $t_node->findvalue("fields/field[\@name='$c']/label");
720 $full_col = "${t}_${c}" if ($t ne $t_name);
721 $full_col = "\"$t_name\".\"$full_col\"";
724 if (my $xform_type = $$p{xform}{type}{$t}{$c}) {
725 my $xform = $$OpenILS::WWW::Reporter::dtype_xforms{$xform_type};
726 if ($xform->{group}) {
729 $label = "$$xform{label} -- $label";
731 my $tmp = $xform->{'select'};
732 $tmp =~ s/\?COLNAME\?/$full_col/gs;
733 $tmp =~ s/\?PARAM\?/$$p{xform}{param}{$t}{$c}/gs;
739 push @output, "$full_col AS \"$label\"";
740 push @columns, $label;
741 $pivot = scalar(@columns) - 1 if (@p_col && $t eq $p_col[1] && $c eq $p_col[2]);
745 if ($t ne $t_name && (!@join_base || !grep{$t eq $_}@join_base)) {
746 my $k = $doc->findvalue("//*[\@id='$t']/\@key");
747 my $f = $doc->findvalue("//*[\@id='$t']/\@field");
748 push @join, "dims.\"${t}_${k}\" = \"$core\".\"$f\"";
755 for my $t ( keys %{$$p{filter}} ) {
757 $t_name = "dims" if ($t ne $core);
759 my $t_node = table_by_id($t);
761 for my $c ( keys %{$$p{filter}{$t}} ) {
762 my $label = $t_node->findvalue("fields/field[\@name='$c']/label");
765 $full_col = "${t}_${c}" if ($t ne $t_name);
766 $full_col = "\"$t_name\".\"$full_col\"";
768 # XXX make this use widget specific code
770 my ($fam) = keys %{ $$p{filter}{$t}{$c} };
771 my ($w) = keys %{ $$p{filter}{$t}{$c}{$fam} };
772 my $val = $$p{filter}{$t}{$c}{$fam}{$w};
774 my $filter_code_xpath = "/reporter/widgets/widget-family[\@name='$fam']/widget[\@name='$w']/filter-code[\@type='perl']";
775 if (my $widget_code = $doc->findvalue($filter_code_xpath)) # widget supplys it's own filter code
776 my ($where_clause, $bind_list) = ('',[]);
780 push @where, $where_clause;
781 push @bind, @$bind_list;
784 push @where, "$full_col IN (".join(",",map {'?'}@$val).")";
787 push @where, "$full_col = ?";
792 if ($t ne $t_name && (!@join_base || !grep{$t eq $_}@join_base)) {
793 my $k = $doc->findvalue("//*[\@id='$t']/\@key");
794 my $f = $doc->findvalue("//*[\@id='$t']/\@field");
795 push @join, "dims.\"${t}_${k}\" = \"$core\".\"$f\"";
800 my $t = table_by_id($core)->findvalue('tablename');
802 my $from = " FROM $t AS \"$core\" ";
803 $from .= "RIGHT JOIN $d_select ON (". join(' AND ', @join).")" if ( @join );
806 "SELECT ".join(',', @output). $from;
808 $select .= ' WHERE '.join(' AND ', @where) if (@where);
809 $select .= ' GROUP BY '.join(',',@groupby) if (@groupby);
811 $r->{sql}->{'pivot'} = $pivot;
812 $r->{sql}->{'select'} = $select;
813 $r->{sql}->{'bind'} = \@bind;
814 $r->{sql}->{columns} = \@columns;
815 $r->{sql}->{groupby} = \@groupby;