11 use DateTime::Format::ISO8601;
14 use Spreadsheet::WriteExcel::Big;
15 use OpenSRF::EX qw/:try/;
16 use OpenSRF::Utils qw/:daemon/;
17 use OpenSRF::Utils::JSON;
18 #use OpenSRF::Utils::Logger qw/:level/;
20 use OpenSRF::AppSession;
21 use OpenSRF::Utils::SettingsClient;
22 use OpenILS::Reporter::SQLBuilder;
25 use GD::Graph::bars3d;
26 use GD::Graph::lines3d;
33 my ($count, $config, $sleep_interval, $lockfile, $daemon) = (1, '/openils/conf/opensrf_core.xml', 10, '/tmp/reporter-LOCK');
37 "sleep=i" => \$sleep_interval,
38 "concurrency=i" => \$count,
39 "boostrap=s" => \$config,
40 "lockfile=s" => \$lockfile,
44 die "I seem to be running already. If not, remove $lockfile and try again\n";
47 OpenSRF::System->bootstrap_client( config_file => $config );
49 # XXX Get this stuff from the settings server
50 my $sc = OpenSRF::Utils::SettingsClient->new;
51 my $db_driver = $sc->config_value( reporter => setup => database => 'driver' );
52 my $db_host = $sc->config_value( reporter => setup => database => 'host' );
53 my $db_port = $sc->config_value( reporter => setup => database => 'port' );
54 my $db_name = $sc->config_value( reporter => setup => database => 'db' );
55 my $db_user = $sc->config_value( reporter => setup => database => 'user' );
56 my $db_pw = $sc->config_value( reporter => setup => database => 'password' );
58 die "Unable to retrieve database connection information from the settings server" unless ($db_driver && $db_host && $db_port && $db_name && $db_user);
60 my $email_server = $sc->config_value( email_notify => 'smtp_server' );
61 my $email_sender = $sc->config_value( email_notify => 'sender_address' );
62 my $success_template = $sc->config_value( reporter => setup => files => 'success_template' );
63 my $fail_template = $sc->config_value( reporter => setup => files => 'fail_template' );
65 my $output_base = $sc->config_value( reporter => setup => files => 'output_base' );
67 my $base_uri = $sc->config_value( reporter => setup => 'base_uri' );
69 my $dsn = "dbi:" . $db_driver . ":dbname=" . $db_name .';host=' . $db_host . ';port=' . $db_port;
71 my ($dbh,$running,$sth,@reports,$run, $current_time);
74 open(F, ">$lockfile");
77 daemonize("Clark Kent, waiting for trouble");
83 $dbh = DBI->connect($dsn,$db_user,$db_pw, {AutoCommit => 1, pg_enable_utf8 => 1, RaiseError => 1});
85 $current_time = DateTime->from_epoch( epoch => time() )->strftime('%FT%T%z');
87 # make sure we're not already running $count reports
88 ($running) = $dbh->selectrow_array(<<SQL);
90 FROM reporter.schedule
91 WHERE start_time IS NOT NULL AND complete_time IS NULL;
94 if ($count <= $running) {
98 POSIX::waitpid( -1, POSIX::WNOHANG );
99 sleep $sleep_interval;
102 print "Already running maximum ($running) concurrent reports\n";
106 # if we have some open slots then generate the sql
107 $run = $count - $running;
109 $sth = $dbh->prepare(<<SQL);
111 FROM reporter.schedule
112 WHERE start_time IS NULL AND run_time < NOW()
120 while (my $r = $sth->fetchrow_hashref) {
121 my $s3 = $dbh->selectrow_hashref(<<" SQL", {}, $r->{report});
122 SELECT * FROM reporter.report WHERE id = ?;
125 my $s2 = $dbh->selectrow_hashref(<<" SQL", {}, $s3->{template});
126 SELECT * FROM reporter.template WHERE id = ?;
129 $s3->{template} = $s2;
132 my $b = OpenILS::Reporter::SQLBuilder->new;
133 $b->register_params( OpenSRF::Utils::JSON->JSON2perl( $r->{report}->{data} ) );
135 $r->{resultset} = $b->parse_report( OpenSRF::Utils::JSON->JSON2perl( $r->{report}->{template}->{data} ) );
136 $r->{resultset}->relative_time($r->{run_time});
144 # Now we spawn the report runners
146 for my $r ( @reports ) {
147 next if (safe_fork());
149 # This is the child (runner) process;
150 daemonize("Clark Kent reporting: $r->{report}->{name}");
152 $dbh = DBI->connect($dsn,$db_user,$db_pw, {AutoCommit => 1, pg_enable_utf8 => 1, RaiseError => 1});
155 $dbh->do(<<' SQL',{}, $r->{id});
156 UPDATE reporter.schedule
157 SET start_time = now()
161 $sth = $dbh->prepare($r->{resultset}->toSQL);
164 $r->{data} = $sth->fetchall_arrayref;
166 $r->{column_labels} = [$r->{resultset}->column_label_list];
168 if ($r->{resultset}->pivot_data && $r->{resultset}->pivot_label) {
169 my @labels = $r->{resultset}->column_label_list;
170 my $newdata = pivot_data(
171 { columns => $r->{column_labels}, data => $r->{data}},
172 $r->{resultset}->pivot_label,
173 $r->{resultset}->pivot_data,
174 $r->{resultset}->pivot_default
177 $r->{column_labels} = $newdata->{columns};
178 $r->{data} = $newdata->{data};
179 $r->{group_by_list} = $newdata->{group_by_list};
181 $r->{group_by_list} = [$r->{resultset}->group_by_list(0)];
184 my $s2 = $r->{report}->{template}->{id};
185 my $s3 = $r->{report}->{id};
186 my $output = $r->{id};
189 mkdir("$output_base/$s2");
190 mkdir("$output_base/$s2/$s3");
191 mkdir("$output_base/$s2/$s3/$output");
193 my $output_dir = "$output_base/$s2/$s3/$output";
195 if ( $r->{csv_format} ) {
196 build_csv("$output_dir/report-data.csv", $r);
199 if ( $r->{excel_format} ) {
200 build_excel("$output_dir/report-data.xls", $r);
203 build_html("$output_dir/report-data.html", $r);
207 if ($r->{report}->{recur} ) {
209 INSERT INTO reporter.schedule (
221 VALUES ( ?, ?, ?, ?::TIMESTAMPTZ + ?, ?, ?, ?, ?, ?, ?, ? );
231 $r->{report}->{recurance},
242 $dbh->do(<<' SQL',{}, $r->{id});
243 UPDATE reporter.schedule
244 SET complete_time = now()
250 my $new_r = $dbh->selectrow_hashref(<<" SQL", {}, $r->{id});
251 SELECT * FROM reporter.schedule WHERE id = ?;
254 $r->{start_time} = $new_r->{start_time};
255 $r->{complete_time} = $new_r->{complete_time};
263 $r->{error_text} = ''.$e;
264 if (!$dbh->{AutoCommit}) {
267 $dbh->do(<<' SQL',{}, $e, $r->{id});
268 UPDATE reporter.schedule
270 complete_time = now(),
275 my $new_r = $dbh->selectrow_hashref(<<" SQL", {}, $r->{id});
276 SELECT * FROM reporter.schedule WHERE id = ?;
279 $r->{error_text} = $new_r->{error_text};
280 $r->{complete_time} = $new_r->{complete_time};
290 exit; # leave the child
295 POSIX::waitpid( -1, POSIX::WNOHANG );
296 sleep $sleep_interval;
300 #-------------------------------------------------------------------
304 open F, $success_template;
305 my $tmpl = join('',<F>);
308 my $url = $base_uri . '/' .
309 $r->{report}->{template}->{id} . '/' .
310 $r->{report}->{id} . '/' .
311 $r->{id} . '/report-data.html';
313 $tmpl =~ s/{TO}/$r->{email}/smog;
314 $tmpl =~ s/{FROM}/$email_sender/smog;
315 $tmpl =~ s/{REPLY_TO}/$email_sender/smog;
316 $tmpl =~ s/{REPORT_NAME}/$r->{report}->{template}->{name} -- $r->{report}->{name}/smog;
317 $tmpl =~ s/{RUN_TIME}/$r->{run_time}/smog;
318 $tmpl =~ s/{COMPLETE_TIME}/$r->{complete_time}/smog;
319 $tmpl =~ s/{OUTPUT_URL}/$url/smog;
321 my $sender = Email::Send->new({mailer => 'SMTP'});
322 $sender->mailer_args([Host => $email_server]);
323 $sender->send($tmpl);
328 open F, $fail_template;
329 my $tmpl = join('',<F>);
332 my $sql = $r->{resultset}->toSQL;
334 $tmpl =~ s/{TO}/$r->{email}/smog;
335 $tmpl =~ s/{FROM}/$email_sender/smog;
336 $tmpl =~ s/{REPLY_TO}/$email_sender/smog;
337 $tmpl =~ s/{REPORT_NAME}/$r->{report}->{template}->{name} -- $r->{report}->{name}/smog;
338 $tmpl =~ s/{RUN_TIME}/$r->{run_time}/smog;
339 $tmpl =~ s/{ERROR_TEXT}/$r->{error_text}/smog;
340 $tmpl =~ s/{SQL}/$sql/smog;
342 my $sender = Email::Send->new({mailer => 'SMTP'});
343 $sender->mailer_args([Host => $email_server]);
344 $sender->send($tmpl);
351 my $csv = Text::CSV_XS->new({ always_quote => 1, eol => "\015\012" });
353 return unless ($csv);
355 my $f = new FileHandle (">$file");
357 $csv->print($f, $r->{column_labels});
358 $csv->print($f, $_) for (@{$r->{data}});
365 my $xls = Spreadsheet::WriteExcel::Big->new($file);
367 my $sheetname = substr($r->{report}->{name},1,31);
368 $sheetname =~ s/\W/_/gos;
370 my $sheet = $xls->add_worksheet($sheetname);
372 $sheet->write_row('A1', $r->{column_labels});
374 $sheet->write_col('A2', $r->{data});
383 my $index = new FileHandle (">$file");
386 print $index <<" HEADER";
389 <title>$$r{report}{name}</title>
391 table { border-collapse: collapse; }
392 th { background-color: lightgray; }
393 td,th { border: solid black 1px; }
394 * { font-family: sans-serif; font-size: 10px; }
399 <h2><u>$$r{report}{name}</u></h2>
400 $$r{report}{description}<br/><br/><br/>
405 # add a link to the raw output html
406 push @links, "<a href='report-data.html.raw.html'>Tabular Output</a>" if ($r->{html_format});
408 # add a link to the CSV output
409 push @links, "<a href='report-data.xls'>Excel Output</a>" if ($r->{excel_format});
411 # add a link to the CSV output
412 push @links, "<a href='report-data.csv'>CSV Output</a>" if ($r->{csv_format});
414 print $index join(' -- ', @links);
415 print $index "<br/><br/><br/><br/></center>";
417 if ($r->{html_format}) {
418 # create the raw output html file
419 my $raw = new FileHandle (">$file.raw.html");
420 print $raw "<html><head><title>$$r{report}{name}</title>";
424 table { border-collapse: collapse; }
425 th { background-color: lightgray; }
426 td,th { border: solid black 1px; }
427 * { font-family: sans-serif; font-size: 10px; }
431 print $raw "</head><body><table>";
434 print $raw "<tr><th>".join('</th><th>',@{$r->{column_labels}}).'</th></tr>';
435 print $raw "<tr><td>".join('</td><td>',@$_ ).'</td></tr>' for (@{$r->{data}});
438 print $raw '</table></body></html>';
443 # Time for a pie chart
444 if ($r->{chart_pie}) {
445 my $pics = draw_pie($r, $file);
446 for my $pic (@$pics) {
447 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
451 print $index '<br/><br/><br/><br/>';
452 # Time for a bar chart
453 if ($r->{chart_bar}) {
454 my $pics = draw_bars($r, $file);
455 for my $pic (@$pics) {
456 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
460 print $index '<br/><br/><br/><br/>';
461 # Time for a bar chart
462 if ($r->{chart_line}) {
463 my $pics = draw_lines($r, $file);
464 for my $pic (@$pics) {
465 print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/><br/><br/><br/><br/>";
470 print $index '</body></html>';
479 my $data = $r->{data};
481 my @groups = @{ $r->{group_by_list} };
483 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
484 delete @values[@groups];
486 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
489 for my $vcol (@values) {
490 next unless (defined $vcol);
492 my @pic_data = ([],[]);
493 for my $row (@$data) {
494 next if (!defined($$row[$vcol]) || $$row[$vcol] == 0);
495 my $val = $$row[$vcol];
496 push @{$pic_data[0]}, join(" -- ", @$row[@groups])." ($val)";
497 push @{$pic_data[1]}, $val;
500 next unless (@{$pic_data[0]});
503 my $split = int(scalar(@{$pic_data[0]}) / $size);
504 my $last = scalar(@{$pic_data[0]}) % $size;
506 for my $sub_graph (0 .. $split) {
508 if ($sub_graph == $split) {
513 for my $set (@pic_data) {
514 push @sub_data, [ splice(@$set,0,$size) ];
517 my $pic = new GD::Graph::pie;
520 label => $r->{column_labels}->[$vcol],
522 legend_placement => 'R',
524 #logo_position => 'TL',
529 my $format = $pic->export_format;
531 open(IMG, ">$file.pie.$vcol.$sub_graph.$format");
536 $pic->plot(\@sub_data) or die $pic->error;
537 print IMG $pic->gd->$format;
540 warn "Couldn't draw $file.pie.$vcol.$sub_graph.$format : $e";
548 { file => "pie.$vcol.$sub_graph.$format",
549 name => $r->{column_labels}->[$vcol].' (Pie)',
550 } unless ($forgetit);
552 last if ($sub_graph == $split);
563 my $data = $r->{data};
565 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
567 my @groups = @{ $r->{group_by_list} };
570 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
571 splice(@values,$_,1) for (reverse @groups);
575 for my $row (@$data) {
576 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
586 for my $vcol (@values) {
587 next unless (defined $vcol);
588 $pic_data[$set] ||= [];
591 for my $row (@$data) {
592 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
593 push @{$pic_data[$set]}, $val;
594 $max_y = $val if ($val > $max_y);
595 $trim_candidates{$pos}++ if ($val == 0);
601 my $set_count = scalar(@pic_data) - 1;
602 my @trim_cols = grep { $trim_candidates{$_} == $set_count } keys %trim_candidates;
608 for my $dataset (@pic_data) {
609 splice(@$dataset,$_,1) for (reverse sort @trim_cols);
611 if (grep { $_ } @$dataset) {
612 push @new_data, $dataset;
613 push @use_me, $set_index if ($set_index > 0);
615 push @no_use, $set_index;
621 return [] unless ($new_data[0] && @{$new_data[0]});
623 for my $col (@use_me) {
624 push @leg, $r->{column_labels}->[$values[$col - 1]];
627 my $w = 100 + 10 * scalar(@{$new_data[0]});
628 $w = 400 if ($w < 400);
630 my $h = 10 * (scalar(@new_data) / 2);
634 my $pic = new GD::Graph::bars3d ($w + 250, $h + 500);
637 title => $r->{report}{name},
638 x_labels_vertical => 1,
642 y_max_value => $max_y,
643 legend_placement => 'TR',
646 #logo_position => 'R',
651 $pic->set_legend(@leg);
653 my $format = $pic->export_format;
655 open(IMG, ">$file.bar.$format");
659 $pic->plot(\@new_data) or die $pic->error;
660 print IMG $pic->gd->$format;
663 warn "Couldn't draw $file.bar.$format : $e";
668 return [{ file => "bar.$format",
669 name => $r->{report}{name}.' (Bar)',
677 my $data = $r->{data};
679 #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
681 my @groups = @{ $r->{group_by_list} };
683 my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
684 splice(@values,$_,1) for (reverse @groups);
688 for my $row (@$data) {
689 push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
697 for my $vcol (@values) {
698 next unless (defined $vcol);
699 $pic_data[$set] ||= [];
702 for my $row (@$data) {
703 my $val = $$row[$vcol] ? $$row[$vcol] : 0;
704 push @{$pic_data[$set]}, $val;
705 $max_y = $val if ($val > $max_y);
710 my $set_count = scalar(@pic_data) - 1;
716 for my $dataset (@pic_data) {
718 if (grep { $_ } @$dataset) {
719 push @new_data, $dataset;
720 push @use_me, $set_index if ($set_index > 0);
722 push @no_use, $set_index;
728 for my $col (@use_me) {
729 push @leg, $r->{column_labels}->[$values[$col - 1]];
732 my $w = 100 + 10 * scalar(@{$new_data[0]});
733 $w = 400 if ($w < 400);
735 my $h = 10 * (scalar(@new_data) / 2);
739 my $pic = new GD::Graph::lines3d ($w + 250, $h + 500);
742 title => $r->{report}{name},
743 x_labels_vertical => 1,
746 y_max_value => $max_y,
747 legend_placement => 'TR',
750 #logo_position => 'R',
755 $pic->set_legend(@leg);
757 my $format = $pic->export_format;
759 open(IMG, ">$file.line.$format");
763 $pic->plot(\@new_data) or die $pic->error;
764 print IMG $pic->gd->$format;
767 warn "Couldn't draw $file.line.$format : $e";
772 return [{ file => "line.$format",
773 name => $r->{report}{name}.' (Bar)',
781 my $pivot_label = shift;
782 my $pivot_data = shift;
784 $default = 0 unless (defined $default);
786 my $data = $$blob{data};
787 my $cols = $$blob{columns};
789 my @keep_labels = @$cols;
790 splice(@keep_labels, $_ - 1, 1) for (reverse sort ($pivot_label, $pivot_data));
792 my @keep_cols = (0 .. @$cols - 1);
793 splice(@keep_cols, $_ - 1, 1) for (reverse sort ($pivot_label, $pivot_data));
795 my @gb = ( 0 .. @keep_cols - 1);
797 #first, find the unique list of pivot values
799 for my $row (@$data) {
800 $tmp{ $$row[$pivot_label - 1] } = 1;
802 my @new_cols = sort keys %tmp;
804 tie my %split_data, 'Tie::IxHash';
805 for my $row (@$data) {
807 my $row_fp = ''. join('', map { defined($$row[$_]) ? $$row[$_] : '' } @keep_cols);
808 $split_data{$row_fp} ||= [];
810 push @{ $split_data{$row_fp} }, $row;
814 #now loop over the data, building a new result set
815 tie my %new_data, 'Tie::IxHash';
817 for my $fp ( keys %split_data ) {
821 for my $col (@keep_cols) {
822 push @{ $new_data{$fp} }, $split_data{$fp}[0][$col];
825 for my $col (@new_cols) {
827 my ($datum) = map { $_->[$pivot_data - 1] } grep { $_->[$pivot_label - 1] eq $col } @{ $split_data{$fp} };
829 push @{ $new_data{$fp} }, $datum;
833 push @keep_labels, @new_cols;
835 return { columns => \@keep_labels, data => [ values %new_data ], group_by_list => \@gb };