X-Git-Url: http://git.equinoxoli.org/?p=migration-tools.git;a=blobdiff_plain;f=mig-bin%2Fmig-reporter;h=718063b838d98dcc72bba502411512fc70edad9c;hp=169be4d782a0e0b1145e3716e31d1bc3cee08dae;hb=52842211c4d4fa61bfbc0279b40ce31e54dc5b86;hpb=35219b6520c2d8cbfb22dc3a06d4e05d315375e7 diff --git a/mig-bin/mig-reporter b/mig-bin/mig-reporter index 169be4d..718063b 100755 --- a/mig-bin/mig-reporter +++ b/mig-bin/mig-reporter @@ -20,17 +20,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. ---excel_output or --excel +--captions on OR --captions off -Pushes output to an Excel file instead of asciidoc file. +Adds the captions tag to asciidoc header to turn off captions in generated output. +Defaults to off. =back @@ -48,10 +49,11 @@ use Env qw( HOME PGHOST PGPORT PGUSER PGDATABASE MIGSCHEMA MIGBASEWORKDIR MIGBASEGITDIR MIGGITDIR MIGWORKDIR ); -use Excel::Writer::XLSX; use Pod::Usage; use Switch; +use Getopt::Long; use Cwd 'abs_path'; +use Cwd qw(getcwd); use FindBin; my $mig_bin = "$FindBin::Bin/"; use lib "$FindBin::Bin/"; @@ -62,105 +64,38 @@ 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 $report_title; -my $next_arg_is_report_title; my $reports_xml; -my $next_arg_is_reports_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 $excel_output = 0; -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 '--excel_output' or $arg eq '--excel') { - $excel_output = 1; - 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, + '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'}; +if (!defined $tags) {$tags = 'circs.holds.actors.bibs.assets.money.notices'}; if (!defined $report_title) { abort('--report_title must be supplied'); } -if ($excel_output == 0 and !defined $analyst) { abort('--analyst must be supplied'); } +if (!defined $analyst) { abort('--analyst must be supplied'); } my $mig_path = abs_path($0); $mig_path =~ s|[^/]+$||; -if (!defined $reports_xml) { - if ($excel_output == 0) { $reports_xml = $mig_path . '../mig-xml/evergreen_staged_report.xml'; } - else { $reports_xml = $mig_path . '../mig-xml/excel_mapping_reports.xml'; } - } else { $reports_xml = $mig_path . '/../mig-xml/' . $reports_xml; } +$reports_xml = find_xml($reports_xml,$mig_path); +if (!defined $reports_xml) { abort("Can not find xml reports file."); } my $dom = $parser->parse_file($reports_xml); if (defined $added_page_file or defined $added_page_title) { @@ -169,15 +104,11 @@ if (defined $added_page_file or defined $added_page_title) { if (defined $added_page_file) { $added_page_file = $MIGGITDIR . $added_page_file; } my $dbh = Mig::db_connect(); -my $report_file = create_report_name($report_title,$excel_output); +my $report_file = create_report_name($report_title); $report_file = $MIGGITDIR . $report_file; -if ($excel_output == 1) { - $workbook = Excel::Writer::XLSX->new( $report_file ); -} else { - open($fh, '>', $report_file) or abort("Could not open output file!"); - write_title_page($report_title,$fh,$analyst,$captions_off); -}; +open($fh, '>', $report_file) or abort("Could not open output file $report_file!"); +write_title_page($report_title,$fh,$analyst,$captions); if (defined $added_page_file and defined $added_page_title) { print $fh "<<<\n"; @@ -225,7 +156,7 @@ foreach my $t (@report_tags) { print $fh "<<<\n"; } - if ($excel_output == 0) { print_section_header(ucfirst($t),$fh); } + print_section_header(ucfirst($t),$fh); my $linecount = $lines_per_page; my $r; @@ -240,7 +171,6 @@ foreach my $t (@report_tags) { foreach my $report ($dom->findnodes('//report')) { if (index($report->findvalue('./tag'),$t) != -1 and $report->findvalue('./iteration') eq '0') { push @report_names, $report->findvalue('./name'); - if ($excel_output == 1) { print_query_to_excel($workbook,$report); } } } @@ -248,46 +178,60 @@ foreach my $t (@report_tags) { #but this keeps it simple and in practice I haven't needed more than two - if ($excel_output == 0) { - foreach my $rname (@report_names) { - my %report0; - my %report1; - 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 (defined $report1{query}) { - $check_tables1 = check_table($report1{query},$MIGSCHEMA,$debug_flag,$rname); - if ($check_tables1 == 1) { $r = print_query($fh,%report1); } - } + foreach my $rname (@report_names) { + my %report0; + my %report1; + my $check_tables0; + my $check_tables1; + + 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,$rname); + if ($check_tables1 == 1) { $r = print_query($fh,%report1); } } } } + } print "\n"; -if ($excel_output eq 1) { $workbook->close(); } - else { close $fh; } +close $fh; ############ end of main logic +sub find_xml { + my $reports_xml = shift; + my $mig_path = shift; + + if ($reports_xml =~ m/\//) { return $reports_xml; } + + my $mig_test_file = $mig_path . '/../mig-xml/' . $reports_xml; + my $working_test_dir = getcwd(); + my $working_test_file = $working_test_dir . '/' . $reports_xml; + + if (-e $mig_test_file) { return $mig_test_file; } + if (-e $working_test_file) { return $working_test_file; } + + return undef; +} + sub find_report { my $dom = shift; 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'), @@ -300,7 +244,7 @@ sub find_report { return %report; } } - if ($debug_flag == 1) {print "failed ... \n";} + if ($debug eq 'on') {print "failed ... \n";} return %report = ( name => "eaten by grue" ); @@ -319,15 +263,13 @@ sub print_section_header { sub create_report_name { my $rt = shift; - my $excel_output = shift; my @abbr = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec); my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time); $year += 1900; my $date = $year . '_' . $abbr[$mon] . '_' . $mday; my $report_file; - if ($excel_output == 0) { $report_file = $rt . ' ' . $date . '.asciidoc'; } - else { $report_file = $rt . ' ' . $date . '.xlsx'; } + $report_file = $rt . ' ' . $date . '.asciidoc'; $report_file =~ s/ /_/g; return $report_file; } @@ -336,7 +278,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 +289,17 @@ 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 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 +316,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 +340,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; } @@ -434,7 +376,7 @@ sub print_query { my $h_length = @h; my $h_count = 1; while ($h_count <= $h_length) { - print $fh "|$h[$h_count-1] "; + print $fh "|*$h[$h_count-1]* "; $h_count++; } print $fh "\n"; @@ -459,55 +401,6 @@ sub print_query { print "successfully wrote output for $report{name}.\n\n"; } -sub print_query_to_excel { - my $workbook = shift; - my $report = shift; - - my $header_format = $workbook->add_format( bold => 1, color => 'green', size => 16); - my $note_format = $workbook->add_format( bold => 1, color => 'red', size => 14); - - my $query = $report->findvalue('./query'); - my $title = $report->findvalue('./report_title'); - my $headings = $report->findnodes('./heading'); - - my $sth = $dbh->prepare($query); - $sth->execute(); - - my $worksheet = $workbook->add_worksheet( $title ); - my $cell = ""; - my $col = ""; - - my @h = split(/\./,$headings); - my $h_length = @h; - my $h_count = 1; - while ($h_count <= $h_length) { - $col = give_column($h_count-1); - $cell = $col . '1'; - $worksheet->write($cell,$h[$h_count-1],$header_format); - $h_count++; - } - my $cur_row = 1; - while (my @row = $sth->fetchrow_array) { - $cur_row++; - my $row_length = @row; - my $r = 1; - print Dumper(@row); - while ($r <= $row_length) { - if (! defined $row[$r-1] ) { - $row[$r-1] = 'none'; - } - $col = give_column($r-1); - $cell = $col . $cur_row; - $worksheet->write($cell,$row[$r-1]); - $r++; - } - } - $cur_row = $cur_row + 2; - $cell = "A" . "$cur_row"; - $worksheet->write($cell,$report->findvalue('./note'),$note_format); - print "Printed Query for $title.\n"; -} - sub give_column { my $i = shift; my $col = "";