cleaned up docs
[migration-tools.git] / mig-bin / mig-reporter
index 9bea406..7ba239e 100755 (executable)
@@ -1,15 +1,19 @@
 #!/usr/bin/perl
-
+# -*- coding: iso-8859-15 -*-
 ###############################################################################
 =pod
 
-=item B<reporter> --analyst "Analyst Name" --report_title "Report Title"
+=item B<reporter> --title "Report Title"
 
 Generates an asciidoc file in the git working directory that can be converted to 
 any appropriate format.  The analyst and report parameters are required.
 
 Optional parameters are : 
 
+-- analyst
+
+Default to "Equinox Open Library Initiative"
+
 --added_page_title and --added_page_file 
 
 If one is used both must be.  The added page file can be plain text or asciidoc.  This
@@ -20,17 +24,18 @@ adds an extra arbitrary page of notes to the report.  Mig assumes the page file
 This will define a set of tags to use, if not set it will default to Circs, 
 Holds, Actors, Bibs, Assets & Money. 
 
---debug
+--debug on
 
-Gives more information about what is happening.
+Gives more information about what is happening. Defaults to off.
 
 --reports_xml 
 
 Allows you to override the default evergreen_staged_report.xml in the mig-xml folder.
 
---captions or --captions_off
+--captions on OR --captions off 
 
 Adds the captions tag to asciidoc header to turn off captions in generated output.
+Defaults to off.
 
 =back
 
@@ -50,6 +55,7 @@ use Env qw(
 );
 use Pod::Usage;
 use Switch;
+use Getopt::Long; 
 use Cwd 'abs_path';
 use Cwd qw(getcwd);
 use FindBin;
@@ -61,93 +67,34 @@ use open ':encoding(utf8)';
 pod2usage(-verbose => 2) if defined $ARGV[0] && $ARGV[0] eq '--help';
 pod2usage(-verbose => 1) if ! $ARGV[1];
 
-my $analyst;
-my $next_arg_is_analyst;
+my $analyst = 'Equinox Open Library Initiative';;
 my $report_title;
-my $next_arg_is_report_title;
-my $reports_xml;
-my $next_arg_is_reports_xml;
+my $reports_xml = 'evergreen_staged_report.xml';
 my $tags;
-my $next_arg_is_tags;
 my $added_page_title;
-my $next_arg_is_added_page_title;
 my $added_page_file;
-my $next_arg_is_added_page_file;
-my $captions_off = 0;
+my $captions = 'off';  
 my $i = 0;
 my $parser = XML::LibXML->new();
 my $lines_per_page = 42;
-my $debug_flag = 0;
+my $debug = 'off';
 my $workbook;
 my $fh;
 
-foreach my $arg (@ARGV) {
-    if ($arg eq '--report_title') {
-        $next_arg_is_report_title = 1;
-        next;
-    }
-    if ($next_arg_is_report_title) {
-        $report_title = $arg;
-        $next_arg_is_report_title = 0;
-        next;
-    }
-    if ($arg eq '--analyst') {
-        $next_arg_is_analyst = 1;
-        next;
-    }
-    if ($next_arg_is_analyst) {
-        $analyst = $arg;
-        $next_arg_is_analyst = 0;
-        next;
-    }
-    if ($arg eq '--reports_xml') {
-        $next_arg_is_reports_xml = 1;
-        next;
-    }
-    if ($next_arg_is_reports_xml) {
-        $reports_xml = $arg;
-        $next_arg_is_reports_xml = 0;
-        next;
-    }
-    if ($arg eq '--tags') {
-        $next_arg_is_tags = 1;
-        next;
-    }
-    if ($next_arg_is_tags) {
-        $tags = $arg;
-        $next_arg_is_tags = 0;
-        next;
-    }
-    if ($arg eq '--added_page_title') {
-        $next_arg_is_added_page_title = 1;
-        next;
-    }
-    if ($next_arg_is_added_page_title) {
-        $added_page_title = $arg;
-        $next_arg_is_added_page_title = 0;
-        next;
-    }
-    if ($arg eq '--added_page_file') {
-        $next_arg_is_added_page_file = 1;
-        next;
-    }
-    if ($next_arg_is_added_page_file) {
-        $added_page_file = $arg;
-        $next_arg_is_added_page_file = 0;
-        next;
-    }
-    if ($arg eq '--captions_off' or $arg eq '--captions') {
-        $captions_off = 1;
-        next;
-    }
-    if ($arg eq '--debug') {
-        $debug_flag = 1;
-        next;
-    }
-}
+my $ret = GetOptions(
+    'analyst:s'           => \$analyst,
+    'report_title:s'      => \$report_title,
+    'title:s'             => \$report_title,
+    'reports_xml:s'       => \$reports_xml,
+    'tags:s'              => \$tags,
+    'added_page_title:s'  => \$added_page_title,
+    'added_page_file:s'   => \$added_page_file,
+    'captions:s'          => \$captions,
+       'debug:s'             => \$debug
+);
 
 if (!defined $tags) {$tags = 'circs.holds.actors.bibs.assets.money.notices'};
