10 use DateTime::Format::ISO8601;
13 use Spreadsheet::WriteExcel::Big;
14 use OpenSRF::EX qw/:try/;
15 use OpenSRF::Utils qw/:daemon/;
16 use OpenSRF::Utils::JSON;
17 #use OpenSRF::Utils::Logger qw/:level/;
19 use OpenSRF::AppSession;
20 use OpenSRF::Utils::SettingsClient;
21 use OpenILS::Reporter::SQLBuilder;
24 use GD::Graph::bars3d;
25 use GD::Graph::lines3d;
32 my ($count, $config, $sleep_interval, $lockfile, $daemon) = (1, '/openils/conf/opensrf_core.xml', 10, '/tmp/reporter-LOCK');
36 "sleep=i" => \$sleep_interval,
37 "concurrency=i" => \$count,
38 "boostrap=s" => \$config,
39 "lockfile=s" => \$lockfile,
43 die "I seem to be running already. If not, remove $lockfile and try again\n";
46 OpenSRF::System->bootstrap_client( config_file => $config );
48 # XXX Get this stuff from the settings server
49 my $sc = OpenSRF::Utils::SettingsClient->new;
50 my $db_driver = $sc->config_value( reporter => setup => database => 'driver' );
51 my $db_host = $sc->config_value( reporter => setup => database => 'host' );
52 my $db_port = $sc->config_value( reporter => setup => database => 'port' );
53 my $db_name = $sc->config_value( reporter => setup => database => 'db' );
54 my $db_user = $sc->config_value( reporter => setup => database => 'user' );
55 my $db_pw = $sc->config_value( reporter => setup => database => 'password' );
57 die "Unable to retrieve database connection information from the settings server" unless ($db_driver && $db_host && $db_port && $db_name && $db_user);
59 my $email_server = $sc->config_value( email_notify => 'smtp_server' );
60 my $email_sender = $sc->config_value( email_notify => 'sender_address' );
61 my $success_template = $sc->config_value( reporter => setup => files => 'success_template' );
62 my $fail_template = $sc->config_value( reporter => setup => files => 'fail_template' );
64 my $output_base = $sc->config_value( reporter => setup => files => 'output_base' );
66 my $base_uri = $sc->config_value( reporter => setup => 'base_uri' );
68 my $dsn = "dbi:" . $db_driver . ":dbname=" . $db_name .';host=' . $db_host . ';port=' . $db_port;
70 my ($dbh,$running,$sth,@reports,$run, $current_time);
73 open(F, ">$lockfile");
76 daemonize("Clark Kent, waiting for trouble");
82 $dbh = DBI->connect($dsn,$db_user,$db_pw, {pg_enable_utf8 => 1, RaiseError => 1});
84 $current_time = DateTime->from_epoch( epoch => time() )->strftime('%FT%T%z');
86 # make sure we're not already running $count reports
87 ($running) = $dbh->selectrow_array(<<SQL);
89 FROM reporter.schedule
90 WHERE start_time IS NOT NULL AND complete_time IS NULL;
93 if ($count <= $running) {
97 POSIX::waitpid( -1, POSIX::WNOHANG );
98 sleep $sleep_interval;
101 print "Already running maximum ($running) concurrent reports\n";
105 # if we have some open slots then generate the sql
106 $run = $count - $running;
108 $sth = $dbh->prepare(<<SQL);
110 FROM reporter.schedule
111 WHERE start_time IS NULL AND run_time < NOW()
119 while (my $r = $sth->fetchrow_hashref) {
120 my $s3 = $dbh->selectrow_hashref(<<" SQL", {}, $r->{report});
121 SELECT * FROM reporter.report WHERE id = ?;
124 my $s2 = $dbh->selectrow_hashref(<<" SQL", {}, $s3->{template});
125 SELECT * FROM reporter.template WHERE id = ?;
128 $s3->{template} = $s2;
131 my $b = OpenILS::Reporter::SQLBuilder->new;
132 $b->register_params( OpenSRF::Utils::JSON->JSON2perl( $r->{report}->{data} ) );
134 $r->{resultset} = $b->parse_report( OpenSRF::Utils::JSON->JSON2perl( $r->{report}->{template}->{data} ) );
135 $r->{resultset}->relative_time($r->{run_time});
143 # Now we spawn the report runners
145 for my $r ( @reports ) {
146 next if (safe_fork());
148 # This is the child (runner) process;
149 daemonize("Clark Kent reporting: $r->{report}->{name}");
151 $dbh = DBI->connect($dsn,$db_user,$db_pw, {pg_enable_utf8 => 1, RaiseError => 1});
154 $dbh->do(<<' SQL',{}, $r->{id});
155 UPDATE reporter.schedule
156 SET start_time = now()
160 $sth = $dbh->prepare($r->{resultset}->toSQL);
163 $r->{data} = $sth->fetchall_arrayref;
165 $r->{column_labels} = [$r->{resultset}->column_label_list];
167 if ($r->{resultset}->pivot_data && $r->{resultset}->pivot_label) {
168 my @labels = $r->{resultset}->column_label_list;
169 my $newdata = pivot_data(
170 { columns => $r->{column_labels}, data => $r->{data}},
171 $r->{resultset}->pivot_label,
172 $r->{resultset}->pivot_data,
173 $r->{resultset}->pivot_default
176 $r->{column_labels} = $newdata->{columns};
177 $r->{data} = $newdata->{data};
178 $r->{group_by_list} = $newdata->{group_by_list};
180 $r->{group_by_list} = [$r->{resultset}->group_by_list(0)];
183 my $s2 = $r->{report}->{template}->{id};
184 my $s3 = $r->{report}->{id};
185 my $output = $r->{id};
188 mkdir("$output_base/$s2");
189 mkdir("$output_base/$s2/$s3");
190 mkdir("$output_base/$s2/$s3/$output");
192 my $output_dir = "$output_base/$s2/$s3/$output";
194 if ( $r->{csv_format} ) {
195 build_csv("$output_dir/report-data.csv", $r);
198 if ( $r->{excel_format} ) {
199 build_excel("$output_dir/report-data.xls", $r);
202 build_html("$output_dir/report-data.html", $r);
206 if ($r->{report}->{recur} ) {
208 INSERT INTO reporter.schedule (
220 VALUES ( ?, ?, ?, ?::TIMESTAMPTZ + ?, ?, ?, ?, ?, ?, ?, ? );
230 $r->{report}->{recurance},
241 $dbh->do(<<' SQL',{}, $r->{id});
242 UPDATE reporter.schedule
243 SET complete_time = now()
249 my $new_r = $dbh->selectrow_hashref(<<" SQL", {}, $r->{id});
250 SELECT * FROM reporter.schedule WHERE id = ?;
253 $r->{start_time} = $new_r->{start_time};
254 $r->{complete_time} = $new_r->{complete_time};
262 $r->{error_text} = ''.$e;
264 $dbh->do(<<' SQL',{}, $e, $r->{id});
265 UPDATE reporter.schedule
267 complete_time = now(),
272 my $new_r = $dbh->selectrow_hashref(<<" SQL", {}, $r->{id});
273 SELECT * FROM reporter.schedule WHERE id = ?;
276 $r->{error_text} = $new_r->{error_text};
277 $r->{complete_time} = $new_r->{complete_time};
287 exit; # leave the child
292 POSIX::waitpid( -1, POSIX::WNOHANG );
293 sleep $sleep_interval;
297 #-------------------------------------------------------------------
301 open F, $success_template;
302 my $tmpl = join('',<F>);
305 my $url = $base_uri . '/' .
306 $r->{report}->{template}->{id} . '/' .
307 $r->{report}->{id} . '/' .
308 $r->{id} . '/report-data.html';
310 $tmpl =~ s/{TO}/$r->{email}/smog;
311 $tmpl =~ s/{FROM}/$email_sender/smog;
312 $tmpl =~ s/{REPLY_TO}/$email_sender/smog;
313 $tmpl =~ s/{REPORT_NAME}/$r->{report}->{template}->{name} -- $r->{report}->{name}/smog;
314 $tmpl =~ s/{RUN_TIME}/$r->{run_time}/smog;
315 $tmpl =~ s/{COMPLETE_TIME}/$r->{complete_time}/smog;
316 $tmpl =~ s/{OUTPUT_URL}/$url/smog;
318 my $sender = Email::Send->new({mailer => 'SMTP'});
319 $sender->mailer_args([Host => $email_server]);
320 $sender->send($tmpl);
325 open F, $fail_template;
326 my $tmpl = join('',<F>);
329 my $sql = $r->{resultset}->toSQL;
331 $tmpl =~ s/{TO}/$r->{email}/smog;
332 $tmpl =~ s/{FROM}/$email_sender/smog;
333 $tmpl =~ s/{REPLY_TO}/$email_sender/smog;
334 $tmpl =~ s/{REPORT_NAME}/$r->{report}->{template}->{name} -- $r->{report}->{name}/smog;
335 $tmpl =~ s/{RUN_TIME}/$r->{run_time}/smog;
336 $tmpl =~ s/{ERROR_TEXT}/$r->{error_text}/smog;
337 $tmpl =~ s/{SQL}/$sql/smog;
339 my $sender = Email::Send->new({mailer => 'SMTP'});
340 $sender->mailer_args([Host => $email_server]);
341 $sender->send($tmpl);
348 my $csv = Text::CSV_XS->new({ always_quote => 1, eol => "\015\012" });
350 return unless ($csv);
352 my $f = new FileHandle (">$file");
354 $csv->print($f, $r->{column_labels});
355 $csv->print($f, $_) for (@{$r->{data}});
362 my $xls = Spreadsheet::WriteExcel::Big->new($file);
364 my $sheetname = substr($r->{report}->{name},1,31);
365 $sheetname =~ s/\W/_/gos;
367 my $sheet = $xls->add_worksheet($sheetname);
369 $sheet->write_row('A1', $r->{column_labels});
371 $sheet->write_col('A2', $r->{data});
380 my $index = new FileHandle (">$file");
383 print $index <<" HEADER";
386 <title>$$r{report}{name}</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; }
396 <h2><u>$$r{report}{name}</u></h2>
397 $$r{report}{description}<br/><br/><br/>
402 # add a link to the raw output html
403 push @links, "<a href='report-data.html.raw.html'>Tabular Output</a>" if ($r->{html_format});
405 # add a link to the CSV output
406 push @links, "<a href='report-data.xls'>Excel Output</a>" if ($r->{excel_format});
408 # add a link to the CSV output
409 push @links, "<a href='report-data.csv'>CSV Output</a>" if ($r->{csv_format});
411 print $index join(' -- ', @links);
412 print $index "<br/><br/><br/><br/></center>";
414 if ($r->{html_format}) {
415 # create the raw output html file
416 my $raw = new FileHandle (">$file.raw.html");
417 print $raw "<html><head><title>$$r{report}{name}</title>";
421 table { border-collapse: collapse; }
422 th { background-color: lightgray; }
423 td,th { border: solid black 1px; }
424 * { font-family: sans-serif; font-size: 10px; }
428 print $raw "</head><body><table>";
431 print $raw "<tr><th>".join('</th><th>',@{$r->{column_labels}}).'</th></tr>';
432 print $raw "<tr><td>".join('</td><td>',@$_ ).'</td></tr>' for (@{$r->{data}});
435 print $raw '</table></body></html>';
440 # Time for a pie chart
441 if ($r->{chart_pie}) {
442 my $pics = draw_pie($r, $file);
443 for my $pic (@$pics) {
444 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
448 print $index '<br/><br/><br/><br/>';
449 # Time for a bar chart
450 if ($r->{chart_bar}) {
451 my $pics = draw_bars($r, $file);
452 for my $pic (@$pics) {
453 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
457 print $index '<br/><br/><br/><br/>';
458 # Time for a bar chart
459 if ($r->{chart_line}) {
460 my $pics = draw_lines($r, $file);
461 for my $pic (@$pics) {
462 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
467 print $index '</body></html>';
476 my $data = $r->{data};
478 my @groups = @{ $r->{group_by_list} };
480 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
481 delete @values[@groups];
483 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
486 for my $vcol (@values) {
487 next unless (defined $vcol);
489 my @pic_data = ([],[]);
490 for my $row (@$data) {
491 next if (!defined($$row[$vcol]) || $$row[$vcol] == 0);
492 my $val = $$row[$vcol];
493 push @{$pic_data[0]}, join(" -- ", @$row[@groups])." ($val)";
494 push @{$pic_data[1]}, $val;
497 next unless (@{$pic_data[0]});
500 my $split = int(scalar(@{$pic_data[0]}) / $size);
501 my $last = scalar(@{$pic_data[0]}) % $size;
503 for my $sub_graph (0 .. $split) {
505 if ($sub_graph == $split) {
510 for my $set (@pic_data) {
511 push @sub_data, [ splice(@$set,0,$size) ];
514 my $pic = new GD::Graph::pie;
517 label => $r->{column_labels}->[$vcol],
519 legend_placement => 'R',
521 #logo_position => 'TL',
526 my $format = $pic->export_format;
528 open(IMG, ">$file.pie.$vcol.$sub_graph.$format");
533 $pic->plot(\@sub_data) or die $pic->error;
534 print IMG $pic->gd->$format;
537 warn "Couldn't draw $file.pie.$vcol.$sub_graph.$format : $e";
545 { file => "pie.$vcol.$sub_graph.$format",
546 name => $r->{column_labels}->[$vcol].' (Pie)',
547 } unless ($forgetit);
549 last if ($sub_graph == $split);
560 my $data = $r->{data};
562 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
564 my @groups = @{ $r->{group_by_list} };
567 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
568 splice(@values,$_,1) for (reverse @groups);
572 for my $row (@$data) {
573 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
583 for my $vcol (@values) {
584 next unless (defined $vcol);
585 $pic_data[$set] ||= [];
588 for my $row (@$data) {
589 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
590 push @{$pic_data[$set]}, $val;
591 $max_y = $val if ($val > $max_y);
592 $trim_candidates{$pos}++ if ($val == 0);
598 my $set_count = scalar(@pic_data) - 1;
599 my @trim_cols = grep { $trim_candidates{$_} == $set_count } keys %trim_candidates;
605 for my $dataset (@pic_data) {
606 splice(@$dataset,$_,1) for (reverse sort @trim_cols);
608 if (grep { $_ } @$dataset) {
609 push @new_data, $dataset;
610 push @use_me, $set_index if ($set_index > 0);
612 push @no_use, $set_index;
618 return [] unless ($new_data[0] && @{$new_data[0]});
620 for my $col (@use_me) {
621 push @leg, $r->{column_labels}->[$values[$col - 1]];
624 my $w = 100 + 10 * scalar(@{$new_data[0]});
625 $w = 400 if ($w < 400);
627 my $h = 10 * (scalar(@new_data) / 2);
631 my $pic = new GD::Graph::bars3d ($w + 250, $h + 500);
634 title => $r->{report}{name},
635 x_labels_vertical => 1,
639 y_max_value => $max_y,
640 legend_placement => 'TR',
643 #logo_position => 'R',
648 $pic->set_legend(@leg);
650 my $format = $pic->export_format;
652 open(IMG, ">$file.bar.$format");
656 $pic->plot(\@new_data) or die $pic->error;
657 print IMG $pic->gd->$format;
660 warn "Couldn't draw $file.bar.$format : $e";
665 return [{ file => "bar.$format",
666 name => $r->{report}{name}.' (Bar)',
674 my $data = $r->{data};
676 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
678 my @groups = @{ $r->{group_by_list} };
680 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
681 splice(@values,$_,1) for (reverse @groups);
685 for my $row (@$data) {
686 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
694 for my $vcol (@values) {
695 next unless (defined $vcol);
696 $pic_data[$set] ||= [];
699 for my $row (@$data) {
700 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
701 push @{$pic_data[$set]}, $val;
702 $max_y = $val if ($val > $max_y);
707 my $set_count = scalar(@pic_data) - 1;
713 for my $dataset (@pic_data) {
715 if (grep { $_ } @$dataset) {
716 push @new_data, $dataset;
717 push @use_me, $set_index if ($set_index > 0);
719 push @no_use, $set_index;
725 for my $col (@use_me) {
726 push @leg, $r->{column_labels}->[$values[$col - 1]];
729 my $w = 100 + 10 * scalar(@{$new_data[0]});
730 $w = 400 if ($w < 400);
732 my $h = 10 * (scalar(@new_data) / 2);
736 my $pic = new GD::Graph::lines3d ($w + 250, $h + 500);
739 title => $r->{report}{name},
740 x_labels_vertical => 1,
743 y_max_value => $max_y,
744 legend_placement => 'TR',
747 #logo_position => 'R',
752 $pic->set_legend(@leg);
754 my $format = $pic->export_format;
756 open(IMG, ">$file.line.$format");
760 $pic->plot(\@new_data) or die $pic->error;
761 print IMG $pic->gd->$format;
764 warn "Couldn't draw $file.line.$format : $e";
769 return [{ file => "line.$format",
770 name => $r->{report}{name}.' (Bar)',
778 my $pivot_label = shift;
779 my $pivot_data = shift;
781 $default = 0 unless (defined $default);
783 my $data = $$blob{data};
784 my $cols = $$blob{columns};
786 my @keep_labels = @$cols;
787 splice(@keep_labels, $_ - 1, 1) for (reverse sort ($pivot_label, $pivot_data));
789 my @keep_cols = (0 .. @$cols - 1);
790 splice(@keep_cols, $_ - 1, 1) for (reverse sort ($pivot_label, $pivot_data));
792 my @gb = ( 0 .. @keep_cols - 1);
794 #first, find the unique list of pivot values
796 for my $row (@$data) {
797 $tmp{ $$row[$pivot_label - 1] } = 1;
799 my @new_cols = sort keys %tmp;
801 tie my %split_data, 'Tie::IxHash';
802 for my $row (@$data) {
804 my $row_fp = ''. join('', map { defined($$row[$_]) ? $$row[$_] : '' } @keep_cols);
805 $split_data{$row_fp} ||= [];
807 push @{ $split_data{$row_fp} }, $row;
811 #now loop over the data, building a new result set
812 tie my %new_data, 'Tie::IxHash';
814 for my $fp ( keys %split_data ) {
818 for my $col (@keep_cols) {
819 push @{ $new_data{$fp} }, $split_data{$fp}[0][$col];
822 for my $col (@new_cols) {
824 my ($datum) = map { $_->[$pivot_data - 1] } grep { $_->[$pivot_label - 1] eq $col } @{ $split_data{$fp} };
826 push @{ $new_data{$fp} }, $datum;
830 push @keep_labels, @new_cols;
832 return { columns => \@keep_labels, data => [ values %new_data ], group_by_list => \@gb };