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/$logger/;
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, 'SYSCONFDIR/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 my (%data_db, %state_db);
50 my $sc = OpenSRF::Utils::SettingsClient->new;
52 $data_db{db_driver} = $sc->config_value( reporter => setup => database => 'driver' );
53 $data_db{db_host} = $sc->config_value( reporter => setup => database => 'host' );
54 $data_db{db_port} = $sc->config_value( reporter => setup => database => 'port' );
55 $data_db{db_name} = $sc->config_value( reporter => setup => database => 'db' );
56 if (!$data_db{db_name}) {
57 $data_db{db_name} = $sc->config_value( reporter => setup => database => 'name' );
58 print STDERR "WARN: <database><name> is a deprecated setting for database name. For future compatibility, you should use <database><db> instead." if $data_db{db_name};
60 $data_db{db_user} = $sc->config_value( reporter => setup => database => 'user' );
61 $data_db{db_pw} = $sc->config_value( reporter => setup => database => 'pw' );
65 # Fetch the optional state database connection info
66 $state_db{db_driver} = $sc->config_value( reporter => setup => state_store => 'driver' ) || $data_db{db_driver};
67 $state_db{db_host} = $sc->config_value( reporter => setup => state_store => 'host' ) || $data_db{db_host};
68 $state_db{db_port} = $sc->config_value( reporter => setup => state_store => 'port' ) || $data_db{db_port};
69 $state_db{db_name} = $sc->config_value( reporter => setup => state_store => 'db' );
70 if (!$state_db{db_name}) {
71 $state_db{db_name} = $sc->config_value( reporter => setup => state_store => 'name' ) || $data_db{db_name};
73 $state_db{db_user} = $sc->config_value( reporter => setup => state_store => 'user' ) || $data_db{db_user};
74 $state_db{db_pw} = $sc->config_value( reporter => setup => state_store => 'pw' ) || $data_db{db_pw};
77 die "Unable to retrieve database connection information from the settings server"
78 unless ($state_db{db_driver} && $state_db{db_host} && $state_db{db_port} && $state_db{db_name} && $state_db{db_user} &&
79 $data_db{db_driver} && $data_db{db_host} && $data_db{db_port} && $data_db{db_name} && $data_db{db_user});
81 my $email_server = $sc->config_value( email_notify => 'smtp_server' );
82 my $email_sender = $sc->config_value( email_notify => 'sender_address' );
83 my $success_template = $sc->config_value( reporter => setup => files => 'success_template' );
84 my $fail_template = $sc->config_value( reporter => setup => files => 'fail_template' );
86 my $output_base = $sc->config_value( reporter => setup => files => 'output_base' );
88 my $base_uri = $sc->config_value( reporter => setup => 'base_uri' );
90 my $state_dsn = "dbi:" . $state_db{db_driver} . ":dbname=" . $state_db{db_name} .';host=' . $state_db{db_host} . ';port=' . $state_db{db_port};
91 my $data_dsn = "dbi:" . $data_db{db_driver} . ":dbname=" . $data_db{db_name} .';host=' . $data_db{db_host} . ';port=' . $data_db{db_port};
93 my ($dbh,$running,$sth,@reports,$run, $current_time);
96 open(F, ">$lockfile");
99 daemonize("Clark Kent, waiting for trouble");
110 pg_expand_array => 0,
116 $current_time = DateTime->from_epoch( epoch => time() )->strftime('%FT%T%z');
118 # make sure we're not already running $count reports
119 ($running) = $dbh->selectrow_array(<<SQL);
121 FROM reporter.schedule
122 WHERE start_time IS NOT NULL AND complete_time IS NULL;
125 if ($count <= $running) {
129 POSIX::waitpid( -1, POSIX::WNOHANG );
130 sleep $sleep_interval;
133 print "Already running maximum ($running) concurrent reports\n";
137 # if we have some open slots then generate the sql
138 $run = $count - $running;
140 $sth = $dbh->prepare(<<SQL);
142 FROM reporter.schedule
143 WHERE start_time IS NULL AND run_time < NOW()
151 while (my $r = $sth->fetchrow_hashref) {
152 my $s3 = $dbh->selectrow_hashref(<<" SQL", {}, $r->{report});
153 SELECT * FROM reporter.report WHERE id = ?;
156 my $s2 = $dbh->selectrow_hashref(<<" SQL", {}, $s3->{template});
157 SELECT * FROM reporter.template WHERE id = ?;
160 $s3->{template} = $s2;
163 my $b = OpenILS::Reporter::SQLBuilder->new;
164 my $report_data = OpenSRF::Utils::JSON->JSON2perl( $r->{report}->{data} );
165 $b->register_params( $report_data );
167 $r->{resultset} = $b->parse_report( OpenSRF::Utils::JSON->JSON2perl( $r->{report}->{template}->{data} ) );
168 $r->{resultset}->set_pivot_data($report_data->{__pivot_data}) if $report_data->{__pivot_data};
169 $r->{resultset}->set_pivot_label($report_data->{__pivot_label}) if $report_data->{__pivot_label};
170 $r->{resultset}->set_pivot_default($report_data->{__pivot_default}) if $report_data->{__pivot_default};
171 $r->{resultset}->relative_time($r->{run_time});
179 # Now we spawn the report runners
181 for my $r ( @reports ) {
182 next if (safe_fork());
184 # This is the child (runner) process;
185 daemonize("Clark Kent reporting: $r->{report}->{name}");
187 my $state_dbh = DBI->connect(
192 pg_expand_array => 0,
198 my $data_dbh = DBI->connect(
203 pg_expand_array => 0,
210 $state_dbh->do(<<' SQL',{}, $r->{id});
211 UPDATE reporter.schedule
212 SET start_time = now()
216 $logger->debug('Report SQL: ' . $r->{resultset}->toSQL);
217 $sth = $data_dbh->prepare($r->{resultset}->toSQL);
220 $r->{data} = $sth->fetchall_arrayref;
222 $r->{column_labels} = [$r->{resultset}->column_label_list];
224 if ($r->{resultset}->pivot_data && $r->{resultset}->pivot_label) {
225 my @labels = $r->{resultset}->column_label_list;
226 my $newdata = pivot_data(
227 { columns => $r->{column_labels}, data => $r->{data}},
228 $r->{resultset}->pivot_label,
229 $r->{resultset}->pivot_data,
230 $r->{resultset}->pivot_default
233 $r->{column_labels} = $newdata->{columns};
234 $r->{data} = $newdata->{data};
235 $r->{group_by_list} = $newdata->{group_by_list};
237 $r->{group_by_list} = [$r->{resultset}->group_by_list(0)];
240 my $s2 = $r->{report}->{template}->{id};
241 my $s3 = $r->{report}->{id};
242 my $output = $r->{id};
245 mkdir("$output_base/$s2");
246 mkdir("$output_base/$s2/$s3");
247 mkdir("$output_base/$s2/$s3/$output");
249 my $output_dir = "$output_base/$s2/$s3/$output";
251 if ( $r->{csv_format} ) {
252 build_csv("$output_dir/report-data.csv", $r);
255 if ( $r->{excel_format} ) {
256 build_excel("$output_dir/report-data.xls", $r);
259 build_html("$output_dir/report-data.html", $r);
261 $state_dbh->begin_work;
263 if ($r->{report}->{recur} ) {
265 INSERT INTO reporter.schedule (
277 VALUES ( ?, ?, ?, ?::TIMESTAMPTZ + ?, ?, ?, ?, ?, ?, ?, ? );
287 $r->{report}->{recurance},
298 $state_dbh->do(<<' SQL',{}, $r->{id});
299 UPDATE reporter.schedule
300 SET complete_time = now()
306 my $new_r = $state_dbh->selectrow_hashref(<<" SQL", {}, $r->{id});
307 SELECT * FROM reporter.schedule WHERE id = ?;
310 $r->{start_time} = $new_r->{start_time};
311 $r->{complete_time} = $new_r->{complete_time};
319 $r->{error_text} = ''.$e;
320 if (!$state_dbh->{AutoCommit}) {
321 $state_dbh->rollback;
323 $state_dbh->do(<<' SQL',{}, $e, $r->{id});
324 UPDATE reporter.schedule
326 complete_time = now(),
331 my $new_r = $state_dbh->selectrow_hashref(<<" SQL", {}, $r->{id});
332 SELECT * FROM reporter.schedule WHERE id = ?;
335 $r->{error_text} = $new_r->{error_text};
336 $r->{complete_time} = $new_r->{complete_time};
344 $state_dbh->disconnect;
345 $data_dbh->disconnect;
347 exit; # leave the child
352 POSIX::waitpid( -1, POSIX::WNOHANG );
353 sleep $sleep_interval;
357 #-------------------------------------------------------------------
361 open F, $success_template;
362 my $tmpl = join('',<F>);
365 my $url = $base_uri . '/' .
366 $r->{report}->{template}->{id} . '/' .
367 $r->{report}->{id} . '/' .
368 $r->{id} . '/report-data.html';
370 $tmpl =~ s/{TO}/$r->{email}/smog;
371 $tmpl =~ s/{FROM}/$email_sender/smog;
372 $tmpl =~ s/{REPLY_TO}/$email_sender/smog;
373 $tmpl =~ s/{REPORT_NAME}/$r->{report}->{template}->{name} -- $r->{report}->{name}/smog;
374 $tmpl =~ s/{RUN_TIME}/$r->{run_time}/smog;
375 $tmpl =~ s/{COMPLETE_TIME}/$r->{complete_time}/smog;
376 $tmpl =~ s/{OUTPUT_URL}/$url/smog;
378 my $sender = Email::Send->new({mailer => 'SMTP'});
379 $sender->mailer_args([Host => $email_server]);
380 $sender->send($tmpl);
385 open F, $fail_template;
386 my $tmpl = join('',<F>);
389 my $sql = $r->{resultset}->toSQL;
391 $tmpl =~ s/{TO}/$r->{email}/smog;
392 $tmpl =~ s/{FROM}/$email_sender/smog;
393 $tmpl =~ s/{REPLY_TO}/$email_sender/smog;
394 $tmpl =~ s/{REPORT_NAME}/$r->{report}->{template}->{name} -- $r->{report}->{name}/smog;
395 $tmpl =~ s/{RUN_TIME}/$r->{run_time}/smog;
396 $tmpl =~ s/{ERROR_TEXT}/$r->{error_text}/smog;
397 $tmpl =~ s/{SQL}/$sql/smog;
399 my $sender = Email::Send->new({mailer => 'SMTP'});
400 $sender->mailer_args([Host => $email_server]);
401 $sender->send($tmpl);
408 my $csv = Text::CSV_XS->new({ always_quote => 1, eol => "\015\012" });
410 return unless ($csv);
412 my $f = new FileHandle (">$file");
414 $csv->print($f, $r->{column_labels});
415 $csv->print($f, $_) for (@{$r->{data}});
422 my $xls = Spreadsheet::WriteExcel::Big->new($file);
424 my $sheetname = substr($r->{report}->{name},0,30);
425 $sheetname =~ s/\W/_/gos;
427 my $sheet = $xls->add_worksheet($sheetname);
429 $sheet->write_row('A1', $r->{column_labels});
431 $sheet->write_col('A2', $r->{data});
440 my $index = new FileHandle (">$file");
443 print $index <<" HEADER";
446 <title>$$r{report}{name}</title>
448 table { border-collapse: collapse; }
449 th { background-color: lightgray; }
450 td,th { border: solid black 1px; }
451 * { font-family: sans-serif; font-size: 10px; }
456 <h2><u>$$r{report}{name}</u></h2>
457 $$r{report}{description}<br/><br/><br/>
462 # add a link to the raw output html
463 push @links, "<a href='report-data.html.raw.html'>Tabular Output</a>" if ($r->{html_format});
465 # add a link to the CSV output
466 push @links, "<a href='report-data.xls'>Excel Output</a>" if ($r->{excel_format});
468 # add a link to the CSV output
469 push @links, "<a href='report-data.csv'>CSV Output</a>" if ($r->{csv_format});
471 print $index join(' -- ', @links);
472 print $index "<br/><br/><br/><br/></center>";
474 if ($r->{html_format}) {
475 # create the raw output html file
476 my $raw = new FileHandle (">$file.raw.html");
477 print $raw "<html><head><title>$$r{report}{name}</title>";
481 table { border-collapse: collapse; }
482 th { background-color: lightgray; }
483 td,th { border: solid black 1px; }
484 * { font-family: sans-serif; font-size: 10px; }
488 print $raw "</head><body><table>";
491 print $raw "<tr><th>".join('</th><th>',@{$r->{column_labels}}).'</th></tr>';
492 print $raw "<tr><td>".join('</td><td>',@$_ ).'</td></tr>' for (@{$r->{data}});
495 print $raw '</table></body></html>';
500 # Time for a pie chart
501 if ($r->{chart_pie}) {
502 my $pics = draw_pie($r, $file);
503 for my $pic (@$pics) {
504 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
508 print $index '<br/><br/><br/><br/>';
509 # Time for a bar chart
510 if ($r->{chart_bar}) {
511 my $pics = draw_bars($r, $file);
512 for my $pic (@$pics) {
513 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
517 print $index '<br/><br/><br/><br/>';
518 # Time for a bar chart
519 if ($r->{chart_line}) {
520 my $pics = draw_lines($r, $file);
521 for my $pic (@$pics) {
522 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
527 print $index '</body></html>';
536 my $data = $r->{data};
538 my @groups = @{ $r->{group_by_list} };
540 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
541 delete @values[@groups];
543 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
546 for my $vcol (@values) {
547 next unless (defined $vcol);
549 my @pic_data = ([],[]);
550 for my $row (@$data) {
551 next if (!defined($$row[$vcol]) || $$row[$vcol] == 0);
552 my $val = $$row[$vcol];
553 push @{$pic_data[0]}, join(" -- ", @$row[@groups])." ($val)";
554 push @{$pic_data[1]}, $val;
557 next unless (@{$pic_data[0]});
560 my $split = int(scalar(@{$pic_data[0]}) / $size);
561 my $last = scalar(@{$pic_data[0]}) % $size;
563 for my $sub_graph (0 .. $split) {
565 if ($sub_graph == $split) {
570 for my $set (@pic_data) {
571 push @sub_data, [ splice(@$set,0,$size) ];
574 my $pic = new GD::Graph::pie;
577 label => $r->{column_labels}->[$vcol],
579 legend_placement => 'R',
581 #logo_position => 'TL',
586 my $format = $pic->export_format;
588 open(IMG, ">$file.pie.$vcol.$sub_graph.$format");
593 $pic->plot(\@sub_data) or die $pic->error;
594 print IMG $pic->gd->$format;
597 warn "Couldn't draw $file.pie.$vcol.$sub_graph.$format : $e";
605 { file => "pie.$vcol.$sub_graph.$format",
606 name => $r->{column_labels}->[$vcol].' (Pie)',
607 } unless ($forgetit);
609 last if ($sub_graph == $split);
620 my $data = $r->{data};
622 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
624 my @groups = @{ $r->{group_by_list} };
627 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
628 splice(@values,$_,1) for (reverse @groups);
632 for my $row (@$data) {
633 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
643 for my $vcol (@values) {
644 next unless (defined $vcol);
645 $pic_data[$set] ||= [];
648 for my $row (@$data) {
649 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
650 push @{$pic_data[$set]}, $val;
651 $max_y = $val if ($val > $max_y);
652 $trim_candidates{$pos}++ if ($val == 0);
658 my $set_count = scalar(@pic_data) - 1;
659 my @trim_cols = grep { $trim_candidates{$_} == $set_count } keys %trim_candidates;
665 for my $dataset (@pic_data) {
666 splice(@$dataset,$_,1) for (reverse sort @trim_cols);
668 if (grep { $_ } @$dataset) {
669 push @new_data, $dataset;
670 push @use_me, $set_index if ($set_index > 0);
672 push @no_use, $set_index;
678 return [] unless ($new_data[0] && @{$new_data[0]});
680 for my $col (@use_me) {
681 push @leg, $r->{column_labels}->[$values[$col - 1]];
684 my $w = 100 + 10 * scalar(@{$new_data[0]});
685 $w = 400 if ($w < 400);
687 my $h = 10 * (scalar(@new_data) / 2);
691 my $pic = new GD::Graph::bars3d ($w + 250, $h + 500);
694 title => $r->{report}{name},
695 x_labels_vertical => 1,
699 y_max_value => $max_y,
700 legend_placement => 'TR',
703 #logo_position => 'R',
708 $pic->set_legend(@leg);
710 my $format = $pic->export_format;
712 open(IMG, ">$file.bar.$format");
716 $pic->plot(\@new_data) or die $pic->error;
717 print IMG $pic->gd->$format;
720 warn "Couldn't draw $file.bar.$format : $e";
725 return [{ file => "bar.$format",
726 name => $r->{report}{name}.' (Bar)',
734 my $data = $r->{data};
736 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
738 my @groups = @{ $r->{group_by_list} };
740 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
741 splice(@values,$_,1) for (reverse @groups);
745 for my $row (@$data) {
746 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
754 for my $vcol (@values) {
755 next unless (defined $vcol);
756 $pic_data[$set] ||= [];
759 for my $row (@$data) {
760 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
761 push @{$pic_data[$set]}, $val;
762 $max_y = $val if ($val > $max_y);
767 my $set_count = scalar(@pic_data) - 1;
773 for my $dataset (@pic_data) {
775 if (grep { $_ } @$dataset) {
776 push @new_data, $dataset;
777 push @use_me, $set_index if ($set_index > 0);
779 push @no_use, $set_index;
785 for my $col (@use_me) {
786 push @leg, $r->{column_labels}->[$values[$col - 1]];
789 my $w = 100 + 10 * scalar(@{$new_data[0]});
790 $w = 400 if ($w < 400);
792 my $h = 10 * (scalar(@new_data) / 2);
796 my $pic = new GD::Graph::lines3d ($w + 250, $h + 500);
799 title => $r->{report}{name},
800 x_labels_vertical => 1,
803 y_max_value => $max_y,
804 legend_placement => 'TR',
807 #logo_position => 'R',
812 $pic->set_legend(@leg);
814 my $format = $pic->export_format;
816 open(IMG, ">$file.line.$format");
820 $pic->plot(\@new_data) or die $pic->error;
821 print IMG $pic->gd->$format;
824 warn "Couldn't draw $file.line.$format : $e";
829 return [{ file => "line.$format",
830 name => $r->{report}{name}.' (Bar)',
838 my $pivot_label = shift;
839 my $pivot_data = shift;
841 $default = 0 unless (defined $default);
843 my $data = $$blob{data};
844 my $cols = $$blob{columns};
846 my @keep_labels = @$cols;
847 splice(@keep_labels, $_ - 1, 1) for (reverse sort ($pivot_label, $pivot_data));
849 my @keep_cols = (0 .. @$cols - 1);
850 splice(@keep_cols, $_ - 1, 1) for (reverse sort ($pivot_label, $pivot_data));
852 my @gb = ( 0 .. @keep_cols - 1);
854 #first, find the unique list of pivot values
856 for my $row (@$data) {
857 $tmp{ $$row[$pivot_label - 1] } = 1;
859 my @new_cols = sort keys %tmp;
861 tie my %split_data, 'Tie::IxHash';
862 for my $row (@$data) {
864 my $row_fp = ''. join('', map { defined($$row[$_]) ? $$row[$_] : '' } @keep_cols);
865 $split_data{$row_fp} ||= [];
867 push @{ $split_data{$row_fp} }, $row;
871 #now loop over the data, building a new result set
872 tie my %new_data, 'Tie::IxHash';
874 for my $fp ( keys %split_data ) {
878 for my $col (@keep_cols) {
879 push @{ $new_data{$fp} }, $split_data{$fp}[0][$col];
882 for my $col (@new_cols) {
884 my ($datum) = map { $_->[$pivot_data - 1] } grep { $_->[$pivot_label - 1] eq $col } @{ $split_data{$fp} };
886 push @{ $new_data{$fp} }, $datum;
890 push @keep_labels, @new_cols;
892 return { columns => \@keep_labels, data => [ values %new_data ], group_by_list => \@gb };