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' );
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 $b->register_params( OpenSRF::Utils::JSON->JSON2perl( $r->{report}->{data} ) );
138 $r->{resultset} = $b->parse_report( OpenSRF::Utils::JSON->JSON2perl( $r->{report}->{template}->{data} ) );
139 $r->{resultset}->relative_time($r->{run_time});
147 # Now we spawn the report runners
149 for my $r ( @reports ) {
150 next if (safe_fork());
152 # This is the child (runner) process;
153 daemonize("Clark Kent reporting: $r->{report}->{name}");
155 $dbh = DBI->connect($dsn,$db_user,$db_pw, {AutoCommit => 1, pg_enable_utf8 => 1, RaiseError => 1});
158 $dbh->do(<<' SQL',{}, $r->{id});
159 UPDATE reporter.schedule
160 SET start_time = now()
164 $sth = $dbh->prepare($r->{resultset}->toSQL);
167 $r->{data} = $sth->fetchall_arrayref;
169 $r->{column_labels} = [$r->{resultset}->column_label_list];
171 if ($r->{resultset}->pivot_data && $r->{resultset}->pivot_label) {
172 my @labels = $r->{resultset}->column_label_list;
173 my $newdata = pivot_data(
174 { columns => $r->{column_labels}, data => $r->{data}},
175 $r->{resultset}->pivot_label,
176 $r->{resultset}->pivot_data,
177 $r->{resultset}->pivot_default
180 $r->{column_labels} = $newdata->{columns};
181 $r->{data} = $newdata->{data};
182 $r->{group_by_list} = $newdata->{group_by_list};
184 $r->{group_by_list} = [$r->{resultset}->group_by_list(0)];
187 my $s2 = $r->{report}->{template}->{id};
188 my $s3 = $r->{report}->{id};
189 my $output = $r->{id};
192 mkdir("$output_base/$s2");
193 mkdir("$output_base/$s2/$s3");
194 mkdir("$output_base/$s2/$s3/$output");
196 my $output_dir = "$output_base/$s2/$s3/$output";
198 if ( $r->{csv_format} ) {
199 build_csv("$output_dir/report-data.csv", $r);
202 if ( $r->{excel_format} ) {
203 build_excel("$output_dir/report-data.xls", $r);
206 build_html("$output_dir/report-data.html", $r);
210 if ($r->{report}->{recur} ) {
212 INSERT INTO reporter.schedule (
224 VALUES ( ?, ?, ?, ?::TIMESTAMPTZ + ?, ?, ?, ?, ?, ?, ?, ? );
234 $r->{report}->{recurance},
245 $dbh->do(<<' SQL',{}, $r->{id});
246 UPDATE reporter.schedule
247 SET complete_time = now()
253 my $new_r = $dbh->selectrow_hashref(<<" SQL", {}, $r->{id});
254 SELECT * FROM reporter.schedule WHERE id = ?;
257 $r->{start_time} = $new_r->{start_time};
258 $r->{complete_time} = $new_r->{complete_time};
266 $r->{error_text} = ''.$e;
267 if (!$dbh->{AutoCommit}) {
270 $dbh->do(<<' SQL',{}, $e, $r->{id});
271 UPDATE reporter.schedule
273 complete_time = now(),
278 my $new_r = $dbh->selectrow_hashref(<<" SQL", {}, $r->{id});
279 SELECT * FROM reporter.schedule WHERE id = ?;
282 $r->{error_text} = $new_r->{error_text};
283 $r->{complete_time} = $new_r->{complete_time};
293 exit; # leave the child
298 POSIX::waitpid( -1, POSIX::WNOHANG );
299 sleep $sleep_interval;
303 #-------------------------------------------------------------------
307 open F, $success_template;
308 my $tmpl = join('',<F>);
311 my $url = $base_uri . '/' .
312 $r->{report}->{template}->{id} . '/' .
313 $r->{report}->{id} . '/' .
314 $r->{id} . '/report-data.html';
316 $tmpl =~ s/{TO}/$r->{email}/smog;
317 $tmpl =~ s/{FROM}/$email_sender/smog;
318 $tmpl =~ s/{REPLY_TO}/$email_sender/smog;
319 $tmpl =~ s/{REPORT_NAME}/$r->{report}->{template}->{name} -- $r->{report}->{name}/smog;
320 $tmpl =~ s/{RUN_TIME}/$r->{run_time}/smog;
321 $tmpl =~ s/{COMPLETE_TIME}/$r->{complete_time}/smog;
322 $tmpl =~ s/{OUTPUT_URL}/$url/smog;
324 my $sender = Email::Send->new({mailer => 'SMTP'});
325 $sender->mailer_args([Host => $email_server]);
326 $sender->send($tmpl);
331 open F, $fail_template;
332 my $tmpl = join('',<F>);
335 my $sql = $r->{resultset}->toSQL;
337 $tmpl =~ s/{TO}/$r->{email}/smog;
338 $tmpl =~ s/{FROM}/$email_sender/smog;
339 $tmpl =~ s/{REPLY_TO}/$email_sender/smog;
340 $tmpl =~ s/{REPORT_NAME}/$r->{report}->{template}->{name} -- $r->{report}->{name}/smog;
341 $tmpl =~ s/{RUN_TIME}/$r->{run_time}/smog;
342 $tmpl =~ s/{ERROR_TEXT}/$r->{error_text}/smog;
343 $tmpl =~ s/{SQL}/$sql/smog;
345 my $sender = Email::Send->new({mailer => 'SMTP'});
346 $sender->mailer_args([Host => $email_server]);
347 $sender->send($tmpl);
354 my $csv = Text::CSV_XS->new({ always_quote => 1, eol => "\015\012" });
356 return unless ($csv);
358 my $f = new FileHandle (">$file");
360 $csv->print($f, $r->{column_labels});
361 $csv->print($f, $_) for (@{$r->{data}});
368 my $xls = Spreadsheet::WriteExcel::Big->new($file);
370 my $sheetname = substr($r->{report}->{name},1,31);
371 $sheetname =~ s/\W/_/gos;
373 my $sheet = $xls->add_worksheet($sheetname);
375 $sheet->write_row('A1', $r->{column_labels});
377 $sheet->write_col('A2', $r->{data});
386 my $index = new FileHandle (">$file");
389 print $index <<" HEADER";
392 <title>$$r{report}{name}</title>
394 table { border-collapse: collapse; }
395 th { background-color: lightgray; }
396 td,th { border: solid black 1px; }
397 * { font-family: sans-serif; font-size: 10px; }
402 <h2><u>$$r{report}{name}</u></h2>
403 $$r{report}{description}<br/><br/><br/>
408 # add a link to the raw output html
409 push @links, "<a href='report-data.html.raw.html'>Tabular Output</a>" if ($r->{html_format});
411 # add a link to the CSV output
412 push @links, "<a href='report-data.xls'>Excel Output</a>" if ($r->{excel_format});
414 # add a link to the CSV output
415 push @links, "<a href='report-data.csv'>CSV Output</a>" if ($r->{csv_format});
417 print $index join(' -- ', @links);
418 print $index "<br/><br/><br/><br/></center>";
420 if ($r->{html_format}) {
421 # create the raw output html file
422 my $raw = new FileHandle (">$file.raw.html");
423 print $raw "<html><head><title>$$r{report}{name}</title>";
427 table { border-collapse: collapse; }
428 th { background-color: lightgray; }
429 td,th { border: solid black 1px; }
430 * { font-family: sans-serif; font-size: 10px; }
434 print $raw "</head><body><table>";
437 print $raw "<tr><th>".join('</th><th>',@{$r->{column_labels}}).'</th></tr>';
438 print $raw "<tr><td>".join('</td><td>',@$_ ).'</td></tr>' for (@{$r->{data}});
441 print $raw '</table></body></html>';
446 # Time for a pie chart
447 if ($r->{chart_pie}) {
448 my $pics = draw_pie($r, $file);
449 for my $pic (@$pics) {
450 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
454 print $index '<br/><br/><br/><br/>';
455 # Time for a bar chart
456 if ($r->{chart_bar}) {
457 my $pics = draw_bars($r, $file);
458 for my $pic (@$pics) {
459 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
463 print $index '<br/><br/><br/><br/>';
464 # Time for a bar chart
465 if ($r->{chart_line}) {
466 my $pics = draw_lines($r, $file);
467 for my $pic (@$pics) {
468 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
473 print $index '</body></html>';
482 my $data = $r->{data};
484 my @groups = @{ $r->{group_by_list} };
486 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
487 delete @values[@groups];
489 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
492 for my $vcol (@values) {
493 next unless (defined $vcol);
495 my @pic_data = ([],[]);
496 for my $row (@$data) {
497 next if (!defined($$row[$vcol]) || $$row[$vcol] == 0);
498 my $val = $$row[$vcol];
499 push @{$pic_data[0]}, join(" -- ", @$row[@groups])." ($val)";
500 push @{$pic_data[1]}, $val;
503 next unless (@{$pic_data[0]});
506 my $split = int(scalar(@{$pic_data[0]}) / $size);
507 my $last = scalar(@{$pic_data[0]}) % $size;
509 for my $sub_graph (0 .. $split) {
511 if ($sub_graph == $split) {
516 for my $set (@pic_data) {
517 push @sub_data, [ splice(@$set,0,$size) ];
520 my $pic = new GD::Graph::pie;
523 label => $r->{column_labels}->[$vcol],
525 legend_placement => 'R',
527 #logo_position => 'TL',
532 my $format = $pic->export_format;
534 open(IMG, ">$file.pie.$vcol.$sub_graph.$format");
539 $pic->plot(\@sub_data) or die $pic->error;
540 print IMG $pic->gd->$format;
543 warn "Couldn't draw $file.pie.$vcol.$sub_graph.$format : $e";
551 { file => "pie.$vcol.$sub_graph.$format",
552 name => $r->{column_labels}->[$vcol].' (Pie)',
553 } unless ($forgetit);
555 last if ($sub_graph == $split);
566 my $data = $r->{data};
568 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
570 my @groups = @{ $r->{group_by_list} };
573 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
574 splice(@values,$_,1) for (reverse @groups);
578 for my $row (@$data) {
579 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
589 for my $vcol (@values) {
590 next unless (defined $vcol);
591 $pic_data[$set] ||= [];
594 for my $row (@$data) {
595 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
596 push @{$pic_data[$set]}, $val;
597 $max_y = $val if ($val > $max_y);
598 $trim_candidates{$pos}++ if ($val == 0);
604 my $set_count = scalar(@pic_data) - 1;
605 my @trim_cols = grep { $trim_candidates{$_} == $set_count } keys %trim_candidates;
611 for my $dataset (@pic_data) {
612 splice(@$dataset,$_,1) for (reverse sort @trim_cols);
614 if (grep { $_ } @$dataset) {
615 push @new_data, $dataset;
616 push @use_me, $set_index if ($set_index > 0);
618 push @no_use, $set_index;
624 return [] unless ($new_data[0] && @{$new_data[0]});
626 for my $col (@use_me) {
627 push @leg, $r->{column_labels}->[$values[$col - 1]];
630 my $w = 100 + 10 * scalar(@{$new_data[0]});
631 $w = 400 if ($w < 400);
633 my $h = 10 * (scalar(@new_data) / 2);
637 my $pic = new GD::Graph::bars3d ($w + 250, $h + 500);
640 title => $r->{report}{name},
641 x_labels_vertical => 1,
645 y_max_value => $max_y,
646 legend_placement => 'TR',
649 #logo_position => 'R',
654 $pic->set_legend(@leg);
656 my $format = $pic->export_format;
658 open(IMG, ">$file.bar.$format");
662 $pic->plot(\@new_data) or die $pic->error;
663 print IMG $pic->gd->$format;
666 warn "Couldn't draw $file.bar.$format : $e";
671 return [{ file => "bar.$format",
672 name => $r->{report}{name}.' (Bar)',
680 my $data = $r->{data};
682 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
684 my @groups = @{ $r->{group_by_list} };
686 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
687 splice(@values,$_,1) for (reverse @groups);
691 for my $row (@$data) {
692 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
700 for my $vcol (@values) {
701 next unless (defined $vcol);
702 $pic_data[$set] ||= [];
705 for my $row (@$data) {
706 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
707 push @{$pic_data[$set]}, $val;
708 $max_y = $val if ($val > $max_y);
713 my $set_count = scalar(@pic_data) - 1;
719 for my $dataset (@pic_data) {
721 if (grep { $_ } @$dataset) {
722 push @new_data, $dataset;
723 push @use_me, $set_index if ($set_index > 0);
725 push @no_use, $set_index;
731 for my $col (@use_me) {
732 push @leg, $r->{column_labels}->[$values[$col - 1]];
735 my $w = 100 + 10 * scalar(@{$new_data[0]});
736 $w = 400 if ($w < 400);
738 my $h = 10 * (scalar(@new_data) / 2);
742 my $pic = new GD::Graph::lines3d ($w + 250, $h + 500);
745 title => $r->{report}{name},
746 x_labels_vertical => 1,
749 y_max_value => $max_y,
750 legend_placement => 'TR',
753 #logo_position => 'R',
758 $pic->set_legend(@leg);
760 my $format = $pic->export_format;
762 open(IMG, ">$file.line.$format");
766 $pic->plot(\@new_data) or die $pic->error;
767 print IMG $pic->gd->$format;
770 warn "Couldn't draw $file.line.$format : $e";
775 return [{ file => "line.$format",
776 name => $r->{report}{name}.' (Bar)',
784 my $pivot_label = shift;
785 my $pivot_data = shift;
787 $default = 0 unless (defined $default);
789 my $data = $$blob{data};
790 my $cols = $$blob{columns};
792 my @keep_labels = @$cols;
793 splice(@keep_labels, $_ - 1, 1) for (reverse sort ($pivot_label, $pivot_data));
795 my @keep_cols = (0 .. @$cols - 1);
796 splice(@keep_cols, $_ - 1, 1) for (reverse sort ($pivot_label, $pivot_data));
798 my @gb = ( 0 .. @keep_cols - 1);
800 #first, find the unique list of pivot values
802 for my $row (@$data) {
803 $tmp{ $$row[$pivot_label - 1] } = 1;
805 my @new_cols = sort keys %tmp;
807 tie my %split_data, 'Tie::IxHash';
808 for my $row (@$data) {
810 my $row_fp = ''. join('', map { defined($$row[$_]) ? $$row[$_] : '' } @keep_cols);
811 $split_data{$row_fp} ||= [];
813 push @{ $split_data{$row_fp} }, $row;
817 #now loop over the data, building a new result set
818 tie my %new_data, 'Tie::IxHash';
820 for my $fp ( keys %split_data ) {
824 for my $col (@keep_cols) {
825 push @{ $new_data{$fp} }, $split_data{$fp}[0][$col];
828 for my $col (@new_cols) {
830 my ($datum) = map { $_->[$pivot_data - 1] } grep { $_->[$pivot_label - 1] eq $col } @{ $split_data{$fp} };
832 push @{ $new_data{$fp} }, $datum;
836 push @keep_labels, @new_cols;
838 return { columns => \@keep_labels, data => [ values %new_data ], group_by_list => \@gb };