-if (!defined $report_title) { abort('--report_title must be supplied'); }
+if (!defined $report_title) { abort('--report_title or --title must be supplied'); }
 if (!defined $analyst) { abort('--analyst must be supplied'); }
 
 my $mig_path = abs_path($0);
@@ -166,7 +113,8 @@ my $report_file = create_report_name($report_title);
 $report_file = $MIGGITDIR . $report_file;
 
 open($fh, '>', $report_file) or abort("Could not open output file $report_file!");
-write_title_page($report_title,$fh,$analyst,$captions_off);
+write_title_page($report_title,$fh,$analyst,$captions);
+load_javascript($fh);
 
 if (defined $added_page_file and defined $added_page_title) { 
     print $fh "<<<\n";
@@ -192,6 +140,18 @@ foreach my $func ($dom->findnodes('//function')) {
     $screate->execute();
 }
 
+foreach my $table ($dom->findnodes('//table')) {
+    my $tdrop = $table->findvalue('./drop');
+    my $tcreate = $table->findvalue('./create');
+    my $tname = $table->findvalue('./name');
+    my $sdrop = $dbh->prepare($tdrop);
+    my $screate = $dbh->prepare($tcreate);
+    print "dropping table $tname ... ";
+    $sdrop->execute();
+    print "creating table $tname\n\n";
+    $screate->execute();
+}
+
 $tags = lc($tags);
 my @report_tags = split(/\./,$tags);
 foreach my $t (@report_tags) {
@@ -242,13 +202,13 @@ foreach my $t (@report_tags) {
         my $check_tables0;
         my $check_tables1;
 
-        if ($debug_flag == 1) {print "\nchecking for $rname ... ";}
-        %report0 = find_report($dom,$t,$rname,'0',$debug_flag);
-        $check_tables0 = check_table($report0{query},$MIGSCHEMA,$debug_flag,$rname);
-        if ($check_tables0 == 1) { $r =  print_query($fh,%report0); } else {
-               %report1 = find_report($dom,$t,$rname,'1',$debug_flag);
+        if ($debug eq 'on') {print "\nchecking for $rname ... ";}
+        %report0 = find_report($dom,$t,$rname,'0',$debug);
+        $check_tables0 = check_table($report0{query},$MIGSCHEMA,$debug,$rname);
+        if ($check_tables0 == 1) { $r = print_query($fh,%report0); } else {
+               %report1 = find_report($dom,$t,$rname,'1',$debug);
             if (defined $report1{query}) {
-               $check_tables1 = check_table($report1{query},$MIGSCHEMA,$debug_flag,$rname);
+               $check_tables1 = check_table($report1{query},$MIGSCHEMA,$debug,$rname);
                        if ($check_tables1 == 1) { $r = print_query($fh,%report1); }
             }
         }
@@ -258,6 +218,14 @@ foreach my $t (@report_tags) {
 
 print "\n";
 
+foreach my $table ($dom->findnodes('//table')) {
+    my $tdrop = $table->findvalue('./drop');
+    my $tname = $table->findvalue('./name');
+    my $sdrop = $dbh->prepare($tdrop);
+    print "cleaning up table $tname ... \n";
+    $sdrop->execute();
+}
+
 close $fh;
 
 ############ end of main logic
@@ -283,13 +251,13 @@ sub find_report {
     my $tag = shift;
     my $name = shift;
     my $iteration = shift;
-    my $debug_flag = shift;
+    my $debug = shift;
     my %report;
 
-    if ($debug_flag == 1) {print "iteration $iteration ";}
+    if ($debug eq 'on') {print "iteration $iteration ";}
     foreach my $node ($dom->findnodes('//report')) {
         if ($node->findvalue('./tag') =~ $tag and $node->findvalue('./iteration') eq $iteration and $node->findvalue('./name') eq $name) {
-            if ($debug_flag == 1) {print "succeeded ... \n";}
+            if ($debug eq 'on') {print "succeeded ... \n";}
             %report = (
                 name => $node->findvalue('./name'),
                 report_title => $node->findvalue('./report_title'),
@@ -298,11 +266,15 @@ sub find_report {
                 tag => $node->findvalue('./tag'),
                 iteration => $node->findvalue('./iteration'),
                 note => $node->findvalue('./note'),
-            );
+                               display => $node->findvalue('./display'),
+                       chart_labels => $node->findvalue('./chart_labels'),
+                               divwidth => $node->findvalue('./divwidth'),
+                               divheight => $node->findvalue('./divheight'),
+               );
             return %report;
         }
     }
-    if ($debug_flag == 1) {print "failed ... \n";}
+    if ($debug eq 'on') {print "failed ... \n";}
     return %report = (
         name => "eaten by grue"
     );
@@ -336,7 +308,7 @@ sub write_title_page {
     my $rt = shift;
     my $fh = shift;
     my $a = shift;
-    my $captions_off = shift;
+    my $captions = shift;
 
     my @abbr = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
     my $l = length($report_title);
@@ -347,17 +319,25 @@ sub write_title_page {
     print $fh "$a\n";
     #print $fh ":title-logo-image: image::eolilogosmall.png[pdfwidth=3in]\n";
     print $fh ":toc:\n";
-    if ($captions_off == 1) { print $fh ":caption:\n"; }
+    if ($captions eq 'on') { print $fh ":caption:\n"; }
     print $fh "\n";
 }
 
+sub load_javascript {
+       my $fh = shift;
+
+       print $fh "++++\n";
+       print $fh "<script type=\"text/javascript\" src=\"https://www.gstatic.com/charts/loader.js\"></script>\n";
+       print $fh "++++\n";
+}
+
 sub check_table {
     my $query = shift;
     my $MIGSCHEMA = shift;
-    my $debug_flag = shift;
+    my $debug = shift;
     my $report_name = shift;
 
-    if ($debug_flag == 1) {print "$query\n";}
+    if ($debug eq 'on') {print "$query\n";}
 
     my $i;
     my $return_flag = 1;   
@@ -374,7 +354,7 @@ sub check_table {
         }
         $i--;
     }
-    if ($debug_flag == 1) {print "checking tables ... ";}
+    if ($debug eq 'on') {print "checking tables ... ";}
 
     $i = 0;
     foreach my $table (@tables) {
@@ -398,12 +378,12 @@ sub check_table {
                     next;
                 } else {
                     $return_flag = 0;
-                    if ($debug_flag == 1) {print "detecting $table failed...\n";}
+                    if ($debug eq 'on') {print "detecting $table failed...\n";}
                 }
             if ($row[0] eq '0') {$return_flag = 0;}
         }
     }
-    if ($return_flag == 1 and $debug_flag == 1) {print "succeeded ...\n";}
+    if ($return_flag == 1 and $debug eq 'on') {print "succeeded ...\n";}
     if ($return_flag == 0) {print "! a table failed the find test for report $report_name\n\n";}
     return $return_flag;
 }
@@ -420,13 +400,24 @@ sub clean_query_string {
 sub print_query {
     my $fh = shift;
     my %report = @_;
+
+       my $display = $report{display};
+       my $height = $report{divheight};
+       my $width = $report{divwidth};
+       if (!defined $display) { $display = 'table'; }
+       my $rname = $report{name};
     my $query = $report{query};
+       my $title = $report{report_title};
     my $sth = $dbh->prepare($query);
     $sth->execute();
 
+       if ($height) { $height = $height . 'px'; }
+       if ($width)  { $width = $width . 'px'; }
     my $header_flag = 0;
 
-    while (my @row = $sth->fetchrow_array) {
+       #print asciidoc
+       if ($display eq 'table') {
+       while (my @row = $sth->fetchrow_array) {
             if ($header_flag == 0) {
                 print $fh "\n.*$report{report_title}*\n";
                 print $fh "|===\n";
@@ -451,11 +442,47 @@ sub print_query {
             }
             print $fh "\n";
         }
-    if ($header_flag == 1) { 
-        print $fh "|===\n\n"; 
-        print $fh $report{note};
-        print $fh "\n\n";
-    }
+       if ($header_flag == 1) { 
+               print $fh "|===\n\n"; 
+               print $fh $report{note};
+               print $fh "\n\n";
+       }
+       }
+
+    #print chart 
+       if ($display eq 'pie_chart' or $display eq 'donut_chart') {
+               my @h = split(/\./,$report{heading});
+           my @l = split(/\./,$report{chart_labels});
+       
+               print $fh "++++\n";
+               if (defined $height and defined $width) { print $fh "<div id=\"$rname\" style=\"width: $width; height: $height;\"></div>\n"; }
+                       else { print $fh "<div id=\"$rname\"></div>\n"; }
+               print $fh "<script type=\"text/javascript\">\n";
+               print $fh "google.charts.load('current', {'packages':['corechart']});\n";
+               print $fh "google.charts.setOnLoadCallback(drawChart);\n";
+               print $fh "function drawChart() {\n";
+               print $fh "  var data = google.visualization.arrayToDataTable([\n";
+               #loop through data here 
+               print $fh "['$l[0]', '$l[1]' ],\n";
+               while (my @row = $sth->fetchrow_array) {
+                       my $row_length = @row;
+                       my $r = 1;
+                       while ($r < $row_length) {
+                print $fh "['$h[$r-1]', $row[$r-1] ],\n";
+                $r++;
+            }
+                       if ($r = $row_length) { print $fh "['$h[$r-1]', $row[$r-1] ]\n"; }      
+               }
+               print $fh "]);\n";
+               if ($display eq 'pie_chart') { print $fh "var options = {'title':'$title'};\n"; }
+        if ($display eq 'donut_chart') { print $fh "var options = {'title':'$title', pieHole: 0.4};\n"; }
+               print $fh "var chart = new google.visualization.PieChart(document.getElementById('$rname'));\n";
+        print $fh "chart.draw(data, options);\n";
+               print $fh "}\n";
+               print $fh "</script>\n";
+               print $fh "++++\n";
+       }
+
     print "successfully wrote output for $report{name}.\n\n";
 }