duplicates.cgi 9.12 KB
Newer Older
1
#!/usr/bin/perl -wT
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Gervase Markham <gerv@gerv.net>
#
# Generates mostfreq list from data collected by collectstats.pl.

25

26
use strict;
27

28
use AnyDBM_File;
29 30 31

use lib qw(.);

32 33 34
require "globals.pl";
require "CGI.pl";

35 36
use vars qw($buffer);

37
use Bugzilla;
38
use Bugzilla::Search;
39
use Bugzilla::Config qw(:DEFAULT $datadir);
40
use Bugzilla::Constants;
41 42

my $cgi = Bugzilla->cgi;
43

44 45 46
# Go directly to the XUL version of the duplicates report (duplicates.xul)
# if the user specified ctype=xul.  Adds params if they exist, and directs
# the user to a signed copy of the script in duplicates.jar if it exists.
47
if ($::FORM{'ctype'} && $::FORM{'ctype'} eq "xul") {
48
    my $params = CanonicaliseParams($::buffer, ["format", "ctype"]);
49
    my $url = (-e "duplicates.jar" ? "duplicates.jar!/" : "") . 
50
          "duplicates.xul" . ($params ? "?$params" : "") . "\n\n";
51 52

    print $cgi->redirect($url);
53 54 55
    exit;
}

56 57 58
# Use global templatisation variables.
use vars qw($template $vars);

59
ConnectToDatabase();
60 61
GetVersionTable();

62 63 64 65 66 67 68 69 70
# collectstats.pl uses duplicates.cgi to generate the RDF duplicates stats.
# However, this conflicts with requirelogin if it's enabled; so we make
# logging-in optional if we are running from the command line.
if ($::ENV{'GATEWAY_INTERFACE'} eq "cmdline") {
    Bugzilla->login(LOGIN_OPTIONAL);
}
else {
    Bugzilla->login(LOGIN_NORMAL);
}
71

72
Bugzilla->switch_to_shadow_db();
73

74
use vars qw (%FORM $userid @legal_product);
75

76
my %dbmcount;
77 78 79
my %count;
my %before;

80
# Get params from URL
81 82 83
sub formvalue {
    my ($name, $default) = (@_);
    return $FORM{$name} || $default || "";
84
}
85

86 87 88 89
my $sortby = formvalue("sortby");
my $changedsince = formvalue("changedsince", 7);
my $maxrows = formvalue("maxrows", 100);
my $openonly = formvalue("openonly");
90
my $reverse = formvalue("reverse") ? 1 : 0;
91
my @query_products = $cgi->param('product');
92 93
my $sortvisible = formvalue("sortvisible");
my @buglist = (split(/[:,]/, formvalue("bug_id")));
94

95
my $product_id;
96 97
foreach my $p (@query_products) {
    $product_id = get_product_id($p);
98
    if (!$product_id) {
99
        ThrowUserError("invalid_product_name",
100
                       { product => $p });
101 102 103
    }
}

104 105
# Small backwards-compatibility hack, dated 2002-04-10.
$sortby = "count" if $sortby eq "dup_count";
106

107
# Open today's record of dupes
108 109
my $today = days_ago(0);
my $yesterday = days_ago(1);
110

111 112 113 114 115 116 117 118 119
# We don't know the exact file name, because the extention depends on the
# underlying dbm library, which could be anything. We can't glob, because
# perl < 5.6 considers if (<*>) { ... } to be tainted
# Instead, just check the return value for today's data and yesterday's,
# and ignore file not found errors

use Errno;
use Fcntl;

120
if (!tie(%dbmcount, 'AnyDBM_File', "$datadir/duplicates/dupes$today",
121 122
         O_RDONLY, 0644)) {
    if ($!{ENOENT}) {
123
        if (!tie(%dbmcount, 'AnyDBM_File', "$datadir/duplicates/dupes$yesterday",
124
                 O_RDONLY, 0644)) {
125
            my $vars = { today => $today };
126
            if ($!{ENOENT}) {
127
                ThrowUserError("no_dupe_stats", $vars);
128
            } else {
129
                $vars->{'error_msg'} = $!;
130
                ThrowUserError("no_dupe_stats_error_yesterday", $vars);
131 132 133
            }
        }
    } else {
134 135
        ThrowUserError("no_dupe_stats_error_today",
                       { error_msg => $! });
136
    }
137 138 139 140
}

# Copy hash (so we don't mess up the on-disk file when we remove entries)
%count = %dbmcount;
141 142 143

# Remove all those dupes under the threshold parameter. 
# We do this, before the sorting, for performance reasons.
144
my $threshold = Param("mostfreqthreshold");
145

146 147
while (my ($key, $value) = each %count) {
    delete $count{$key} if ($value < $threshold);
148 149 150
    
    # If there's a buglist, restrict the bugs to that list.
    delete $count{$key} if $sortvisible && (lsearch(\@buglist, $key) == -1);
151 152
}

