483 lines
13 KiB
Perl
483 lines
13 KiB
Perl
# -*- 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): Myk Melez <myk@mozilla.org>
|
|
# Frédéric Buclin <LpSolit@gmail.com>
|
|
|
|
use strict;
|
|
|
|
package Bugzilla::FlagType;
|
|
|
|
=head1 NAME
|
|
|
|
Bugzilla::FlagType - A module to deal with Bugzilla flag types.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
FlagType.pm provides an interface to flag types as stored in Bugzilla.
|
|
See below for more information.
|
|
|
|
=head1 NOTES
|
|
|
|
=over
|
|
|
|
=item *
|
|
|
|
Use of private functions/variables outside this module may lead to
|
|
unexpected results after an upgrade. Please avoid using private
|
|
functions in other files/modules. Private functions are functions
|
|
whose names start with _ or are specifically noted as being private.
|
|
|
|
=back
|
|
|
|
=cut
|
|
|
|
use Bugzilla::User;
|
|
use Bugzilla::Error;
|
|
use Bugzilla::Util;
|
|
use Bugzilla::Group;
|
|
|
|
use base qw(Bugzilla::Object);
|
|
|
|
###############################
|
|
#### Initialization ####
|
|
###############################
|
|
|
|
=begin private
|
|
|
|
=head1 PRIVATE VARIABLES/CONSTANTS
|
|
|
|
=over
|
|
|
|
=item C<DB_COLUMNS>
|
|
|
|
basic sets of columns and tables for getting flag types from the
|
|
database.
|
|
|
|
=back
|
|
|
|
=cut
|
|
|
|
use constant DB_COLUMNS => qw(
|
|
flagtypes.id
|
|
flagtypes.name
|
|
flagtypes.description
|
|
flagtypes.cc_list
|
|
flagtypes.target_type
|
|
flagtypes.sortkey
|
|
flagtypes.is_active
|
|
flagtypes.is_requestable
|
|
flagtypes.is_requesteeble
|
|
flagtypes.is_multiplicable
|
|
flagtypes.grant_group_id
|
|
flagtypes.request_group_id
|
|
);
|
|
|
|
=pod
|
|
|
|
=over
|
|
|
|
=item C<DB_TABLE>
|
|
|
|
Which database(s) is the data coming from?
|
|
|
|
Note: when adding tables to DB_TABLE, make sure to include the separator
|
|
(i.e. words like "LEFT OUTER JOIN") before the table name, since tables take
|
|
multiple separators based on the join type, and therefore it is not possible
|
|
to join them later using a single known separator.
|
|
|
|
=back
|
|
|
|
=end private
|
|
|
|
=cut
|
|
|
|
use constant DB_TABLE => 'flagtypes';
|
|
use constant LIST_ORDER => 'flagtypes.sortkey, flagtypes.name';
|
|
|
|
###############################
|
|
#### Accessors ######
|
|
###############################
|
|
|
|
=head2 METHODS
|
|
|
|
=over
|
|
|
|
=item C<id>
|
|
|
|
Returns the ID of the flagtype.
|
|
|
|
=item C<name>
|
|
|
|
Returns the name of the flagtype.
|
|
|
|
=item C<description>
|
|
|
|
Returns the description of the flagtype.
|
|
|
|
=item C<cc_list>
|
|
|
|
Returns the concatenated CC list for the flagtype, as a single string.
|
|
|
|
=item C<target_type>
|
|
|
|
Returns whether the flagtype applies to bugs or attachments.
|
|
|
|
=item C<is_active>
|
|
|
|
Returns whether the flagtype is active or disabled. Flags being
|
|
in a disabled flagtype are not deleted. It only prevents you from
|
|
adding new flags to it.
|
|
|
|
=item C<is_requestable>
|
|
|
|
Returns whether you can request for the given flagtype
|
|
(i.e. whether the '?' flag is available or not).
|
|
|
|
=item C<is_requesteeble>
|
|
|
|
Returns whether you can ask someone specifically or not.
|
|
|
|
=item C<is_multiplicable>
|
|
|
|
Returns whether you can have more than one flag for the given
|
|
flagtype in a given bug/attachment.
|
|
|
|
=item C<sortkey>
|
|
|
|
Returns the sortkey of the flagtype.
|
|
|
|
=back
|
|
|
|
=cut
|
|
|
|
sub id { return $_[0]->{'id'}; }
|
|
sub name { return $_[0]->{'name'}; }
|
|
sub description { return $_[0]->{'description'}; }
|
|
sub cc_list { return $_[0]->{'cc_list'}; }
|
|
sub target_type { return $_[0]->{'target_type'} eq 'b' ? 'bug' : 'attachment'; }
|
|
sub is_active { return $_[0]->{'is_active'}; }
|
|
sub is_requestable { return $_[0]->{'is_requestable'}; }
|
|
sub is_requesteeble { return $_[0]->{'is_requesteeble'}; }
|
|
sub is_multiplicable { return $_[0]->{'is_multiplicable'}; }
|
|
sub sortkey { return $_[0]->{'sortkey'}; }
|
|
sub request_group_id { return $_[0]->{'request_group_id'}; }
|
|
sub grant_group_id { return $_[0]->{'grant_group_id'}; }
|
|
|
|
###############################
|
|
#### Methods ####
|
|
###############################
|
|
|
|
=pod
|
|
|
|
=over
|
|
|
|
=item C<grant_list>
|
|
|
|
Returns a reference to an array of users who have permission to grant this flag type.
|
|
The arrays are populated with hashrefs containing the login, identity and visibility of users.
|
|
|
|
=item C<grant_group>
|
|
|
|
Returns the group (as a Bugzilla::Group object) in which a user
|
|
must be in order to grant or deny a request.
|
|
|
|
=item C<request_group>
|
|
|
|
Returns the group (as a Bugzilla::Group object) in which a user
|
|
must be in order to request or clear a flag.
|
|
|
|
=item C<flag_count>
|
|
|
|
Returns the number of flags belonging to the flagtype.
|
|
|
|
=item C<inclusions>
|
|
|
|
Return a hash of product/component IDs and names
|
|
explicitly associated with the flagtype.
|
|
|
|
=item C<exclusions>
|
|
|
|
Return a hash of product/component IDs and names
|
|
explicitly excluded from the flagtype.
|
|
|
|
=back
|
|
|
|
=cut
|
|
|
|
sub grant_list {
|
|
my $self = shift;
|
|
my @custusers;
|
|
my @allusers = @{Bugzilla->user->get_userlist};
|
|
foreach my $user (@allusers) {
|
|
my $user_obj = new Bugzilla::User({name => $user->{login}});
|
|
push(@custusers, $user) if $user_obj->can_set_flag($self);
|
|
}
|
|
return \@custusers;
|
|
}
|
|
|
|
sub grant_group {
|
|
my $self = shift;
|
|
|
|
if (!defined $self->{'grant_group'} && $self->{'grant_group_id'}) {
|
|
$self->{'grant_group'} = new Bugzilla::Group($self->{'grant_group_id'});
|
|
}
|
|
return $self->{'grant_group'};
|
|
}
|
|
|
|
sub request_group {
|
|
my $self = shift;
|
|
|
|
if (!defined $self->{'request_group'} && $self->{'request_group_id'}) {
|
|
$self->{'request_group'} = new Bugzilla::Group($self->{'request_group_id'});
|
|
}
|
|
return $self->{'request_group'};
|
|
}
|
|
|
|
sub flag_count {
|
|
my $self = shift;
|
|
|
|
if (!defined $self->{'flag_count'}) {
|
|
$self->{'flag_count'} =
|
|
Bugzilla->dbh->selectrow_array('SELECT COUNT(*) FROM flags
|
|
WHERE type_id = ?', undef, $self->{'id'});
|
|
}
|
|
return $self->{'flag_count'};
|
|
}
|
|
|
|
sub inclusions {
|
|
my $self = shift;
|
|
|
|
$self->{'inclusions'} ||= get_clusions($self->id, 'in');
|
|
return $self->{'inclusions'};
|
|
}
|
|
|
|
sub exclusions {
|
|
my $self = shift;
|
|
|
|
$self->{'exclusions'} ||= get_clusions($self->id, 'ex');
|
|
return $self->{'exclusions'};
|
|
}
|
|
|
|
######################################################################
|
|
# Public Functions
|
|
######################################################################
|
|
|
|
=pod
|
|
|
|
=head1 PUBLIC FUNCTIONS/METHODS
|
|
|
|
=over
|
|
|
|
=item C<get_clusions($id, $type)>
|
|
|
|
Return a hash of product/component IDs and names
|
|
associated with the flagtype:
|
|
$clusions{'product_name:component_name'} = "product_ID:component_ID"
|
|
|
|
=back
|
|
|
|
=cut
|
|
|
|
sub get_clusions {
|
|
my ($id, $type) = @_;
|
|
my $dbh = Bugzilla->dbh;
|
|
|
|
my $list =
|
|
$dbh->selectall_arrayref("SELECT products.id, products.name, " .
|
|
" components.id, components.name " .
|
|
"FROM flagtypes, flag${type}clusions " .
|
|
"LEFT OUTER JOIN products " .
|
|
" ON flag${type}clusions.product_id = products.id " .
|
|
"LEFT OUTER JOIN components " .
|
|
" ON flag${type}clusions.component_id = components.id " .
|
|
"WHERE flagtypes.id = ? " .
|
|
" AND flag${type}clusions.type_id = flagtypes.id",
|
|
undef, $id);
|
|
my %clusions;
|
|
foreach my $data (@$list) {
|
|
my ($product_id, $product_name, $component_id, $component_name) = @$data;
|
|
$product_id ||= 0;
|
|
$product_name ||= "__Any__";
|
|
$component_id ||= 0;
|
|
$component_name ||= "__Any__";
|
|
$clusions{"$product_name:$component_name"} = "$product_id:$component_id";
|
|
}
|
|
return \%clusions;
|
|
}
|
|
|
|
=pod
|
|
|
|
=over
|
|
|
|
=item C<match($criteria)>
|
|
|
|
Queries the database for flag types matching the given criteria
|
|
and returns a list of matching flagtype objects.
|
|
|
|
=back
|
|
|
|
=cut
|
|
|
|
sub match {
|
|
my ($criteria) = @_;
|
|
my $dbh = Bugzilla->dbh;
|
|
|
|
# Depending on the criteria, we may have to append additional tables.
|
|
my $tables = [DB_TABLE];
|
|
my @criteria = sqlify_criteria($criteria, $tables);
|
|
$tables = join(' ', @$tables);
|
|
$criteria = join(' AND ', @criteria);
|
|
|
|
my $flagtype_ids = $dbh->selectcol_arrayref("SELECT id FROM $tables WHERE $criteria");
|
|
|
|
return Bugzilla::FlagType->new_from_list($flagtype_ids);
|
|
}
|
|
|
|
=pod
|
|
|
|
=over
|
|
|
|
=item C<count($criteria)>
|
|
|
|
Returns the total number of flag types matching the given criteria.
|
|
|
|
=back
|
|
|
|
=cut
|
|
|
|
sub count {
|
|
my ($criteria) = @_;
|
|
my $dbh = Bugzilla->dbh;
|
|
|
|
# Depending on the criteria, we may have to append additional tables.
|
|
my $tables = [DB_TABLE];
|
|
my @criteria = sqlify_criteria($criteria, $tables);
|
|
$tables = join(' ', @$tables);
|
|
$criteria = join(' AND ', @criteria);
|
|
|
|
my $count = $dbh->selectrow_array("SELECT COUNT(flagtypes.id)
|
|
FROM $tables WHERE $criteria");
|
|
return $count;
|
|
}
|
|
|
|
######################################################################
|
|
# Private Functions
|
|
######################################################################
|
|
|
|
=begin private
|
|
|
|
=head1 PRIVATE FUNCTIONS
|
|
|
|
=over
|
|
|
|
=item C<sqlify_criteria($criteria, $tables)>
|
|
|
|
Converts a hash of criteria into a list of SQL criteria.
|
|
$criteria is a reference to the criteria (field => value),
|
|
$tables is a reference to an array of tables being accessed
|
|
by the query.
|
|
|
|
=back
|
|
|
|
=cut
|
|
|
|
sub sqlify_criteria {
|
|
my ($criteria, $tables) = @_;
|
|
my $dbh = Bugzilla->dbh;
|
|
|
|
# the generated list of SQL criteria; "1=1" is a clever way of making sure
|
|
# there's something in the list so calling code doesn't have to check list
|
|
# size before building a WHERE clause out of it
|
|
my @criteria = ("1=1");
|
|
|
|
if ($criteria->{name}) {
|
|
my $name = $dbh->quote($criteria->{name});
|
|
trick_taint($name); # Detaint data as we have quoted it.
|
|
push(@criteria, "flagtypes.name = $name");
|
|
}
|
|
if ($criteria->{target_type}) {
|
|
# The target type is stored in the database as a one-character string
|
|
# ("a" for attachment and "b" for bug), but this function takes complete
|
|
# names ("attachment" and "bug") for clarity, so we must convert them.
|
|
my $target_type = $criteria->{target_type} eq 'bug'? 'b' : 'a';
|
|
push(@criteria, "flagtypes.target_type = '$target_type'");
|
|
}
|
|
if (exists($criteria->{is_active})) {
|
|
my $is_active = $criteria->{is_active} ? "1" : "0";
|
|
push(@criteria, "flagtypes.is_active = $is_active");
|
|
}
|
|
if ($criteria->{product_id} && $criteria->{'component_id'}) {
|
|
my $product_id = $criteria->{product_id};
|
|
my $component_id = $criteria->{component_id};
|
|
|
|
# Add inclusions to the query, which simply involves joining the table
|
|
# by flag type ID and target product/component.
|
|
push(@$tables, "INNER JOIN flaginclusions AS i ON flagtypes.id = i.type_id");
|
|
push(@criteria, "(i.product_id = $product_id OR i.product_id IS NULL)");
|
|
push(@criteria, "(i.component_id = $component_id OR i.component_id IS NULL)");
|
|
|
|
# Add exclusions to the query, which is more complicated. First of all,
|
|
# we do a LEFT JOIN so we don't miss flag types with no exclusions.
|
|
# Then, as with inclusions, we join on flag type ID and target product/
|
|
# component. However, since we want flag types that *aren't* on the
|
|
# exclusions list, we add a WHERE criteria to use only records with
|
|
# NULL exclusion type, i.e. without any exclusions.
|
|
my $join_clause = "flagtypes.id = e.type_id " .
|
|
"AND (e.product_id = $product_id OR e.product_id IS NULL) " .
|
|
"AND (e.component_id = $component_id OR e.component_id IS NULL)";
|
|
push(@$tables, "LEFT JOIN flagexclusions AS e ON ($join_clause)");
|
|
push(@criteria, "e.type_id IS NULL");
|
|
}
|
|
if ($criteria->{group}) {
|
|
my $gid = $criteria->{group};
|
|
detaint_natural($gid);
|
|
push(@criteria, "(flagtypes.grant_group_id = $gid " .
|
|
" OR flagtypes.request_group_id = $gid)");
|
|
}
|
|
|
|
return @criteria;
|
|
}
|
|
|
|
1;
|
|
|
|
=end private
|
|
|
|
=head1 SEE ALSO
|
|
|
|
=over
|
|
|
|
=item B<Bugzilla::Flags>
|
|
|
|
=back
|
|
|
|
=head1 CONTRIBUTORS
|
|
|
|
=over
|
|
|
|
=item Myk Melez <myk@mozilla.org>
|
|
|
|
=item Kevin Benton <kevin.benton@amd.com>
|
|
|
|
=item Frédéric Buclin <LpSolit@gmail.com>
|
|
|
|
=back
|
|
|
|
=cut
|