summaryrefslogtreecommitdiffstats
path: root/reports.cgi
blob: f713f615e0bfe96f5f4867ae02b8ea6850ef9991 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
#!/usr/bin/perl -T
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# This Source Code Form is "Incompatible With Secondary Licenses", as
# defined by the Mozilla Public License, v. 2.0.

use 5.10.1;
use strict;
use warnings;

use lib qw(. lib local/lib/perl5);

use Bugzilla;
use Bugzilla::Constants;
use Bugzilla::Util;
use Bugzilla::Error;
use Bugzilla::Status;

use File::Basename;
use Digest::SHA qw(hmac_sha256_base64);

# If we're using bug groups for products, we should apply those restrictions
# to viewing reports, as well.  Time to check the login in that case.
my $user     = Bugzilla->login();
my $cgi      = Bugzilla->cgi;
my $template = Bugzilla->template;
my $vars     = {};

if (!Bugzilla->feature('old_charts')) {
  ThrowCodeError('feature_disabled', {feature => 'old_charts'});
}

my $dir          = bz_locations()->{'datadir'} . "/mining";
my $graph_dir    = bz_locations()->{'graphsdir'};
my $graph_url    = basename($graph_dir);
my $product_name = $cgi->param('product') || '';

Bugzilla->switch_to_shadow_db();

if (!$product_name) {

  # Can we do bug charts?
  (-d $dir && -d $graph_dir)
    || ThrowCodeError('chart_dir_nonexistent',
    {dir => $dir, graph_dir => $graph_dir});

  my %default_sel = map { $_ => 1 } BUG_STATE_OPEN;

  my @datasets;
  my @data = get_data($dir);

  foreach my $dataset (@data) {
    my $datasets = {};
    $datasets->{'value'} = $dataset;
    $datasets->{'selected'} = $default_sel{$dataset} ? 1 : 0;
    push(@datasets, $datasets);
  }

  # We only want those products that the user has permissions for.
  my @myproducts = ('-All-');

  # Extract product names from objects and add them to the list.
  push(@myproducts, map { $_->name } @{$user->get_selectable_products});

  $vars->{'datasets'} = \@datasets;
  $vars->{'products'} = \@myproducts;

  print $cgi->header();
}
else {
# For security and correctness, validate the value of the "product" form variable.
# Valid values are those products for which the user has permissions which appear
# in the "product" drop-down menu on the report generation form.
  my ($product)
    = grep { $_->name eq $product_name } @{$user->get_selectable_products};
  ($product || $product_name eq '-All-')
    || ThrowUserError('invalid_product_name', {product => $product_name});

  # Product names can change over time. Their ID cannot; so use the ID
  # to generate the filename.
  my $prod_id = $product ? $product->id : 0;

  # Make sure there is something to plot.
  my @datasets = $cgi->param('datasets');
  scalar(@datasets) || ThrowUserError('missing_datasets');

  if (grep { $_ !~ /^[A-Za-z0-9:_-]+$/ } @datasets) {
    ThrowUserError('invalid_datasets', {'datasets' => \@datasets});
  }

  # Filenames must not be guessable as they can point to products
  # you are not allowed to see. Also, different projects can have
  # the same product names.
  my $project = bz_locations()->{'project'} || '';
  my $image_file = join(':', ($project, $prod_id, @datasets));
  my $key = Bugzilla->localconfig->{'site_wide_secret'};
  $image_file = hmac_sha256_base64($image_file, $key) . '.png';
  $image_file =~ s/\+/-/g;
  $image_file =~ s/\//_/g;
  trick_taint($image_file);

  if (!-e "$graph_dir/$image_file") {
    generate_chart($dir, "$graph_dir/$image_file", $product, \@datasets);
  }

  $vars->{'url_image'} = "$graph_url/$image_file";

  print $cgi->header(
    -Content_Disposition => 'inline; filename=bugzilla_report.html');
}

$template->process('reports/old-charts.html.tmpl', $vars)
  || ThrowTemplateError($template->error());

#####################
#    Subroutines    #
#####################

sub get_data {
  my $dir = shift;

  my @datasets;
  open(DATA, '<', "$dir/-All-")
    || ThrowCodeError('chart_file_open_fail', {filename => "$dir/-All-"});

  while (<DATA>) {
    if (/^# fields?: (.+)\s*$/) {
      @datasets = grep !/date/i, (split /\|/, $1);
      last;
    }
  }
  close(DATA);
  return @datasets;
}

sub generate_chart {
  my ($dir, $image_file, $product, $datasets) = @_;
  $product = $product ? $product->name : '-All-';
  my $data_file = $product;
  $data_file =~ s/\//-/gs;
  $data_file = $dir . '/' . $data_file;

  if (!open(FILE, '<', $data_file)) {
    if ($product eq '-All-') {
      $product = '';
    }
    ThrowCodeError('chart_data_not_generated', {'product' => $product});
  }

  my @fields;
  my @labels = qw(DATE);
  my %datasets = map { $_ => 1 } @$datasets;

  my %data = ();
  while (<FILE>) {
    chomp;
    next unless $_;
    if (/^#/) {
      if (/^# fields?: (.*)\s*$/) {
        @fields = split /\||\r/, $1;
        $data{$_} ||= [] foreach @fields;
        unless ($fields[0] =~ /date/i) {
          ThrowCodeError('chart_datafile_corrupt', {'file' => $data_file});
        }
        push @labels, grep($datasets{$_}, @fields);
      }
      next;
    }

    unless (@fields) {
      ThrowCodeError('chart_datafile_corrupt', {'file' => $data_file});
    }

    my @line = split /\|/;
    my $date = $line[0];
    my ($yy, $mm, $dd) = $date =~ /^\d{2}(\d{2})(\d{2})(\d{2})$/;
    push @{$data{DATE}}, "$mm/$dd/$yy";

    for my $i (1 .. $#fields) {
      my $field = $fields[$i];
      if (!defined $line[$i] or $line[$i] eq '') {

        # no data point given, don't plot (this will probably
        # generate loads of Chart::Base warnings, but that's not
        # our fault.)
        push @{$data{$field}}, undef;
      }
      else {
        push @{$data{$field}}, $line[$i];
      }
    }
  }

  shift @labels;

  close FILE;

  if (!@{$data{DATE}}) {
    ThrowUserError('insufficient_data_points');
  }

  my $img = Chart::Lines->new(800, 600);
  my $i = 0;

  my $MAXTICKS = 20;    # Try not to show any more x ticks than this.
  my $skip     = 1;
  if (@{$data{DATE}} > $MAXTICKS) {
    $skip = int((@{$data{DATE}} + $MAXTICKS - 1) / $MAXTICKS);
  }

  my %settings = (
    "title"           => "Status Counts for $product",
    "x_label"         => "Dates",
    "y_label"         => "Bug Counts",
    "legend_labels"   => \@labels,
    "skip_x_ticks"    => $skip,
    "y_grid_lines"    => "true",
    "grey_background" => "false",
    "colors"          => {

      # default dataset colours are too alike
      dataset4 => [0, 0, 0],    # black
    },
  );

  $img->set(%settings);
  $img->png($image_file, [@data{('DATE', @labels)}]);
}