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");
105 $dbh = DBI->connect($state_dsn,$state_db{db_user},$state_db{db_pw}, {AutoCommit => 1, pg_enable_utf8 => 1, RaiseError => 1});
107 $current_time = DateTime->from_epoch( epoch => time() )->strftime('%FT%T%z');
109 # make sure we're not already running $count reports
110 ($running) = $dbh->selectrow_array(<<SQL);
112 FROM reporter.schedule
113 WHERE start_time IS NOT NULL AND complete_time IS NULL;
116 if ($count <= $running) {
120 POSIX::waitpid( -1, POSIX::WNOHANG );
121 sleep $sleep_interval;
124 print "Already running maximum ($running) concurrent reports\n";
128 # if we have some open slots then generate the sql
129 $run = $count - $running;
131 $sth = $dbh->prepare(<<SQL);
133 FROM reporter.schedule
134 WHERE start_time IS NULL AND run_time < NOW()
142 while (my $r = $sth->fetchrow_hashref) {
143 my $s3 = $dbh->selectrow_hashref(<<" SQL", {}, $r->{report});
144 SELECT * FROM reporter.report WHERE id = ?;
147 my $s2 = $dbh->selectrow_hashref(<<" SQL", {}, $s3->{template});
148 SELECT * FROM reporter.template WHERE id = ?;
151 $s3->{template} = $s2;
154 my $b = OpenILS::Reporter::SQLBuilder->new;
155 my $report_data = OpenSRF::Utils::JSON->JSON2perl( $r->{report}->{data} );
156 $b->register_params( $report_data );
158 $r->{resultset} = $b->parse_report( OpenSRF::Utils::JSON->JSON2perl( $r->{report}->{template}->{data} ) );
159 $r->{resultset}->set_pivot_data($report_data->{__pivot_data}) if $report_data->{__pivot_data};
160 $r->{resultset}->set_pivot_label($report_data->{__pivot_label}) if $report_data->{__pivot_label};
161 $r->{resultset}->set_pivot_default($report_data->{__pivot_default}) if $report_data->{__pivot_default};
162 $r->{resultset}->relative_time($r->{run_time});
170 # Now we spawn the report runners
172 for my $r ( @reports ) {
173 next if (safe_fork());
175 # This is the child (runner) process;
176 daemonize("Clark Kent reporting: $r->{report}->{name}");
178 my $state_dbh = DBI->connect($state_dsn,$state_db{db_user},$state_db{db_pw}, {AutoCommit => 1, pg_enable_utf8 => 1, RaiseError => 1});
179 my $data_dbh = DBI->connect($data_dsn,$data_db{db_user},$data_db{db_pw}, {AutoCommit => 1, pg_enable_utf8 => 1, RaiseError => 1});
182 $state_dbh->do(<<' SQL',{}, $r->{id});
183 UPDATE reporter.schedule
184 SET start_time = now()
188 $logger->debug('Report SQL: ' . $r->{resultset}->toSQL);
189 $sth = $data_dbh->prepare($r->{resultset}->toSQL);
192 $r->{data} = $sth->fetchall_arrayref;
194 $r->{column_labels} = [$r->{resultset}->column_label_list];
196 if ($r->{resultset}->pivot_data && $r->{resultset}->pivot_label) {
197 my @labels = $r->{resultset}->column_label_list;
198 my $newdata = pivot_data(
199 { columns => $r->{column_labels}, data => $r->{data}},
200 $r->{resultset}->pivot_label,
201 $r->{resultset}->pivot_data,
202 $r->{resultset}->pivot_default
205 $r->{column_labels} = $newdata->{columns};
206 $r->{data} = $newdata->{data};
207 $r->{group_by_list} = $newdata->{group_by_list};
209 $r->{group_by_list} = [$r->{resultset}->group_by_list(0)];
212 my $s2 = $r->{report}->{template}->{id};
213 my $s3 = $r->{report}->{id};
214 my $output = $r->{id};
217 mkdir("$output_base/$s2");
218 mkdir("$output_base/$s2/$s3");
219 mkdir("$output_base/$s2/$s3/$output");
221 my $output_dir = "$output_base/$s2/$s3/$output";
223 if ( $r->{csv_format} ) {
224 build_csv("$output_dir/report-data.csv", $r);
227 if ( $r->{excel_format} ) {
228 build_excel("$output_dir/report-data.xls", $r);
231 build_html("$output_dir/report-data.html", $r);
233 $state_dbh->begin_work;
235 if ($r->{report}->{recur} ) {
237 INSERT INTO reporter.schedule (
249 VALUES ( ?, ?, ?, ?::TIMESTAMPTZ + ?, ?, ?, ?, ?, ?, ?, ? );
259 $r->{report}->{recurance},
270 $state_dbh->do(<<' SQL',{}, $r->{id});
271 UPDATE reporter.schedule
272 SET complete_time = now()
278 my $new_r = $state_dbh->selectrow_hashref(<<" SQL", {}, $r->{id});
279 SELECT * FROM reporter.schedule WHERE id = ?;
282 $r->{start_time} = $new_r->{start_time};
283 $r->{complete_time} = $new_r->{complete_time};
291 $r->{error_text} = ''.$e;
292 if (!$state_dbh->{AutoCommit}) {
293 $state_dbh->rollback;
295 $state_dbh->do(<<' SQL',{}, $e, $r->{id});
296 UPDATE reporter.schedule
298 complete_time = now(),
303 my $new_r = $state_dbh->selectrow_hashref(<<" SQL", {}, $r->{id});
304 SELECT * FROM reporter.schedule WHERE id = ?;
307 $r->{error_text} = $new_r->{error_text};
308 $r->{complete_time} = $new_r->{complete_time};
316 $state_dbh->disconnect;
317 $data_dbh->disconnect;
319 exit; # leave the child
324 POSIX::waitpid( -1, POSIX::WNOHANG );
325 sleep $sleep_interval;
329 #-------------------------------------------------------------------
333 open F, $success_template;
334 my $tmpl = join('',<F>);
337 my $url = $base_uri . '/' .
338 $r->{report}->{template}->{id} . '/' .
339 $r->{report}->{id} . '/' .
340 $r->{id} . '/report-data.html';
342 $tmpl =~ s/{TO}/$r->{email}/smog;
343 $tmpl =~ s/{FROM}/$email_sender/smog;
344 $tmpl =~ s/{REPLY_TO}/$email_sender/smog;
345 $tmpl =~ s/{REPORT_NAME}/$r->{report}->{template}->{name} -- $r->{report}->{name}/smog;
346 $tmpl =~ s/{RUN_TIME}/$r->{run_time}/smog;
347 $tmpl =~ s/{COMPLETE_TIME}/$r->{complete_time}/smog;
348 $tmpl =~ s/{OUTPUT_URL}/$url/smog;
350 my $sender = Email::Send->new({mailer => 'SMTP'});
351 $sender->mailer_args([Host => $email_server]);
352 $sender->send($tmpl);
357 open F, $fail_template;
358 my $tmpl = join('',<F>);
361 my $sql = $r->{resultset}->toSQL;
363 $tmpl =~ s/{TO}/$r->{email}/smog;
364 $tmpl =~ s/{FROM}/$email_sender/smog;
365 $tmpl =~ s/{REPLY_TO}/$email_sender/smog;
366 $tmpl =~ s/{REPORT_NAME}/$r->{report}->{template}->{name} -- $r->{report}->{name}/smog;
367 $tmpl =~ s/{RUN_TIME}/$r->{run_time}/smog;
368 $tmpl =~ s/{ERROR_TEXT}/$r->{error_text}/smog;
369 $tmpl =~ s/{SQL}/$sql/smog;
371 my $sender = Email::Send->new({mailer => 'SMTP'});
372 $sender->mailer_args([Host => $email_server]);
373 $sender->send($tmpl);
380 my $csv = Text::CSV_XS->new({ always_quote => 1, eol => "\015\012" });
382 return unless ($csv);
384 my $f = new FileHandle (">$file");
386 $csv->print($f, $r->{column_labels});
387 $csv->print($f, $_) for (@{$r->{data}});
394 my $xls = Spreadsheet::WriteExcel::Big->new($file);
396 my $sheetname = substr($r->{report}->{name},0,30);
397 $sheetname =~ s/\W/_/gos;
399 my $sheet = $xls->add_worksheet($sheetname);
401 $sheet->write_row('A1', $r->{column_labels});
403 $sheet->write_col('A2', $r->{data});
412 my $index = new FileHandle (">$file");
415 print $index <<" HEADER";
418 <title>$$r{report}{name}</title>
420 table { border-collapse: collapse; }
421 th { background-color: lightgray; }
422 td,th { border: solid black 1px; }
423 * { font-family: sans-serif; font-size: 10px; }
428 <h2><u>$$r{report}{name}</u></h2>
429 $$r{report}{description}<br/><br/><br/>
434 # add a link to the raw output html
435 push @links, "<a href='report-data.html.raw.html'>Tabular Output</a>" if ($r->{html_format});
437 # add a link to the CSV output
438 push @links, "<a href='report-data.xls'>Excel Output</a>" if ($r->{excel_format});
440 # add a link to the CSV output
441 push @links, "<a href='report-data.csv'>CSV Output</a>" if ($r->{csv_format});
443 print $index join(' -- ', @links);
444 print $index "<br/><br/><br/><br/></center>";
446 if ($r->{html_format}) {
447 # create the raw output html file
448 my $raw = new FileHandle (">$file.raw.html");
449 print $raw "<html><head><title>$$r{report}{name}</title>";
453 table { border-collapse: collapse; }
454 th { background-color: lightgray; }
455 td,th { border: solid black 1px; }
456 * { font-family: sans-serif; font-size: 10px; }
460 print $raw "</head><body><table>";
463 print $raw "<tr><th>".join('</th><th>',@{$r->{column_labels}}).'</th></tr>';
464 print $raw "<tr><td>".join('</td><td>',@$_ ).'</td></tr>' for (@{$r->{data}});
467 print $raw '</table></body></html>';
472 # Time for a pie chart
473 if ($r->{chart_pie}) {
474 my $pics = draw_pie($r, $file);
475 for my $pic (@$pics) {
476 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
480 print $index '<br/><br/><br/><br/>';
481 # Time for a bar chart
482 if ($r->{chart_bar}) {
483 my $pics = draw_bars($r, $file);
484 for my $pic (@$pics) {
485 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
489 print $index '<br/><br/><br/><br/>';
490 # Time for a bar chart
491 if ($r->{chart_line}) {
492 my $pics = draw_lines($r, $file);
493 for my $pic (@$pics) {
494 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
499 print $index '</body></html>';
508 my $data = $r->{data};
510 my @groups = @{ $r->{group_by_list} };
512 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
513 delete @values[@groups];
515 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
518 for my $vcol (@values) {
519 next unless (defined $vcol);
521 my @pic_data = ([],[]);
522 for my $row (@$data) {
523 next if (!defined($$row[$vcol]) || $$row[$vcol] == 0);
524 my $val = $$row[$vcol];
525 push @{$pic_data[0]}, join(" -- ", @$row[@groups])." ($val)";
526 push @{$pic_data[1]}, $val;
529 next unless (@{$pic_data[0]});
532 my $split = int(scalar(@{$pic_data[0]}) / $size);
533 my $last = scalar(@{$pic_data[0]}) % $size;
535 for my $sub_graph (0 .. $split) {
537 if ($sub_graph == $split) {
542 for my $set (@pic_data) {
543 push @sub_data, [ splice(@$set,0,$size) ];
546 my $pic = new GD::Graph::pie;
549 label => $r->{column_labels}->[$vcol],
551 legend_placement => 'R',
553 #logo_position => 'TL',
558 my $format = $pic->export_format;
560 open(IMG, ">$file.pie.$vcol.$sub_graph.$format");
565 $pic->plot(\@sub_data) or die $pic->error;
566 print IMG $pic->gd->$format;
569 warn "Couldn't draw $file.pie.$vcol.$sub_graph.$format : $e";
577 { file => "pie.$vcol.$sub_graph.$format",
578 name => $r->{column_labels}->[$vcol].' (Pie)',
579 } unless ($forgetit);
581 last if ($sub_graph == $split);
592 my $data = $r->{data};
594 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
596 my @groups = @{ $r->{group_by_list} };
599 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
600 splice(@values,$_,1) for (reverse @groups);
604 for my $row (@$data) {
605 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
615 for my $vcol (@values) {
616 next unless (defined $vcol);
617 $pic_data[$set] ||= [];
620 for my $row (@$data) {
621 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
622 push @{$pic_data[$set]}, $val;
623 $max_y = $val if ($val > $max_y);
624 $trim_candidates{$pos}++ if ($val == 0);
630 my $set_count = scalar(@pic_data) - 1;
631 my @trim_cols = grep { $trim_candidates{$_} == $set_count } keys %trim_candidates;
637 for my $dataset (@pic_data) {
638 splice(@$dataset,$_,1) for (reverse sort @trim_cols);
640 if (grep { $_ } @$dataset) {
641 push @new_data, $dataset;
642 push @use_me, $set_index if ($set_index > 0);
644 push @no_use, $set_index;
650 return [] unless ($new_data[0] && @{$new_data[0]});
652 for my $col (@use_me) {
653 push @leg, $r->{column_labels}->[$values[$col - 1]];
656 my $w = 100 + 10 * scalar(@{$new_data[0]});
657 $w = 400 if ($w < 400);
659 my $h = 10 * (scalar(@new_data) / 2);
663 my $pic = new GD::Graph::bars3d ($w + 250, $h + 500);
666 title => $r->{report}{name},
667 x_labels_vertical => 1,
671 y_max_value => $max_y,
672 legend_placement => 'TR',
675 #logo_position => 'R',
680 $pic->set_legend(@leg);
682 my $format = $pic->export_format;
684 open(IMG, ">$file.bar.$format");
688 $pic->plot(\@new_data) or die $pic->error;
689 print IMG $pic->gd->$format;
692 warn "Couldn't draw $file.bar.$format : $e";
697 return [{ file => "bar.$format",
698 name => $r->{report}{name}.' (Bar)',
706 my $data = $r->{data};
708 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
710 my @groups = @{ $r->{group_by_list} };
712 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
713 splice(@values,$_,1) for (reverse @groups);
717 for my $row (@$data) {
718 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
726 for my $vcol (@values) {
727 next unless (defined $vcol);
728 $pic_data[$set] ||= [];
731 for my $row (@$data) {
732 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
733 push @{$pic_data[$set]}, $val;
734 $max_y = $val if ($val > $max_y);
739 my $set_count = scalar(@pic_data) - 1;
745 for my $dataset (@pic_data) {
747 if (grep { $_ } @$dataset) {
748 push @new_data, $dataset;
749 push @use_me, $set_index if ($set_index > 0);
751 push @no_use, $set_index;
757 for my $col (@use_me) {
758 push @leg, $r->{column_labels}->[$values[$col - 1]];
761 my $w = 100 + 10 * scalar(@{$new_data[0]});
762 $w = 400 if ($w < 400);
764 my $h = 10 * (scalar(@new_data) / 2);
768 my $pic = new GD::Graph::lines3d ($w + 250, $h + 500);
771 title => $r->{report}{name},
772 x_labels_vertical => 1,
775 y_max_value => $max_y,
776 legend_placement => 'TR',
779 #logo_position => 'R',
784 $pic->set_legend(@leg);
786 my $format = $pic->export_format;
788 open(IMG, ">$file.line.$format");
792 $pic->plot(\@new_data) or die $pic->error;
793 print IMG $pic->gd->$format;
796 warn "Couldn't draw $file.line.$format : $e";
801 return [{ file => "line.$format",
802 name => $r->{report}{name}.' (Bar)',
810 my $pivot_label = shift;
811 my $pivot_data = shift;
813 $default = 0 unless (defined $default);
815 my $data = $$blob{data};
816 my $cols = $$blob{columns};
818 my @keep_labels = @$cols;
819 splice(@keep_labels, $_ - 1, 1) for (reverse sort ($pivot_label, $pivot_data));
821 my @keep_cols = (0 .. @$cols - 1);
822 splice(@keep_cols, $_ - 1, 1) for (reverse sort ($pivot_label, $pivot_data));
824 my @gb = ( 0 .. @keep_cols - 1);
826 #first, find the unique list of pivot values
828 for my $row (@$data) {
829 $tmp{ $$row[$pivot_label - 1] } = 1;
831 my @new_cols = sort keys %tmp;
833 tie my %split_data, 'Tie::IxHash';
834 for my $row (@$data) {
836 my $row_fp = ''. join('', map { defined($$row[$_]) ? $$row[$_] : '' } @keep_cols);
837 $split_data{$row_fp} ||= [];
839 push @{ $split_data{$row_fp} }, $row;
843 #now loop over the data, building a new result set
844 tie my %new_data, 'Tie::IxHash';
846 for my $fp ( keys %split_data ) {
850 for my $col (@keep_cols) {
851 push @{ $new_data{$fp} }, $split_data{$fp}[0][$col];
854 for my $col (@new_cols) {
856 my ($datum) = map { $_->[$pivot_data - 1] } grep { $_->[$pivot_label - 1] eq $col } @{ $split_data{$fp} };
858 push @{ $new_data{$fp} }, $datum;
862 push @keep_labels, @new_cols;
864 return { columns => \@keep_labels, data => [ values %new_data ], group_by_list => \@gb };