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 # 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' );
55 $db_name = $sc->config_value( reporter => setup => database => 'name' );
56 print STDERR "WARN: <database><name> is a deprecated setting for database name. For future compatibility, you should use <database><db> instead." if $db_name;
58 my $db_user = $sc->config_value( reporter => setup => database => 'user' );
59 my $db_pw = $sc->config_value( reporter => setup => database => 'pw' );
61 die "Unable to retrieve database connection information from the settings server" unless ($db_driver && $db_host && $db_port && $db_name && $db_user);
63 my $email_server = $sc->config_value( email_notify => 'smtp_server' );
64 my $email_sender = $sc->config_value( email_notify => 'sender_address' );
65 my $success_template = $sc->config_value( reporter => setup => files => 'success_template' );
66 my $fail_template = $sc->config_value( reporter => setup => files => 'fail_template' );
68 my $output_base = $sc->config_value( reporter => setup => files => 'output_base' );
70 my $base_uri = $sc->config_value( reporter => setup => 'base_uri' );
72 my $dsn = "dbi:" . $db_driver . ":dbname=" . $db_name .';host=' . $db_host . ';port=' . $db_port;
74 my ($dbh,$running,$sth,@reports,$run, $current_time);
77 open(F, ">$lockfile");
80 daemonize("Clark Kent, waiting for trouble");
86 $dbh = DBI->connect($dsn,$db_user,$db_pw, {AutoCommit => 1, pg_enable_utf8 => 1, RaiseError => 1});
88 $current_time = DateTime->from_epoch( epoch => time() )->strftime('%FT%T%z');
90 # make sure we're not already running $count reports
91 ($running) = $dbh->selectrow_array(<<SQL);
93 FROM reporter.schedule
94 WHERE start_time IS NOT NULL AND complete_time IS NULL;
97 if ($count <= $running) {
101 POSIX::waitpid( -1, POSIX::WNOHANG );
102 sleep $sleep_interval;
105 print "Already running maximum ($running) concurrent reports\n";
109 # if we have some open slots then generate the sql
110 $run = $count - $running;
112 $sth = $dbh->prepare(<<SQL);
114 FROM reporter.schedule
115 WHERE start_time IS NULL AND run_time < NOW()
123 while (my $r = $sth->fetchrow_hashref) {
124 my $s3 = $dbh->selectrow_hashref(<<" SQL", {}, $r->{report});
125 SELECT * FROM reporter.report WHERE id = ?;
128 my $s2 = $dbh->selectrow_hashref(<<" SQL", {}, $s3->{template});
129 SELECT * FROM reporter.template WHERE id = ?;
132 $s3->{template} = $s2;
135 my $b = OpenILS::Reporter::SQLBuilder->new;
136 my $report_data = OpenSRF::Utils::JSON->JSON2perl( $r->{report}->{data} );
137 $b->register_params( $report_data );
139 $r->{resultset} = $b->parse_report( OpenSRF::Utils::JSON->JSON2perl( $r->{report}->{template}->{data} ) );
140 $r->{resultset}->set_pivot_data($report_data->{__pivot_data}) if $report_data->{__pivot_data};
141 $r->{resultset}->set_pivot_label($report_data->{__pivot_label}) if $report_data->{__pivot_label};
142 $r->{resultset}->set_pivot_default($report_data->{__pivot_default}) if $report_data->{__pivot_default};
143 $r->{resultset}->relative_time($r->{run_time});
151 # Now we spawn the report runners
153 for my $r ( @reports ) {
154 next if (safe_fork());
156 # This is the child (runner) process;
157 daemonize("Clark Kent reporting: $r->{report}->{name}");
159 $dbh = DBI->connect($dsn,$db_user,$db_pw, {AutoCommit => 1, pg_enable_utf8 => 1, RaiseError => 1});
162 $dbh->do(<<' SQL',{}, $r->{id});
163 UPDATE reporter.schedule
164 SET start_time = now()
168 $logger->debug('Report SQL: ' . $r->{resultset}->toSQL);
169 $sth = $dbh->prepare($r->{resultset}->toSQL);
172 $r->{data} = $sth->fetchall_arrayref;
174 $r->{column_labels} = [$r->{resultset}->column_label_list];
176 if ($r->{resultset}->pivot_data && $r->{resultset}->pivot_label) {
177 my @labels = $r->{resultset}->column_label_list;
178 my $newdata = pivot_data(
179 { columns => $r->{column_labels}, data => $r->{data}},
180 $r->{resultset}->pivot_label,
181 $r->{resultset}->pivot_data,
182 $r->{resultset}->pivot_default
185 $r->{column_labels} = $newdata->{columns};
186 $r->{data} = $newdata->{data};
187 $r->{group_by_list} = $newdata->{group_by_list};
189 $r->{group_by_list} = [$r->{resultset}->group_by_list(0)];
192 my $s2 = $r->{report}->{template}->{id};
193 my $s3 = $r->{report}->{id};
194 my $output = $r->{id};
197 mkdir("$output_base/$s2");
198 mkdir("$output_base/$s2/$s3");
199 mkdir("$output_base/$s2/$s3/$output");
201 my $output_dir = "$output_base/$s2/$s3/$output";
203 if ( $r->{csv_format} ) {
204 build_csv("$output_dir/report-data.csv", $r);
207 if ( $r->{excel_format} ) {
208 build_excel("$output_dir/report-data.xls", $r);
211 build_html("$output_dir/report-data.html", $r);
215 if ($r->{report}->{recur} ) {
217 INSERT INTO reporter.schedule (
229 VALUES ( ?, ?, ?, ?::TIMESTAMPTZ + ?, ?, ?, ?, ?, ?, ?, ? );
239 $r->{report}->{recurance},
250 $dbh->do(<<' SQL',{}, $r->{id});
251 UPDATE reporter.schedule
252 SET complete_time = now()
258 my $new_r = $dbh->selectrow_hashref(<<" SQL", {}, $r->{id});
259 SELECT * FROM reporter.schedule WHERE id = ?;
262 $r->{start_time} = $new_r->{start_time};
263 $r->{complete_time} = $new_r->{complete_time};
271 $r->{error_text} = ''.$e;
272 if (!$dbh->{AutoCommit}) {
275 $dbh->do(<<' SQL',{}, $e, $r->{id});
276 UPDATE reporter.schedule
278 complete_time = now(),
283 my $new_r = $dbh->selectrow_hashref(<<" SQL", {}, $r->{id});
284 SELECT * FROM reporter.schedule WHERE id = ?;
287 $r->{error_text} = $new_r->{error_text};
288 $r->{complete_time} = $new_r->{complete_time};
298 exit; # leave the child
303 POSIX::waitpid( -1, POSIX::WNOHANG );
304 sleep $sleep_interval;
308 #-------------------------------------------------------------------
312 open F, $success_template;
313 my $tmpl = join('',<F>);
316 my $url = $base_uri . '/' .
317 $r->{report}->{template}->{id} . '/' .
318 $r->{report}->{id} . '/' .
319 $r->{id} . '/report-data.html';
321 $tmpl =~ s/{TO}/$r->{email}/smog;
322 $tmpl =~ s/{FROM}/$email_sender/smog;
323 $tmpl =~ s/{REPLY_TO}/$email_sender/smog;
324 $tmpl =~ s/{REPORT_NAME}/$r->{report}->{template}->{name} -- $r->{report}->{name}/smog;
325 $tmpl =~ s/{RUN_TIME}/$r->{run_time}/smog;
326 $tmpl =~ s/{COMPLETE_TIME}/$r->{complete_time}/smog;
327 $tmpl =~ s/{OUTPUT_URL}/$url/smog;
329 my $sender = Email::Send->new({mailer => 'SMTP'});
330 $sender->mailer_args([Host => $email_server]);
331 $sender->send($tmpl);
336 open F, $fail_template;
337 my $tmpl = join('',<F>);
340 my $sql = $r->{resultset}->toSQL;
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/{ERROR_TEXT}/$r->{error_text}/smog;
348 $tmpl =~ s/{SQL}/$sql/smog;
350 my $sender = Email::Send->new({mailer => 'SMTP'});
351 $sender->mailer_args([Host => $email_server]);
352 $sender->send($tmpl);
359 my $csv = Text::CSV_XS->new({ always_quote => 1, eol => "\015\012" });
361 return unless ($csv);
363 my $f = new FileHandle (">$file");
365 $csv->print($f, $r->{column_labels});
366 $csv->print($f, $_) for (@{$r->{data}});
373 my $xls = Spreadsheet::WriteExcel::Big->new($file);
375 my $sheetname = substr($r->{report}->{name},1,31);
376 $sheetname =~ s/\W/_/gos;
378 my $sheet = $xls->add_worksheet($sheetname);
380 $sheet->write_row('A1', $r->{column_labels});
382 $sheet->write_col('A2', $r->{data});
391 my $index = new FileHandle (">$file");
394 print $index <<" HEADER";
397 <title>$$r{report}{name}</title>
399 table { border-collapse: collapse; }
400 th { background-color: lightgray; }
401 td,th { border: solid black 1px; }
402 * { font-family: sans-serif; font-size: 10px; }
407 <h2><u>$$r{report}{name}</u></h2>
408 $$r{report}{description}<br/><br/><br/>
413 # add a link to the raw output html
414 push @links, "<a href='report-data.html.raw.html'>Tabular Output</a>" if ($r->{html_format});
416 # add a link to the CSV output
417 push @links, "<a href='report-data.xls'>Excel Output</a>" if ($r->{excel_format});
419 # add a link to the CSV output
420 push @links, "<a href='report-data.csv'>CSV Output</a>" if ($r->{csv_format});
422 print $index join(' -- ', @links);
423 print $index "<br/><br/><br/><br/></center>";
425 if ($r->{html_format}) {
426 # create the raw output html file
427 my $raw = new FileHandle (">$file.raw.html");
428 print $raw "<html><head><title>$$r{report}{name}</title>";
432 table { border-collapse: collapse; }
433 th { background-color: lightgray; }
434 td,th { border: solid black 1px; }
435 * { font-family: sans-serif; font-size: 10px; }
439 print $raw "</head><body><table>";
442 print $raw "<tr><th>".join('</th><th>',@{$r->{column_labels}}).'</th></tr>';
443 print $raw "<tr><td>".join('</td><td>',@$_ ).'</td></tr>' for (@{$r->{data}});
446 print $raw '</table></body></html>';
451 # Time for a pie chart
452 if ($r->{chart_pie}) {
453 my $pics = draw_pie($r, $file);
454 for my $pic (@$pics) {
455 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
459 print $index '<br/><br/><br/><br/>';
460 # Time for a bar chart
461 if ($r->{chart_bar}) {
462 my $pics = draw_bars($r, $file);
463 for my $pic (@$pics) {
464 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
468 print $index '<br/><br/><br/><br/>';
469 # Time for a bar chart
470 if ($r->{chart_line}) {
471 my $pics = draw_lines($r, $file);
472 for my $pic (@$pics) {
473 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
478 print $index '</body></html>';
487 my $data = $r->{data};
489 my @groups = @{ $r->{group_by_list} };
491 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
492 delete @values[@groups];
494 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
497 for my $vcol (@values) {
498 next unless (defined $vcol);
500 my @pic_data = ([],[]);
501 for my $row (@$data) {
502 next if (!defined($$row[$vcol]) || $$row[$vcol] == 0);
503 my $val = $$row[$vcol];
504 push @{$pic_data[0]}, join(" -- ", @$row[@groups])." ($val)";
505 push @{$pic_data[1]}, $val;
508 next unless (@{$pic_data[0]});
511 my $split = int(scalar(@{$pic_data[0]}) / $size);
512 my $last = scalar(@{$pic_data[0]}) % $size;
514 for my $sub_graph (0 .. $split) {
516 if ($sub_graph == $split) {
521 for my $set (@pic_data) {
522 push @sub_data, [ splice(@$set,0,$size) ];
525 my $pic = new GD::Graph::pie;
528 label => $r->{column_labels}->[$vcol],
530 legend_placement => 'R',
532 #logo_position => 'TL',
537 my $format = $pic->export_format;
539 open(IMG, ">$file.pie.$vcol.$sub_graph.$format");
544 $pic->plot(\@sub_data) or die $pic->error;
545 print IMG $pic->gd->$format;
548 warn "Couldn't draw $file.pie.$vcol.$sub_graph.$format : $e";
556 { file => "pie.$vcol.$sub_graph.$format",
557 name => $r->{column_labels}->[$vcol].' (Pie)',
558 } unless ($forgetit);
560 last if ($sub_graph == $split);
571 my $data = $r->{data};
573 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
575 my @groups = @{ $r->{group_by_list} };
578 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
579 splice(@values,$_,1) for (reverse @groups);
583 for my $row (@$data) {
584 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
594 for my $vcol (@values) {
595 next unless (defined $vcol);
596 $pic_data[$set] ||= [];
599 for my $row (@$data) {
600 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
601 push @{$pic_data[$set]}, $val;
602 $max_y = $val if ($val > $max_y);
603 $trim_candidates{$pos}++ if ($val == 0);
609 my $set_count = scalar(@pic_data) - 1;
610 my @trim_cols = grep { $trim_candidates{$_} == $set_count } keys %trim_candidates;
616 for my $dataset (@pic_data) {
617 splice(@$dataset,$_,1) for (reverse sort @trim_cols);
619 if (grep { $_ } @$dataset) {
620 push @new_data, $dataset;
621 push @use_me, $set_index if ($set_index > 0);
623 push @no_use, $set_index;
629 return [] unless ($new_data[0] && @{$new_data[0]});
631 for my $col (@use_me) {
632 push @leg, $r->{column_labels}->[$values[$col - 1]];
635 my $w = 100 + 10 * scalar(@{$new_data[0]});
636 $w = 400 if ($w < 400);
638 my $h = 10 * (scalar(@new_data) / 2);
642 my $pic = new GD::Graph::bars3d ($w + 250, $h + 500);
645 title => $r->{report}{name},
646 x_labels_vertical => 1,
650 y_max_value => $max_y,
651 legend_placement => 'TR',
654 #logo_position => 'R',
659 $pic->set_legend(@leg);
661 my $format = $pic->export_format;
663 open(IMG, ">$file.bar.$format");
667 $pic->plot(\@new_data) or die $pic->error;
668 print IMG $pic->gd->$format;
671 warn "Couldn't draw $file.bar.$format : $e";
676 return [{ file => "bar.$format",
677 name => $r->{report}{name}.' (Bar)',
685 my $data = $r->{data};
687 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
689 my @groups = @{ $r->{group_by_list} };
691 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
692 splice(@values,$_,1) for (reverse @groups);
696 for my $row (@$data) {
697 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
705 for my $vcol (@values) {
706 next unless (defined $vcol);
707 $pic_data[$set] ||= [];
710 for my $row (@$data) {
711 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
712 push @{$pic_data[$set]}, $val;
713 $max_y = $val if ($val > $max_y);
718 my $set_count = scalar(@pic_data) - 1;
724 for my $dataset (@pic_data) {
726 if (grep { $_ } @$dataset) {
727 push @new_data, $dataset;
728 push @use_me, $set_index if ($set_index > 0);
730 push @no_use, $set_index;
736 for my $col (@use_me) {
737 push @leg, $r->{column_labels}->[$values[$col - 1]];
740 my $w = 100 + 10 * scalar(@{$new_data[0]});
741 $w = 400 if ($w < 400);
743 my $h = 10 * (scalar(@new_data) / 2);
747 my $pic = new GD::Graph::lines3d ($w + 250, $h + 500);
750 title => $r->{report}{name},
751 x_labels_vertical => 1,
754 y_max_value => $max_y,
755 legend_placement => 'TR',
758 #logo_position => 'R',
763 $pic->set_legend(@leg);
765 my $format = $pic->export_format;
767 open(IMG, ">$file.line.$format");
771 $pic->plot(\@new_data) or die $pic->error;
772 print IMG $pic->gd->$format;
775 warn "Couldn't draw $file.line.$format : $e";
780 return [{ file => "line.$format",
781 name => $r->{report}{name}.' (Bar)',
789 my $pivot_label = shift;
790 my $pivot_data = shift;
792 $default = 0 unless (defined $default);
794 my $data = $$blob{data};
795 my $cols = $$blob{columns};
797 my @keep_labels = @$cols;
798 splice(@keep_labels, $_ - 1, 1) for (reverse sort ($pivot_label, $pivot_data));
800 my @keep_cols = (0 .. @$cols - 1);
801 splice(@keep_cols, $_ - 1, 1) for (reverse sort ($pivot_label, $pivot_data));
803 my @gb = ( 0 .. @keep_cols - 1);
805 #first, find the unique list of pivot values
807 for my $row (@$data) {
808 $tmp{ $$row[$pivot_label - 1] } = 1;
810 my @new_cols = sort keys %tmp;
812 tie my %split_data, 'Tie::IxHash';
813 for my $row (@$data) {
815 my $row_fp = ''. join('', map { defined($$row[$_]) ? $$row[$_] : '' } @keep_cols);
816 $split_data{$row_fp} ||= [];
818 push @{ $split_data{$row_fp} }, $row;
822 #now loop over the data, building a new result set
823 tie my %new_data, 'Tie::IxHash';
825 for my $fp ( keys %split_data ) {
829 for my $col (@keep_cols) {
830 push @{ $new_data{$fp} }, $split_data{$fp}[0][$col];
833 for my $col (@new_cols) {
835 my ($datum) = map { $_->[$pivot_data - 1] } grep { $_->[$pivot_label - 1] eq $col } @{ $split_data{$fp} };
837 push @{ $new_data{$fp} }, $datum;
841 push @keep_labels, @new_cols;
843 return { columns => \@keep_labels, data => [ values %new_data ], group_by_list => \@gb };