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;
25 my $current_time = DateTime->from_epoch( epoch => time() )->strftime('%FT%T%z');
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;
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 # 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
63 AND id NOT IN ( SELECT stage3 FROM reporter.output ) )
64 OR ( recurrence > '0 seconds'::INTERVAL
68 WHERE state <> 'complete')
74 # make sure we're not already running $count reports
75 my ($running) = $dbh->selectrow_array(<<SQL);
78 WHERE state = 'running';
81 if ($count <= $running) {
85 POSIX::waitpid( -1, POSIX::WNOHANG );
89 print "Already running maximum ($running) concurrent reports\n";
93 # if we have some open slots then generate the sql
94 my $run = $count - $running;
96 my $sth = $dbh->prepare(<<SQL);
107 while (my $r = $sth->fetchrow_hashref) {
108 my $s3 = $dbh->selectrow_hashref(<<" SQL", {}, $r->{stage3});
109 SELECT * FROM reporter.stage3 WHERE id = ?;
112 my $s2 = $dbh->selectrow_hashref(<<" SQL", {}, $s3->{stage2});
113 SELECT * FROM reporter.stage2 WHERE id = ?;
119 generate_query( $r );
127 # Now we spaun the report runners
129 for my $r ( @reports ) {
130 next if (safe_fork());
132 # This is the child (runner) process;
133 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
134 daemonize("Clark Kent reporting: $p->{reportname}");
136 $dbh = DBI->connect($dsn,$db_user,$db_pw, {pg_enable_utf8 => 1, RaiseError => 1});
139 $dbh->do(<<' SQL',{}, $r->{sql}->{'select'}, $$, $r->{id});
140 UPDATE reporter.output
141 SET state = 'running',
148 $sth = $dbh->prepare($r->{sql}->{'select'});
150 $sth->execute(@{ $r->{sql}->{'bind'} });
151 $r->{data} = $sth->fetchall_arrayref;
155 my $base = $doc->findvalue('/reporter/setup/files/output_base');
156 my $s1 = $r->{stage3}->{stage2}->{stage1};
157 my $s2 = $r->{stage3}->{stage2}->{id};
158 my $s3 = $r->{stage3}->{id};
159 my $output = $r->{id};
163 mkdir("$base/$s1/$s2");
164 mkdir("$base/$s1/$s2/$s3");
165 mkdir("$base/$s1/$s2/$s3/$output");
168 if (ref $p->{output_format}) {
169 @formats = @{ $p->{output_format} };
171 @formats = ( $p->{output_format} );
174 if ( grep { $_ eq 'csv' } @formats ) {
175 build_csv("$base/$s1/$s2/$s3/$output/report-data.csv", $r);
178 if ( grep { $_ eq 'excel' } @formats ) {
179 build_excel("$base/$s1/$s2/$s3/$output/report-data.xls", $r);
182 if ( grep { $_ eq 'html' } @formats ) {
183 mkdir("$base/$s1/$s2/$s3/$output/html");
184 build_html("$base/$s1/$s2/$s3/$output/report-data.html", $r);
189 $dbh->do(<<' SQL',{}, $r->{stage3}->{id});
190 UPDATE reporter.stage3
191 SET runtime = runtime + recurrence
192 WHERE id = ? AND recurrence > '0 seconds'::INTERVAL;
194 $dbh->do(<<' SQL',{}, $r->{id});
195 UPDATE reporter.output
196 SET state = 'complete',
197 complete_time = 'now'
206 $dbh->do(<<' SQL',{}, $e, $r->{id});
207 UPDATE reporter.output
218 exit; # leave the child
223 POSIX::waitpid( -1, POSIX::WNOHANG );
228 #-------------------------------------------------------------------
233 my $settings = $r->{sql};
234 my $data = $r->{data};
236 return unless (defined($settings->{pivot}));
238 my @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
240 # remove pivot from group-by
243 while ($count < scalar(@{$settings->{groupby}})) {
244 if (defined $pivot_groupby) {
245 $settings->{groupby}->[$count] -= 1;
246 } elsif ($settings->{groupby}->[$count] == $settings->{pivot} + 1) {
247 $pivot_groupby = $count;
253 # grab positions of non-group-bys
254 my @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
255 splice(@values,$_,1) for (reverse @groups);
257 # we're only doing one "value" for now, so grab that and remove from headings
258 my ($val_col) = @values;
262 ($val_col, $settings->{groupby}->[$pivot_groupby] - 1);
265 for my $row (@$data) {
266 $p_header{ $$row[$settings->{pivot}] }++;
267 push @values, $$row[$val_col];
268 splice(@$row,$_,1) for (@remove_me);
270 push @{ $settings->{columns} }, sort keys %p_header;
272 # remove from headings;
273 splice(@{$settings->{columns}},$_,1) for (@remove_me);
275 # remove pivot from groupby
276 splice(@{$settings->{groupby}}, $pivot_groupby, 1);
277 @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
279 $count = scalar(keys %p_header);
282 for my $row (@$data) {
283 my $fingerprint = join('',@$row[@groups]);
284 next if $seenit{$fingerprint};
285 $seenit{$fingerprint}++;
286 push @$row, splice(@values,0,$count);
287 push @new_data, [@$row];
290 #replace old data with new
291 $r->{data} = \@new_data;
299 my $csv = Text::CSV_XS->new({ always_quote => 1, eol => "\015\012" });
300 my $f = new FileHandle (">$file");
302 $csv->print($f, $r->{sql}->{columns});
303 $csv->print($f, $_) for (@{$r->{data}});
310 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
312 my $xls = Spreadsheet::WriteExcel->new($file);
314 my $sheetname = substr($p->{reportname},1,31);
315 $sheetname =~ s/\W/_/gos;
317 my $sheet = $xls->add_worksheet($sheetname);
319 $sheet->write_row('A1', $r->{sql}->{columns});
321 $sheet->write_col('A2', $r->{data});
329 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
331 my $index = new FileHandle (">$file");
332 my $raw = new FileHandle (">$file.raw.html");
335 print $index <<" HEADER";
338 <title>$$p{reportname}</title>
340 table { border-collapse: collapse; }
341 th { background-color: lightgray; }
342 td,th { border: solid black 1px; }
343 * { font-family: sans-serif; font-size: 10px; }
347 <h2><u>$$p{reportname}</u></h2>
351 # add a link to the raw output html
352 print $index "<a href='report-data.html.raw.html'>Raw output data</a><br/><br/><br/><br/>";
354 # create the raw output html file
355 print $raw "<html><head><title>$$p{reportname}</title>";
359 table { border-collapse: collapse; }
360 th { background-color: lightgray; }
361 td,th { border: solid black 1px; }
362 * { font-family: sans-serif; font-size: 10px; }
366 print $raw "</head><body><table>";
367 print $raw "<tr><th>".join('</th><th>',@{$r->{sql}->{columns}}).'</th></tr>';
369 print $raw "<tr><td>".join('</td><td>',@$_).'</td></tr>' for (@{$r->{data}});
371 print $raw '</table></body></html>';
375 # get the graph types
377 if (ref $$p{html_graph_type}) {
378 @graphs = @{ $$p{html_graph_type} };
380 @graphs = ( $$p{html_graph_type} );
383 # Time for a pie chart
384 if (grep {$_ eq 'pie'} @graphs) {
385 my $pics = draw_pie($r, $p, $file);
386 for my $pic (@$pics) {
387 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
391 # Time for a bar chart
392 if (grep {$_ eq 'bar'} @graphs) {
393 my $pics = draw_bars($r, $p, $file);
394 for my $pic (@$pics) {
395 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
401 print $index '</body></html>';
410 my $data = $r->{data};
411 my $settings = $r->{sql};
413 my @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
415 my @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
416 delete @values[@groups];
418 my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
421 for my $vcol (@values) {
422 next unless (defined $vcol);
425 for my $row (@$data) {
426 next if (!defined($$row[$vcol]) || $$row[$vcol] == 0);
427 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
428 push @{$pic_data[1]}, $$row[$vcol];
431 my $pic = new GD::Graph::pie;
434 label => $p->{reportname}." -- ".$settings->{columns}->[$vcol],
436 legend_placement => 'R',
438 logo_position => 'TL',
443 my $format = $pic->export_format;
445 open(IMG, ">$file.pie.$vcol.$format");
450 $pic->plot(\@pic_data) or die $pic->error;
451 print IMG $pic->gd->$format;
454 warn "Couldn't draw $file.pie.$vcol.$format : $e";
463 { file => "pie.$vcol.$format",
464 name => $p->{reportname}." -- ".$settings->{columns}->[$vcol].' (Pie)',
476 my $data = $r->{data};
477 my $settings = $r->{sql};
479 my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
481 my @groups = (map { ($_ - 1) } @{ $settings->{groupby} });
483 my @values = (0 .. (scalar(@{$settings->{columns}}) - 1));
484 delete @values[@groups];
485 @values = grep {defined $_} @values;
489 for my $row (@$data) {
490 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
500 for my $vcol (@values) {
501 next unless (defined $vcol);
503 push @leg, $settings->{columns}->[$vcol];
506 for my $row (@$data) {
507 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
508 push @{$pic_data[$set]}, $val;
509 $max_y = $val if ($val > $max_y);
510 $trim_candidates{$pos}++ if ($val == 0);
516 my $set_count = scalar(@pic_data) - 1;
517 my @trim_cols = grep { $trim_candidates{$_} == $set_count } keys %trim_candidates;
519 for my $dataset (@pic_data) {
520 for my $col (reverse sort { $a <=> $b } @trim_cols) {
521 splice(@$dataset,$col,1);
525 my $w = 100 + 10 * scalar(@{$pic_data[0]});
526 $w = 400 if ($w < 400);
528 my $h = 10 * (scalar(@pic_data) / 2);
532 my $pic = new GD::Graph::bars3d ($w + 250, $h + 500);
535 title => $p->{reportname},
536 x_labels_vertical => 1,
540 y_max_value => $max_y,
541 legend_placement => 'TR',
544 logo_position => 'R',
549 $pic->set_legend(@leg);
551 my $format = $pic->export_format;
553 open(IMG, ">$file.bar.$format");
557 $pic->plot(\@pic_data) or die $pic->error;
558 print IMG $pic->gd->$format;
561 warn "Couldn't draw $file.bar.$format : $e";
566 return [{ file => "bar.$format",
567 name => $p->{reportname}.' (Bar)',
574 my ($node) = $doc->findnodes("//*[\@id='$id']");
575 if ($node && $node->findvalue('@table')) {
576 ($node) = $doc->findnodes("//*[\@id='".$node->getAttribute('table')."']");
584 my $p = JSON->JSON2perl( $r->{stage3}->{params} );
588 my $core = $r->{stage3}->{stage2}->{stage1};
591 for my $t (keys %{$$p{filter}}) {
597 for my $t (keys %{$$p{output}}) {
598 if ($t ne $core && !grep { $t } @dims ) {
606 my $t = table_by_id($d);
607 my $t_name = $t->findvalue('tablename');
608 push @dim_from, "$t_name AS \"$d\"";
610 my $k = $doc->findvalue("//*[\@id='$d']/\@key");
611 push @dim_select, "\"$d\".\"$k\" AS \"${d}_${k}\"";
613 for my $c ( keys %{$$p{output}{$d}} ) {
614 push @dim_select, "\"$d\".\"$c\" AS \"${d}_${c}\"";
617 for my $c ( keys %{$$p{filter}{$d}} ) {
618 next if (exists $$p{output}{$d}{$c});
619 push @dim_select, "\"$d\".\"$c\" AS \"${d}_${c}\"";
624 '(SELECT ' . join(',', @dim_select) .
625 ' FROM ' . join(',', @dim_from) . ') AS dims';
628 if (ref $$p{output_order}) {
629 @opord = @{ $$p{output_order} };
631 @opord = ( $$p{output_order} );
633 my @output_order = map { { (split ':')[1] => (split ':')[2] } } @opord;
634 my @p_col = split(':',$p->{pivot_col}) if $p->{pivot_col};
643 for my $pair (@output_order) {
644 my ($t_name) = keys %$pair;
647 $t_name = "dims" if ($t ne $core);
649 my $t_node = table_by_id($t);
651 for my $c ( values %$pair ) {
652 my $label = $t_node->findvalue("fields/field[\@name='$c']/label");
655 $full_col = "${t}_${c}" if ($t ne $t_name);
656 $full_col = "\"$t_name\".\"$full_col\"";
659 if (my $xform_type = $$p{xform}{type}{$t}{$c}) {
660 my $xform = $$OpenILS::WWW::Reporter::dtype_xforms{$xform_type};
661 if ($xform->{group}) {
664 $label = "$$xform{label} -- $label";
666 my $tmp = $xform->{'select'};
667 $tmp =~ s/\?COLNAME\?/$full_col/gs;
668 $tmp =~ s/\?PARAM\?/$$p{xform}{param}{$t}{$c}/gs;
674 push @output, "$full_col AS \"$label\"";
675 push @columns, $label;
676 $pivot = scalar(@columns) - 1 if (@p_col && $t eq $p_col[1] && $c eq $p_col[2]);
680 if ($t ne $t_name && (!@join_base || !grep{$t eq $_}@join_base)) {
681 my $k = $doc->findvalue("//*[\@id='$t']/\@key");
682 my $f = $doc->findvalue("//*[\@id='$t']/\@field");
683 push @join, "dims.\"${t}_${k}\" = \"$core\".\"$f\"";
690 for my $t ( keys %{$$p{filter}} ) {
692 $t_name = "dims" if ($t ne $core);
694 my $t_node = table_by_id($t);
696 for my $c ( keys %{$$p{filter}{$t}} ) {
697 my $label = $t_node->findvalue("fields/field[\@name='$c']/label");
700 $full_col = "${t}_${c}" if ($t ne $t_name);
701 $full_col = "\"$t_name\".\"$full_col\"";
703 # XXX make this use widget specific code
705 my ($fam) = keys %{ $$p{filter}{$t}{$c} };
706 my ($w) = keys %{ $$p{filter}{$t}{$c}{$fam} };
707 my $val = $$p{filter}{$t}{$c}{$fam}{$w};
710 push @where, "$full_col IN (".join(",",map {'?'}@$val).")";
713 push @where, "$full_col = ?";
718 if ($t ne $t_name && (!@join_base || !grep{$t eq $_}@join_base)) {
719 my $k = $doc->findvalue("//*[\@id='$t']/\@key");
720 my $f = $doc->findvalue("//*[\@id='$t']/\@field");
721 push @join, "dims.\"${t}_${k}\" = \"$core\".\"$f\"";
726 my $t = table_by_id($core)->findvalue('tablename');
727 my $from = " FROM $t AS \"$core\" RIGHT JOIN $d_select ON (". join(' AND ', @join).")";
729 "SELECT ".join(',', @output). $from;
731 $select .= ' WHERE '.join(' AND ', @where) if (@where);
732 $select .= ' GROUP BY '.join(',',@groupby) if (@groupby);
734 $r->{sql}->{'pivot'} = $pivot;
735 $r->{sql}->{'select'} = $select;
736 $r->{sql}->{'bind'} = \@bind;
737 $r->{sql}->{columns} = \@columns;
738 $r->{sql}->{groupby} = \@groupby;