Open-ILS/src/reporter/clark-kent.pl

   1 #!/usr/bin/perl
   2 # vim:ts=4:noet:
   3
   4 use strict;
   5 use DBI;
   6 use FileHandle;
   7 use XML::LibXML;
   8 use Getopt::Long;
   9 use DateTime;
  10 use DateTime::Format::ISO8601;
  11 use Data::Dumper;
  12 use Text::CSV_XS;
  13 use Excel::Writer::XLSX;
  14 use OpenSRF::EX qw/:try/;
  15 use OpenSRF::Utils qw/:daemon/;
  16 use OpenSRF::Utils::JSON;
  17 use OpenSRF::Utils::Logger qw/$logger/;
  18 use OpenSRF::System;
  19 use OpenSRF::AppSession;
  20 use OpenSRF::Utils::SettingsClient;
  21 use OpenILS::Reporter::SQLBuilder;
  22 use POSIX;
  23 use GD::Graph::pie;
  24 use GD::Graph::bars3d;
  25 use GD::Graph::lines3d;
  26 use Tie::IxHash;
  27 use Email::Send;
  28
  29 use open ':utf8';
  30
  31
  32 my ($count, $config, $sleep_interval, $lockfile, $daemon) = (1, 'SYSCONFDIR/opensrf_core.xml', 10, '/tmp/reporter-LOCK');
  33
  34 GetOptions(
  35         "daemon"        => \$daemon,
  36         "sleep=i"       => \$sleep_interval,
  37         "concurrency=i" => \$count,
  38         "bootstrap|boostrap=s"  => \$config,
  39         "lockfile=s"    => \$lockfile,
  40 );
  41
  42 if (-e $lockfile) {
  43         die "I seem to be running already. If not, remove $lockfile and try again\n";
  44 }
  45
  46 OpenSRF::System->bootstrap_client( config_file => $config );
  47
  48 my (%data_db, %state_db);
  49
  50 my $sc = OpenSRF::Utils::SettingsClient->new;
  51
  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};
  59 }
  60 $data_db{db_user}   = $sc->config_value( reporter => setup => database => 'user' );
  61 $data_db{db_pw}     = $sc->config_value( reporter => setup => database => 'pw' );
  62
  63
  64
  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};
  72 }
  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};
  75
  76
  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});
  80
  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' );
  85 my $output_base      = $sc->config_value( reporter => setup => files => 'output_base' );
  86 my $base_uri         = $sc->config_value( reporter => setup => 'base_uri' );
  87
  88 my $state_dsn = "dbi:" . $state_db{db_driver} . ":dbname=" . $state_db{db_name} .';host=' . $state_db{db_host} . ';port=' . $state_db{db_port};
  89 my $data_dsn  = "dbi:" .  $data_db{db_driver} . ":dbname=" .  $data_db{db_name} .';host=' .  $data_db{db_host} . ';port=' .  $data_db{db_port};
  90
  91 my ($dbh,$running,$sth,@reports,$run, $current_time);
  92
  93 if ($daemon) {
  94         open(F, ">$lockfile") or die "Cannot write lockfile '$lockfile'";
  95         print F $$;
  96         close F;
  97         daemonize("Clark Kent, waiting for trouble");
  98 }
  99
 100
 101 DAEMON:
 102
 103 $dbh = DBI->connect(
 104         $state_dsn,
 105         $state_db{db_user},
 106         $state_db{db_pw},
 107         { AutoCommit => 1,
 108           pg_expand_array => 0,
 109           pg_enable_utf8 => 1,
 110           RaiseError => 1
 111         }
 112 );
 113
 114 $current_time = DateTime->from_epoch( epoch => time() )->strftime('%FT%T%z');
 115
 116 # make sure we're not already running $count reports
 117 ($running) = $dbh->selectrow_array(<<SQL);
 118 SELECT  count(*)
 119   FROM  reporter.schedule
 120   WHERE start_time IS NOT NULL AND complete_time IS NULL;
 121 SQL
 122
 123 if ($count <= $running) {
 124         if ($daemon) {
 125                 $dbh->disconnect;
 126                 sleep 1;
 127                 POSIX::waitpid( -1, POSIX::WNOHANG );
 128                 sleep $sleep_interval;
 129                 goto DAEMON;
 130         }
 131         print "Already running maximum ($running) concurrent reports\n";
 132         exit 1;
 133 }
 134
 135 # if we have some open slots then generate the sql
 136 $run = $count - $running;
 137
 138 $sth = $dbh->prepare(<<SQL);
 139 SELECT  *
 140   FROM  reporter.schedule
 141   WHERE start_time IS NULL AND run_time < NOW()
 142   ORDER BY run_time
 143   LIMIT $run;
 144 SQL
 145
 146 $sth->execute;
 147
 148 @reports = ();
 149 while (my $r = $sth->fetchrow_hashref) {
 150         my $s3 = $dbh->selectrow_hashref(<<"    SQL", {}, $r->{report});
 151                 SELECT * FROM reporter.report WHERE id = ?;
 152         SQL
 153
 154         my $s2 = $dbh->selectrow_hashref(<<"    SQL", {}, $s3->{template});
 155                 SELECT * FROM reporter.template WHERE id = ?;
 156         SQL
 157
 158         $s3->{template} = $s2;
 159         $r->{report} = $s3;
 160
 161         my $b = OpenILS::Reporter::SQLBuilder->new;
 162         my $report_data = OpenSRF::Utils::JSON->JSON2perl( $r->{report}->{data} );
 163         $b->register_params( $report_data );
 164
 165         $r->{resultset} = $b->parse_report( OpenSRF::Utils::JSON->JSON2perl( $r->{report}->{template}->{data} ) );
 166         $r->{resultset}->set_pivot_data($report_data->{__pivot_data}) if $report_data->{__pivot_data};
 167         $r->{resultset}->set_pivot_label($report_data->{__pivot_label}) if $report_data->{__pivot_label};
 168         $r->{resultset}->set_pivot_default($report_data->{__pivot_default}) if $report_data->{__pivot_default};
 169         $r->{resultset}->relative_time($r->{run_time});
 170         push @reports, $r;
 171 }
 172
 173 $sth->finish;
 174
 175 $dbh->disconnect;
 176
 177 # Now we spawn the report runners
 178
 179 for my $r ( @reports ) {
 180         next if (safe_fork());
 181
 182         # This is the child (runner) process;
 183         daemonize("Clark Kent reporting: $r->{report}->{name}");
 184
 185         my $state_dbh = DBI->connect(
 186                 $state_dsn,
 187                 $state_db{db_user},
 188                 $state_db{db_pw},
 189                 { AutoCommit => 1,
 190                   pg_expand_array => 0,
 191                   pg_enable_utf8 => 1,
 192                   RaiseError => 1
 193                 }
 194         );
 195
 196         my $data_dbh = DBI->connect(
 197                 $data_dsn,
 198                 $data_db{db_user},
 199                 $data_db{db_pw},
 200                 { AutoCommit => 1,
 201                   pg_expand_array => 0,
 202                   pg_enable_utf8 => 1,
 203                   RaiseError => 1
 204                 }
 205         );
 206
 207         try {
 208                 $state_dbh->do(<<'              SQL',{}, $r->{id});
 209                         UPDATE  reporter.schedule
 210                           SET   start_time = now()
 211                           WHERE id = ?;
 212                 SQL
 213
 214             $logger->debug('Report SQL: ' . $r->{resultset}->toSQL);
 215                 $sth = $data_dbh->prepare($r->{resultset}->toSQL);
 216
 217                 $sth->execute;
 218                 $r->{data} = $sth->fetchall_arrayref;
 219
 220                 $r->{column_labels} = [$r->{resultset}->column_label_list];
 221
 222                 if ($r->{resultset}->pivot_data && $r->{resultset}->pivot_label) {
 223                         my @labels = $r->{resultset}->column_label_list;
 224                         my $newdata = pivot_data(
 225                                 { columns => $r->{column_labels}, data => $r->{data}},
 226                                 $r->{resultset}->pivot_label,
 227                                 $r->{resultset}->pivot_data,
 228                                 $r->{resultset}->pivot_default
 229                         );
 230
 231                         $r->{column_labels} = $newdata->{columns};
 232                         $r->{data} = $newdata->{data};
 233                         $r->{group_by_list} = $newdata->{group_by_list};
 234                 } else {
 235                         $r->{group_by_list} = [$r->{resultset}->group_by_list(0)];
 236                 }
 237
 238                 my $s2 = $r->{report}->{template}->{id};
 239                 my $s3 = $r->{report}->{id};
 240                 my $output = $r->{id};
 241
 242                 mkdir($output_base);
 243                 mkdir("$output_base/$s2");
 244                 mkdir("$output_base/$s2/$s3");
 245                 mkdir("$output_base/$s2/$s3/$output");
 246
 247                 my $output_dir = "$output_base/$s2/$s3/$output";
 248
 249                 if ( $r->{csv_format} ) {
 250                         build_csv("$output_dir/report-data.csv", $r);
 251                 }
 252
 253                 if ( $r->{excel_format} ) {
 254                         build_excel("$output_dir/report-data.xlsx", $r);
 255                 }
 256
 257                 build_html("$output_dir/report-data.html", $r);
 258
 259                 $state_dbh->begin_work;
 260
 261                 if ($r->{report}->{recur} ) {
 262                         my $sql = <<'                   SQL';
 263                                 INSERT INTO reporter.schedule (
 264                                                 report,
 265                                                 folder,
 266                                                 runner,
 267                                                 run_time,
 268                                                 email,
 269                                                 csv_format,
 270                                                 excel_format,
 271                                                 html_format,
 272                                                 chart_pie,
 273                                                 chart_bar,
 274                                                 chart_line )
 275                                         VALUES ( ?, ?, ?, ?::TIMESTAMPTZ + ?, ?, ?, ?, ?, ?, ?, ? );
 276                         SQL
 277
 278                         $state_dbh->do(
 279                                 $sql,
 280                                 {},
 281                                 $r->{report}->{id},
 282                                 $r->{folder},
 283                                 $r->{runner},
 284                                 $r->{run_time},
 285                                 $r->{report}->{recurrence},
 286                                 $r->{email},
 287                                 $r->{csv_format},
 288                                 $r->{excel_format},
 289                                 $r->{html_format},
 290                                 $r->{chart_pie},
 291                                 $r->{chart_bar},
 292                                 $r->{chart_line},
 293                         );
 294                 }
 295
 296                 $state_dbh->do(<<'              SQL',{}, $r->{id});
 297                         UPDATE  reporter.schedule
 298                           SET   complete_time = now()
 299                           WHERE id = ?;
 300                 SQL
 301
 302                 $state_dbh->commit;
 303
 304                 my $new_r = $state_dbh->selectrow_hashref(<<"           SQL", {}, $r->{id});
 305                         SELECT * FROM reporter.schedule WHERE id = ?;
 306                 SQL
 307
 308                 $r->{start_time}    = $new_r->{start_time};
 309                 $r->{complete_time} = $new_r->{complete_time};
 310
 311                 if ($r->{email}) {
 312                         send_success($r);
 313                 }
 314
 315         } otherwise {
 316                 my $e = shift;
 317                 $r->{error_text} = ''.$e;
 318                 if (!$state_dbh->{AutoCommit}) {
 319                         $state_dbh->rollback;
 320                 }
 321                 $state_dbh->do(<<'              SQL',{}, $e, $r->{id});
 322                         UPDATE  reporter.schedule
 323                           SET   error_text = ?,
 324                                 complete_time = now(),
 325                                 error_code = 1
 326                           WHERE id = ?;
 327                 SQL
 328
 329                 my $new_r = $state_dbh->selectrow_hashref(<<"           SQL", {}, $r->{id});
 330                         SELECT * FROM reporter.schedule WHERE id = ?;
 331                 SQL
 332
 333                 $r->{error_text}    = $new_r->{error_text};
 334                 $r->{complete_time} = $new_r->{complete_time};
 335
 336                 if ($r->{email}) {
 337                         send_fail($r);
 338                 }
 339
 340         };
 341
 342         $state_dbh->disconnect;
 343         $data_dbh->disconnect;
 344
 345         exit; # leave the child
 346 }
 347
 348 if ($daemon) {
 349         sleep 1;
 350         POSIX::waitpid( -1, POSIX::WNOHANG );
 351         sleep $sleep_interval;
 352         goto DAEMON;
 353 }
 354
 355 #-------------------------------------------------------------------
 356
 357 sub send_success {
 358         my $r = shift;
 359         open F, $success_template or die "Cannot read '$success_template'";
 360         my $tmpl = join('',<F>);
 361         close F;
 362
 363         my $url = $base_uri . '/' .
 364                 $r->{report}->{template}->{id} . '/' .
 365                 $r->{report}->{id} . '/' .
 366                 $r->{id} . '/report-data.html';
 367
 368         $tmpl =~ s/{TO}/$r->{email}/smog;
 369         $tmpl =~ s/{FROM}/$email_sender/smog;
 370         $tmpl =~ s/{REPLY_TO}/$email_sender/smog;
 371         $tmpl =~ s/{REPORT_NAME}/$r->{report}->{name} -- $r->{report}->{template}->{name}/smog;
 372         $tmpl =~ s/{RUN_TIME}/$r->{run_time}/smog;
 373         $tmpl =~ s/{COMPLETE_TIME}/$r->{complete_time}/smog;
 374         $tmpl =~ s/{OUTPUT_URL}/$url/smog;
 375
 376         my $sender = Email::Send->new({mailer => 'SMTP'});
 377         $sender->mailer_args([Host => $email_server]);
 378         $sender->send($tmpl);
 379 }
 380
 381 sub send_fail {
 382         my $r = shift;
 383         open F, $fail_template or die "Cannot read '$fail_template'";
 384         my $tmpl = join('',<F>);
 385         close F;
 386
 387         my $sql = $r->{resultset}->toSQL;
 388
 389         $tmpl =~ s/{TO}/$r->{email}/smog;
 390         $tmpl =~ s/{FROM}/$email_sender/smog;
 391         $tmpl =~ s/{REPLY_TO}/$email_sender/smog;
 392         $tmpl =~ s/{REPORT_NAME}/$r->{report}->{name} -- $r->{report}->{template}->{name}/smog;
 393         $tmpl =~ s/{RUN_TIME}/$r->{run_time}/smog;
 394         $tmpl =~ s/{ERROR_TEXT}/$r->{error_text}/smog;
 395         $tmpl =~ s/{SQL}/$sql/smog;
 396
 397         my $sender = Email::Send->new({mailer => 'SMTP'});
 398         $sender->mailer_args([Host => $email_server]);
 399         $sender->send($tmpl);
 400 }
 401
 402 sub build_csv {
 403         my $file = shift;
 404         my $r = shift;
 405
 406         my $csv = Text::CSV_XS->new({ always_quote => 1, eol => "\015\012" });
 407
 408         return unless ($csv);
 409
 410         my $f = new FileHandle (">$file") or die "Cannot write to '$file'";
 411
 412         $csv->print($f, $r->{column_labels});
 413         $csv->print($f, $_) for (@{$r->{data}});
 414
 415         $f->close;
 416 }
 417 sub build_excel {
 418         my $file = shift;
 419         my $r = shift;
 420         my $xls = Excel::Writer::XLSX->new($file);
 421
 422         my $sheetname = substr($r->{report}->{name},0,30);
 423         $sheetname =~ s/\W/_/gos;
 424
 425         my $sheet = $xls->add_worksheet($sheetname);
 426         # don't try to write formulas, just write anything that starts with = as a text cell
 427         $sheet->add_write_handler(qr/^=/, sub { return shift->write_string(@_); } );
 428
 429         $sheet->write_row('A1', $r->{column_labels});
 430
 431         $sheet->write_col('A2', $r->{data});
 432
 433         $xls->close;
 434 }
 435
 436 sub build_html {
 437         my $file = shift;
 438         my $r = shift;
 439
 440         my $index = new FileHandle (">$file") or die "Cannot write to '$file'";
 441
 442         # index header
 443         print $index <<"        HEADER";
 444 <html>
 445         <head>
 446                 <meta charset='utf-8'>
 447                 <title>$$r{report}{name}</title>
 448                 <style>
 449                         table { border-collapse: collapse; }
 450                         th { background-color: lightgray; }
 451                         td,th { border: solid black 1px; }
 452                         * { font-family: sans-serif; font-size: 10px; }
 453                         .dim { color: lightblue; }
 454                 </style>
 455         </head>
 456         <body>
 457                 <center>
 458                 <h2><u>$$r{report}{name}</u></h2>
 459                 $$r{report}{description}<br/><br/><br/>
 460         HEADER
 461
 462         my @links;
 463
 464     my $br4 = '<br/>' x 4;
 465         # add a link to the raw output html
 466         push @links, "<a href='report-data.html.raw.html'>Tabular Output</a>" if ($r->{html_format});
 467
 468         # add a link to the CSV output
 469         push @links, "<a href='report-data.xlsx'>Excel Output</a>" if ($r->{excel_format});
 470
 471         # add a link to the CSV output
 472         push @links, "<a href='report-data.csv'>CSV Output</a>" if ($r->{csv_format});
 473
 474         # debugging output
 475         push @links, "<a class='dim' href='report-data.html.debug.html'>Debugging Info</a>";
 476
 477         my $debug = new FileHandle (">$file.debug.html") or die "Cannot write to '$file.debug.html'";
 478         print $debug "<html><head><meta charset='utf-8'><title>DEBUG: $$r{report}{name}</title></head><body>";
 479
 480         {       no warnings;
 481                 print $debug '<h1>Generated SQL</h1><pre>' . $r->{resultset}->toSQL() . "</pre><a href='report-data.html'>Back to output index</a><hr/>";
 482                 print $debug '<h1>Template</h1><pre>' . Dumper( $r->{report}->{template} ) . "</pre><a href='report-data.html'>Back to output index</a><hr/>";
 483                 print $debug '<h1>Template Data</h1><pre>' . Dumper( OpenSRF::Utils::JSON->JSON2perl( $r->{report}->{template}->{data} ) ) . "</pre><a href='report-data.html'>Back to output index</a><hr/>";
 484                 print $debug '<h1>Report Parameter</h1><pre>' . Dumper( $r->{report} ) . "</pre><a href='report-data.html'>Back to output index</a><hr/>";
 485                 print $debug '<h1>Report Parameter Data</h1><pre>' . Dumper( OpenSRF::Utils::JSON->JSON2perl( $r->{report}->{data} ) ) . "</pre><a href='report-data.html'>Back to output index</a><hr/>";
 486                 print $debug '<h1>Report Run Time</h1><pre>' . $r->{resultset}->relative_time . "</pre><a href='report-data.html'>Back to output index</a><hr/>";
 487                 print $debug '<h1>OpenILS::Reporter::SQLBuilder::ResultSet Object</h1><pre>' . Dumper( $r->{resultset} ) . "</pre><a href='report-data.html'>Back to output index</a>";
 488         }
 489
 490         print $debug '</body></html>';
 491
 492         $debug->close;
 493
 494         print $index join(' -- ', @links);
 495         print $index "$br4</center>";
 496
 497         if ($r->{html_format}) {
 498                 # create the raw output html file
 499                 my $raw = new FileHandle (">$file.raw.html") or die "Cannot write to '$file.raw.html'";
 500                 print $raw "<html><head><meta charset='utf-8'><title>$$r{report}{name}</title>";
 501
 502                 print $raw <<'          CSS';
 503                         <style>
 504                                 table { border-collapse: collapse; }
 505                                 th { background-color: lightgray; }
 506                                 td,th { border: solid black 1px; }
 507                                 * { font-family: sans-serif; font-size: 10px; }
 508                         </style>
 509                 CSS
 510
 511                 print $raw "</head><body><table>";
 512
 513                 {       no warnings;
 514                         print $raw "<tr><th>".join('</th><th>',@{$r->{column_labels}}).'</th></tr>';
 515                         print $raw "<tr><td>".join('</td><td>',@$_                   ).'</td></tr>' for (@{$r->{data}});
 516                 }
 517
 518                 print $raw '</table></body></html>';
 519
 520                 $raw->close;
 521         }
 522
 523         # Time for a pie chart
 524         if ($r->{chart_pie}) {
 525                 my $pics = draw_pie($r, $file);
 526                 for my $pic (@$pics) {
 527                         print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/>$br4";
 528                 }
 529         }
 530
 531         print $index $br4;
 532         # Time for a bar chart
 533         if ($r->{chart_bar}) {
 534                 my $pics = draw_bars($r, $file);
 535                 for my $pic (@$pics) {
 536                         print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/>$br4";
 537                 }
 538         }
 539
 540         print $index $br4;
 541         # Time for a bar chart
 542         if ($r->{chart_line}) {
 543                 my $pics = draw_lines($r, $file);
 544                 for my $pic (@$pics) {
 545                         print $index "<img src='report-data.html.$pic->{file}' alt='$pic->{name}'/>$br4";
 546                 }
 547         }
 548
 549         # and that's it!
 550         print $index '</body></html>';
 551
 552         $index->close;
 553 }
 554
 555 sub draw_pie {
 556         my $r = shift;
 557         my $file = shift;
 558
 559         my $data = $r->{data};
 560
 561         my @groups = @{ $r->{group_by_list} };
 562
 563         my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
 564         delete @values[@groups];
 565
 566         #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
 567
 568         my @pics;
 569         for my $vcol (@values) {
 570                 next unless (defined $vcol);
 571
 572                 my @pic_data = ([],[]);
 573                 for my $row (@$data) {
 574                         next if (!defined($$row[$vcol]) || $$row[$vcol] == 0);
 575                         my $val = $$row[$vcol];
 576                         push @{$pic_data[0]}, join(" -- ", @$row[@groups])." ($val)";
 577                         push @{$pic_data[1]}, $val;
 578                 }
 579
 580                 next unless (@{$pic_data[0]});
 581
 582                 my $size = 300;
 583                 my $split = int(scalar(@{$pic_data[0]}) / $size);
 584                 my $last = scalar(@{$pic_data[0]}) % $size;
 585
 586                 for my $sub_graph (0 .. $split) {
 587
 588                         if ($sub_graph == $split) {
 589                                 $size = $last;
 590                         }
 591
 592                         my @sub_data;
 593                         for my $set (@pic_data) {
 594                                 push @sub_data, [ splice(@$set,0,$size) ];
 595                         }
 596
 597                         my $pic = new GD::Graph::pie;
 598
 599                         $pic->set(
 600                                 label                   => $r->{column_labels}->[$vcol],
 601                                 start_angle             => 180,
 602                                 legend_placement        => 'R',
 603                                 #logo                   => $logo,
 604                                 #logo_position          => 'TL',
 605                                 #logo_resize            => 0.5,
 606                                 show_values             => 1,
 607                         );
 608
 609                         my $format = $pic->export_format;
 610
 611                         open(IMG, ">$file.pie.$vcol.$sub_graph.$format") or die "Cannot write '$file.pie.$vcol.$sub_graph.$format'";
 612                         binmode IMG;
 613
 614                         my $forgetit = 0;
 615                         try {
 616                                 $pic->plot(\@sub_data) or die $pic->error;
 617                                 print IMG $pic->gd->$format;
 618                         } otherwise {
 619                                 my $e = shift;
 620                                 warn "Couldn't draw $file.pie.$vcol.$sub_graph.$format : $e";
 621                                 $forgetit = 1;
 622                         };
 623
 624                         close IMG;
 625
 626
 627                         push @pics,
 628                                 { file => "pie.$vcol.$sub_graph.$format",
 629                                   name => $r->{column_labels}->[$vcol].' (Pie)',
 630                                 } unless ($forgetit);
 631
 632                         last if ($sub_graph == $split);
 633                 }
 634
 635         }
 636
 637         return \@pics;
 638 }
 639
 640 sub draw_bars {
 641         my $r = shift;
 642         my $file = shift;
 643         my $data = $r->{data};
 644
 645         #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
 646
 647         my @groups = @{ $r->{group_by_list} };
 648
 649
 650         my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
 651         splice(@values,$_,1) for (reverse @groups);
 652
 653         my @pic_data;
 654         {       no warnings;
 655                 for my $row (@$data) {
 656                         push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
 657                 }
 658         }
 659
 660         my @leg;
 661         my $set = 1;
 662
 663         my %trim_candidates;
 664
 665         my $max_y = 0;
 666         for my $vcol (@values) {
 667                 next unless (defined $vcol);
 668                 $pic_data[$set] ||= [];
 669
 670                 my $pos = 0;
 671                 for my $row (@$data) {
 672                         my $val = $$row[$vcol] ? $$row[$vcol] : 0;
 673                         push @{$pic_data[$set]}, $val;
 674                         $max_y = $val if ($val > $max_y);
 675                         $trim_candidates{$pos}++ if ($val == 0);
 676                         $pos++;
 677                 }
 678
 679                 $set++;
 680         }
 681         my $set_count = scalar(@pic_data) - 1;
 682         my @trim_cols = grep { $trim_candidates{$_} == $set_count } keys %trim_candidates;
 683
 684         my @new_data;
 685         my @use_me;
 686         my @no_use;
 687         my $set_index = 0;
 688         for my $dataset (@pic_data) {
 689                 splice(@$dataset,$_,1) for (reverse sort @trim_cols);
 690
 691                 if (grep { $_ } @$dataset) {
 692                         push @new_data, $dataset;
 693                         push @use_me, $set_index if ($set_index > 0);
 694                 } else {
 695                         push @no_use, $set_index;
 696                 }
 697                 $set_index++;
 698
 699         }
 700
 701         return [] unless ($new_data[0] && @{$new_data[0]});
 702
 703         for my $col (@use_me) {
 704                 push @leg, $r->{column_labels}->[$values[$col - 1]];
 705         }
 706
 707         my $w = 100 + 10 * scalar(@{$new_data[0]});
 708         $w = 400 if ($w < 400);
 709
 710         my $h = 10 * (scalar(@new_data) / 2);
 711
 712         $h = 0 if ($h < 0);
 713
 714         my $pic = new GD::Graph::bars3d ($w + 250, $h + 500);
 715
 716         $pic->set(
 717                 title                   => $r->{report}{name},
 718                 x_labels_vertical       => 1,
 719                 shading                 => 1,
 720                 bar_depth               => 5,
 721                 bar_spacing             => 2,
 722                 y_max_value             => $max_y,
 723                 legend_placement        => 'TR',
 724                 boxclr                  => 'lgray',
 725                 #logo                   => $logo,
 726                 #logo_position          => 'R',
 727                 #logo_resize            => 0.5,
 728                 show_values             => 1,
 729                 overwrite               => 1,
 730         );
 731         $pic->set_legend(@leg);
 732
 733         my $format = $pic->export_format;
 734
 735         open(IMG, ">$file.bar.$format") or die "Cannot write '$file.bar.$format'";
 736         binmode IMG;
 737
 738         try {
 739                 $pic->plot(\@new_data) or die $pic->error;
 740                 print IMG $pic->gd->$format;
 741         } otherwise {
 742                 my $e = shift;
 743                 warn "Couldn't draw $file.bar.$format : $e";
 744         };
 745
 746         close IMG;
 747
 748         return [{ file => "bar.$format",
 749                   name => $r->{report}{name}.' (Bar)',
 750                 }];
 751
 752 }
 753
 754 sub draw_lines {
 755         my $r    = shift;
 756         my $file = shift;
 757         my $data = $r->{data};
 758
 759         #my $logo = $doc->findvalue('/reporter/setup/files/chart_logo');
 760
 761         my @groups = @{ $r->{group_by_list} };
 762
 763         my @values = (0 .. (scalar(@{$r->{column_labels}}) - 1));
 764         splice(@values,$_,1) for (reverse @groups);
 765
 766         my @pic_data;
 767         {       no warnings;
 768                 for my $row (@$data) {
 769                         push @{$pic_data[0]}, join(' -- ', @$row[@groups]);
 770                 }
 771         }
 772
 773         my @leg;
 774         my $set = 1;
 775
 776         my $max_y = 0;
 777         for my $vcol (@values) {
 778                 next unless (defined $vcol);
 779                 $pic_data[$set] ||= [];
 780
 781
 782                 for my $row (@$data) {
 783                         my $val = $$row[$vcol] ? $$row[$vcol] : 0;
 784                         push @{$pic_data[$set]}, $val;
 785                         $max_y = $val if ($val > $max_y);
 786                 }
 787
 788                 $set++;
 789         }
 790         my $set_count = scalar(@pic_data) - 1;
 791
 792         my @new_data;
 793         my @use_me;
 794         my @no_use;
 795         my $set_index = 0;
 796         for my $dataset (@pic_data) {
 797
 798                 if (grep { $_ } @$dataset) {
 799                         push @new_data, $dataset;
 800                         push @use_me, $set_index if ($set_index > 0);
 801                 } else {
 802                         push @no_use, $set_index;
 803                 }
 804                 $set_index++;
 805
 806         }
 807
 808         return [] unless ($new_data[0] && @{$new_data[0]});
 809
 810         for my $col (@use_me) {
 811                 push @leg, $r->{column_labels}->[$values[$col - 1]];
 812         }
 813
 814         my $w = 100 + 10 * scalar(@{$new_data[0]});
 815         $w = 400 if ($w < 400);
 816
 817         my $h = 10 * (scalar(@new_data) / 2);
 818
 819         $h = 0 if ($h < 0);
 820
 821         my $pic = new GD::Graph::lines3d ($w + 250, $h + 500);
 822
 823         $pic->set(
 824                 title                   => $r->{report}{name},
 825                 x_labels_vertical       => 1,
 826                 shading                 => 1,
 827                 line_depth              => 5,
 828                 y_max_value             => $max_y,
 829                 legend_placement        => 'TR',
 830                 boxclr                  => 'lgray',
 831                 #logo                   => $logo,
 832                 #logo_position          => 'R',
 833                 #logo_resize            => 0.5,
 834                 show_values             => 1,
 835                 overwrite               => 1,
 836         );
 837         $pic->set_legend(@leg);
 838
 839         my $format = $pic->export_format;
 840
 841         open(IMG, ">$file.line.$format") or die "Cannot write '$file.line.$format'";
 842         binmode IMG;
 843
 844         try {
 845                 $pic->plot(\@new_data) or die $pic->error;
 846                 print IMG $pic->gd->$format;
 847         } otherwise {
 848                 my $e = shift;
 849                 warn "Couldn't draw $file.line.$format : $e";
 850         };
 851
 852         close IMG;
 853
 854         return [{ file => "line.$format",
 855                   name => $r->{report}{name}.' (Bar)',
 856                 }];
 857
 858 }
 859
 860
 861 sub pivot_data {
 862         my $blob        = shift;
 863         my $pivot_label = shift;
 864         my $pivot_data  = shift;
 865         my $default     = shift;
 866         $default = 0 unless (defined $default);
 867
 868         my $data = $$blob{data};
 869         my $cols = $$blob{columns};
 870
 871         my @keep_labels =  @$cols;
 872         splice(@keep_labels, $_ - 1, 1) for (reverse sort ($pivot_label, $pivot_data));
 873
 874         my @keep_cols = (0 .. @$cols - 1);
 875         splice(@keep_cols, $_ - 1, 1) for (reverse sort ($pivot_label, $pivot_data));
 876
 877         my @gb = ( 0 .. @keep_cols - 1);
 878
 879         #first, find the unique list of pivot values
 880         my %tmp;
 881         for my $row (@$data) {
 882                 $tmp{ $$row[$pivot_label - 1] } = 1;
 883         }
 884         my @new_cols = sort keys %tmp;
 885
 886         tie my %split_data, 'Tie::IxHash';
 887         for my $row (@$data) {
 888
 889                 my $row_fp = ''. join('', map { defined($$row[$_]) ? $$row[$_] : '' } @keep_cols);
 890                 $split_data{$row_fp} ||= [];
 891
 892                 push @{ $split_data{$row_fp} }, $row;
 893         }
 894
 895
 896         #now loop over the data, building a new result set
 897         tie my %new_data, 'Tie::IxHash';
 898
 899         for my $fp ( keys %split_data ) {
 900
 901                 $new_data{$fp} = [];
 902
 903                 for my $col (@keep_cols) {
 904                         push @{ $new_data{$fp} }, $split_data{$fp}[0][$col];
 905                 }
 906
 907                 for my $col (@new_cols) {
 908
 909                         my ($datum) = map { $_->[$pivot_data - 1] } grep { $_->[$pivot_label - 1] eq $col } @{ $split_data{$fp} };
 910                         $datum ||= $default;
 911                         push @{ $new_data{$fp} }, $datum;
 912                 }
 913         }
 914
 915         push @keep_labels, @new_cols;
 916
 917         return { columns => \@keep_labels, data => [ values %new_data ], group_by_list => \@gb };
 918 }
 919
 920