added ability to define assets for reporter to read into an output file as sections
[migration-tools.git] / mig-bin / mig-reporter
1 #!/usr/bin/perl
2
3 use strict;
4 use warnings;
5
6 use DBI;
7 use Data::Dumper;
8 use XML::LibXML;
9 use Env qw(
10     HOME PGHOST PGPORT PGUSER PGDATABASE MIGSCHEMA
11     MIGBASEWORKDIR MIGBASEGITDIR MIGGITDIR MIGWORKDIR
12 );
13 use Pod::Usage;
14 use Switch;
15 use Cwd 'abs_path';
16 use FindBin;
17 my $mig_bin = "$FindBin::Bin/";
18 use lib "$FindBin::Bin/";
19 use Mig;
20 use open ':encoding(utf8)';
21
22 pod2usage(-verbose => 2) if defined $ARGV[0] && $ARGV[0] eq '--help';
23
24 my $analyst;
25 my $next_arg_is_analyst;
26 my $report_title;
27 my $next_arg_is_report_title;
28 my $reports_xml;
29 my $next_arg_is_reports_xml;
30 my $tags;
31 my $next_arg_is_tags;
32 my $added_page_title;
33 my $next_arg_is_added_page_title;
34 my $added_page_file;
35 my $next_arg_is_added_page_file;
36 my $i = 0;
37 my $parser = XML::LibXML->new();
38 my $lines_per_page = 42;
39
40 foreach my $arg (@ARGV) {
41     if ($arg eq '--report_title') {
42         $next_arg_is_report_title = 1;
43         next;
44     }
45     if ($next_arg_is_report_title) {
46         $report_title = $arg;
47         $next_arg_is_report_title = 0;
48         next;
49     }
50     if ($arg eq '--analyst') {
51         $next_arg_is_analyst = 1;
52         next;
53     }
54     if ($next_arg_is_analyst) {
55         $analyst = $arg;
56         $next_arg_is_analyst = 0;
57         next;
58     }
59     if ($arg eq '--reports_xml') {
60         $next_arg_is_reports_xml = 1;
61         next;
62     }
63     if ($next_arg_is_reports_xml) {
64         $reports_xml = $arg;
65         $next_arg_is_reports_xml = 0;
66         next;
67     }
68     if ($arg eq '--tags') {
69         $next_arg_is_tags = 1;
70         next;
71     }
72     if ($next_arg_is_tags) {
73         $tags = $arg;
74         $next_arg_is_tags = 0;
75         next;
76     }
77     if ($arg eq '--added_page_title') {
78         $next_arg_is_added_page_title = 1;
79         next;
80     }
81     if ($next_arg_is_added_page_title) {
82         $added_page_title = $arg;
83         $next_arg_is_added_page_title = 0;
84         next;
85     }
86     if ($arg eq '--added_page_file') {
87         $next_arg_is_added_page_file = 1;
88         next;
89     }
90     if ($next_arg_is_added_page_file) {
91         $added_page_file = $arg;
92         $next_arg_is_added_page_file = 0;
93         next;
94     }
95 }
96
97 if (!defined $tags) {$tags = 'circs.holds.actors.bibs.assets.money'};
98 if (!defined $analyst) { abort('--analyst must be supplied'); }
99 if (!defined $report_title) { abort('--report_title must be supplied'); }
100
101 my $mig_path = abs_path($0);
102 $mig_path =~ s|[^/]+$||;
103 if (!defined $reports_xml) { $reports_xml = $mig_path . '../mig-xml/evergreen_staged_report.xml'; } 
104     else { $reports_xml = $mig_path . '/../mig-xml/' . $reports_xml; }
105 print "$reports_xml \n";
106 my $dom = $parser->parse_file($reports_xml);
107
108 if (defined $added_page_file or defined $added_page_title) {
109     abort('must specify --added_page_file and --added_page_title') unless defined $added_page_file and defined $added_page_title;
110     }
111 if (defined $added_page_file) { $added_page_file = $MIGGITDIR . $added_page_file; }
112
113 my $dbh = Mig::db_connect();
114 my $report_file = create_report_name($report_title);
115 $report_file = $MIGGITDIR . $report_file;
116
117 open(my $fh, '>', $report_file) or abort("Could not open output file!");
118
119 write_title_page($report_title,$fh,$analyst);
120
121 if (defined $added_page_file and defined $added_page_title) { 
122     print $fh "<<<\n";
123     print $fh "== $added_page_title\n";
124     print "$added_page_file\t$added_page_title\n";
125     open(my $an,'<:encoding(UTF-8)', $added_page_file) or abort("Could not open $added_page_file!");
126     while ( my $line = <$an> ) {
127         print $fh $line;
128     }
129     print $fh "\n";
130     close $an;
131 }
132
133 foreach my $func ($dom->findnodes('//function')) {
134     my $fdrop = $func->findvalue('./drop');
135     my $fcreate = $func->findvalue('./create');    
136     my $fname = $func->findvalue('./name');
137     my $sdrop = $dbh->prepare($fdrop);
138     my $screate = $dbh->prepare($fcreate);
139     print "dropping function $fname ... ";
140     $sdrop->execute();
141     print "creating function $fname\n\n";
142     $screate->execute();
143 }
144
145 $tags = lc($tags);
146 my @report_tags = split(/\./,$tags);
147 foreach my $t (@report_tags) {
148     print "\n\n=========== Starting to process tag $t\n";
149     print   "==========================================\n";
150
151     my @asset_files;
152     foreach my $asset ($dom->findnodes('//asset')) {
153         if (index($asset->findvalue('./tag'),$t) != -1) {
154             push @asset_files, $asset->findvalue('./file');
155         }
156     }
157
158     foreach my $fname (@asset_files) {
159         my $asset_path = $mig_path . '../mig-asc/' . $fname;
160         open my $a, $asset_path or abort("Could not open $fname.");
161         while ( my $l = <$a> ) {
162             print $fh $l;
163         }
164     print $fh "<<<\n";
165     }
166
167     print_section_header(ucfirst($t),$fh);
168     my $linecount = $lines_per_page;
169     my $r;
170
171     my @asset_files;
172     foreach my $asset ($dom->findnodes('//asset')) {
173         if (index($asset->findvalue('./tag'),$t) != -1) {
174             push @asset_files, $asset->findvalue('./file');
175         }
176     }
177
178     my @report_names;
179     foreach my $report ($dom->findnodes('//report')) {
180         if (index($report->findvalue('./tag'),$t) != -1 and $report->findvalue('./iteration') eq '0') {
181             push @report_names, $report->findvalue('./name');
182         }
183     }
184
185     #only has one level of failover now but could change to array of hashes and loops
186     #but this keeps it simple and in practice I haven't needed more than two
187     foreach my $rname (@report_names) {
188         my %report0;
189         my %report1;
190         my $check_tables0;
191         my $check_tables1;
192
193         print "\nchecking for $rname ... ";
194         %report0 = find_report($dom,$t,$rname,'0');
195         $check_tables0 = check_table($report0{query},$MIGSCHEMA);
196         if ($check_tables0 == 1) {
197            $r =  print_query($fh,%report0); 
198         } else {
199         %report1 = find_report($dom,$t,$rname,'1');
200         if (defined $report1{query}) {
201             $check_tables1 = check_table($report1{query},$MIGSCHEMA);
202             if ($check_tables1 == 1) {$r = print_query($fh,%report1);}    
203             }
204         }
205     }
206 }
207
208 print "\n";
209 close $fh;
210
211 ############ end of main logic
212
213 sub find_report {
214     my $dom = shift;
215     my $tag = shift;
216     my $name = shift;
217     my $iteration = shift;
218     my %report;
219
220     print "iteration $iteration ";
221     foreach my $node ($dom->findnodes('//report')) {
222         if ($node->findvalue('./tag') =~ $tag and $node->findvalue('./iteration') eq $iteration and $node->findvalue('./name') eq $name) {
223             print "succeeded ... \n";
224             %report = (
225                 name => $node->findvalue('./name'),
226                 report_title => $node->findvalue('./report_title'),
227                 query => $node->findvalue('./query'),
228                 heading => $node->findvalue('./heading'),
229                 tag => $node->findvalue('./tag'),
230                 iteration => $node->findvalue('./iteration'),
231                 note => $node->findvalue('./note'),
232             );
233             return %report;
234         }
235     }
236     print "failed ... \n";
237     return %report = (
238         name => "eaten by grue"
239     );
240 }
241
242 sub print_section_header {
243     my $t = shift;
244     my $fh = shift;
245     $t =~ s/_/ /g;
246     #$t =~ s/(\w+)/\u$1/g;;
247     print $fh "<<<\n";
248     print $fh "== $t Reports\n";
249 }
250
251 sub create_report_name {
252     my $rt = shift;
253     my @abbr = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
254     my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
255     $year += 1900;
256     my $date = $year . '_' . $abbr[$mon] . '_' . $mday;
257     my $report_file = $rt . ' ' . $date . '.asciidoc';
258     $report_file =~ s/ /_/g;
259     return $report_file;
260 }
261
262 sub write_title_page {
263     my $rt = shift;
264     my $fh = shift;
265     my $a = shift;
266
267     my @abbr = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
268     my $l = length($report_title);
269     my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
270     $year += 1900;
271     print $fh "= $rt\n"; 
272     print $fh "$mday $abbr[$mon] $year\n";
273     print $fh "$a\n";
274     print $fh ":title-logo-image: image::eolilogosmall.png[pdfwidth=3in]\n";
275     print $fh ":toc:\n";
276     print $fh "\n";
277 }
278
279 sub check_table {
280     my $query = shift;
281     my $MIGSCHEMA = shift;
282
283     my $i;
284     my $return_flag = 1;   
285     my @qe = split(/ /,$query);
286     $i = @qe;
287     $i--;
288     my @tables;
289     while ($i > -1) {
290         if ($qe[$i] eq 'FROM' or $qe[$i] eq 'JOIN') {
291             my $q = $i + 1;
292             if ($qe[$q] ne '(SELECT') {
293                 push @tables, $qe[$q];            
294             }
295         }
296         $i--;
297     }
298     print "checking tables ... ";
299
300     $i = 0;
301     foreach my $table (@tables) {
302         $table =~ s/\)//g;
303         $table =~ s/\<//g;
304         my $sql;
305         my $schema;
306         if (index($table,'.') != -1) {
307             $schema = (split /\./,$table)[0];
308             $table = (split /\./,$table)[1];
309         } 
310         if (defined $schema) {
311             $sql = 'SELECT EXISTS (SELECT 1 FROM information_schema.tables WHERE table_schema = \'' . $schema . '\' AND table_name = \'' . $table . '\');';
312         } else {
313             $sql = 'SELECT EXISTS (SELECT 1 FROM information_schema.tables WHERE table_schema = \'' . $MIGSCHEMA . '\' AND table_name = \'' . $table . '\');';
314         }
315         my $sth = $dbh->prepare($sql);
316         $sth->execute();
317         while (my @row = $sth->fetchrow_array) {
318             if ($row[0] eq '1') {
319                     next;
320                 } else {
321                     $return_flag = 0;
322                 }
323             if ($row[0] eq '0') {$return_flag = 0;}
324         }
325     }
326     if ($return_flag == 1) {print "succeeded ... ";} else {print "failed ... ";}
327     return $return_flag;
328 }
329
330 sub print_query {
331     my $fh = shift;
332     my %report = @_;
333     my $query = $report{query};
334     print "$query\n";
335     my $sth = $dbh->prepare($query);
336     $sth->execute();
337
338     my $header_flag = 0;
339
340     while (my @row = $sth->fetchrow_array) {
341             if ($header_flag == 0) {
342                 print $fh "\n.*$report{report_title}*\n";
343                 print $fh "|===\n";
344                 my @h = split(/\./,$report{heading});
345                 my $h_length = @h;
346                 my $h_count = 1;
347                 while ($h_count <= $h_length) {
348                     print $fh "|$h[$h_count-1] ";
349                     $h_count++;
350                 }
351                 print $fh "\n";
352                 $header_flag = 1;
353             }
354             my $row_length = @row;
355             my $r = 1;
356             while ($r <= $row_length) {
357                 if (! defined $row[$r-1] ) {
358                     $row[$r-1] = 'none';
359                 }
360                 print $fh "|$row[$r-1] ";
361                 $r++;
362             }
363             print $fh "\n";
364         }
365     if ($header_flag == 1) { 
366         print $fh "|===\n\n"; 
367         print $fh $report{note};
368         print $fh "\n\n";
369     }
370     print "successfully wrote output for $report{name}.\n\n";
371 }
372
373 sub abort {
374     my $msg = shift;
375     print STDERR "$0: $msg", "\n";
376     exit 1;
377 }
378
379