153 154 155 156 157 158 159 160 161
my $origmaxrows = $maxrows;
detaint_natural($maxrows)
  || ThrowUserError("invalid_maxrows", { maxrows => $origmaxrows});

my $origchangedsince = $changedsince;
detaint_natural($changedsince)
  || ThrowUserError("invalid_changedsince", 
                    { changedsince => $origchangedsince });

162
# Try and open the database from "changedsince" days ago
163
my $dobefore = 0;
164
my %delta;
165 166
my $whenever = days_ago($changedsince);    

167
if (!tie(%before, 'AnyDBM_File', "$datadir/duplicates/dupes$whenever",
168 169 170
         O_RDONLY, 0644)) {
    # Ignore file not found errors
    if (!$!{ENOENT}) {
171 172 173 174 175
        ThrowUserError("no_dupe_stats_error_whenever",
                       { error_msg => $!,
                         changedsince => $changedsince,
                         whenever => $whenever,
                       });
176 177
    }
} else {
178
    # Calculate the deltas
179
    ($delta{$_} = $count{$_} - ($before{$_} || 0)) foreach (keys(%count));
180 181 182 183 184 185 186

    $dobefore = 1;
}

my @bugs;
my @bug_ids; 

187
if (scalar(%count)) {
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
    # use Bugzilla::Search so that we get the security checking
    my $params = new Bugzilla::CGI({ 'bug_id' => [keys %count] });

    if ($openonly) {
        $params->param('resolution', '---');
    } else {
        # We want to show bugs which:
        # a) Aren't CLOSED; and
        # b)  i) Aren't VERIFIED; OR
        #    ii) Were resolved INVALID/WONTFIX

        # The rationale behind this is that people will eventually stop
        # reporting fixed bugs when they get newer versions of the software,
        # but if the bug is determined to be erroneous, people will still
        # keep reporting it, so we do need to show it here.

        # a)
        $params->param('field0-0-0', 'bug_status');
        $params->param('type0-0-0', 'notequals');
        $params->param('value0-0-0', 'CLOSED');

        # b) i)
        $params->param('field0-1-0', 'bug_status');
        $params->param('type0-1-0', 'notequals');
        $params->param('value0-1-0', 'VERIFIED');

        # b) ii)
        $params->param('field0-1-1', 'resolution');
        $params->param('type0-1-1', 'anyexact');
        $params->param('value0-1-1', 'INVALID,WONTFIX');
    }

    # Restrict to product if requested
    if ($::FORM{'product'}) {
222
        $params->param('product', join(',', @query_products));
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
    }

    my $query = new Bugzilla::Search('fields' => [qw(bugs.bug_id
                                                     map_components.name
                                                     bugs.bug_severity
                                                     bugs.op_sys
                                                     bugs.target_milestone
                                                     bugs.short_desc
                                                     bugs.bug_status
                                                     bugs.resolution
                                                    )
                                                 ],
                                     'params' => $params,
                                    );

    SendSQL($query->getSQL());
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257

    while (MoreSQLData()) {
        # Note: maximum row count is dealt with in the template.

        my ($id, $component, $bug_severity, $op_sys, $target_milestone, 
            $short_desc, $bug_status, $resolution) = FetchSQLData();

        push (@bugs, { id => $id,
                       count => $count{$id},
                       delta => $delta{$id}, 
                       component => $component,
                       bug_severity => $bug_severity,
                       op_sys => $op_sys,
                       target_milestone => $target_milestone,
                       short_desc => $short_desc,
                       bug_status => $bug_status, 
                       resolution => $resolution });
        push (@bug_ids, $id); 
    }
258 259 260 261 262 263 264 265 266 267 268 269
}

$vars->{'bugs'} = \@bugs;
$vars->{'bug_ids'} = \@bug_ids;

$vars->{'dobefore'} = $dobefore;
$vars->{'sortby'} = $sortby;
$vars->{'sortvisible'} = $sortvisible;
$vars->{'changedsince'} = $changedsince;
$vars->{'maxrows'} = $maxrows;
$vars->{'openonly'} = $openonly;
$vars->{'reverse'} = $reverse;
270
$vars->{'format'} = $::FORM{'format'};
271
$vars->{'query_products'} = \@query_products;
272 273
$vars->{'products'} = \@::legal_product;

274

275 276
my $format = 
  GetFormat("reports/duplicates", $::FORM{'format'}, $::FORM{'ctype'});
277 278

print $cgi->header($format->{'ctype'});
279 280

# Generate and return the UI (HTML page) from the appropriate template.
281
$template->process($format->{'template'}, $vars)
282
  || ThrowTemplateError($template->error());
283 284 285 286 287


sub days_ago {
    my ($dom, $mon, $year) = (localtime(time - ($_[0]*24*60*60)))[3, 4, 5];
    return sprintf "%04d-%02d-%02d", 1900 + $year, ++$mon, $dom;
288
}