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
|
# -*- 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.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
package Bugzilla::Keyword;
use Bugzilla::Util;
use Bugzilla::Error;
###############################
#### Initialization ####
###############################
use constant DB_COLUMNS => qw(
keyworddefs.id
keyworddefs.name
keyworddefs.description
);
my $columns = join(", ", DB_COLUMNS);
sub new {
my $invocant = shift;
my $class = ref($invocant) || $invocant;
my $self = {};
bless($self, $class);
return $self->_init(@_);
}
sub _init {
my $self = shift;
my ($param) = @_;
my $dbh = Bugzilla->dbh;
my $id = $param unless (ref $param eq 'HASH');
my $keyword;
if (defined $id) {
detaint_natural($id)
|| ThrowCodeError('param_must_be_numeric',
{function => 'Bugzilla::Keyword::_init'});
$keyword = $dbh->selectrow_hashref(qq{
SELECT $columns FROM keyworddefs
WHERE id = ?}, undef, $id);
} elsif (defined $param->{'name'}) {
trick_taint($param->{'name'});
$keyword = $dbh->selectrow_hashref(qq{
SELECT $columns FROM keyworddefs
WHERE name = ?}, undef, $param->{'name'});
} else {
ThrowCodeError('bad_arg',
{argument => 'param',
function => 'Bugzilla::Keyword::_init'});
}
return undef unless (defined $keyword);
foreach my $field (keys %$keyword) {
$self->{$field} = $keyword->{$field};
}
return $self;
}
sub new_from_list {
my $class = shift;
my ($id_list) = @_;
my $dbh = Bugzilla->dbh;
my $keywords;
if ($id_list) {
my @detainted_ids;
foreach my $id (@$id_list) {
detaint_natural($id) ||
ThrowCodeError('param_must_be_numeric',
{function => 'Bugzilla::Keyword::new_from_list'});
push(@detainted_ids, $id);
}
$keywords = $dbh->selectall_arrayref(
"SELECT $columns FROM keyworddefs WHERE id IN ("
. join(',', @detainted_ids) . ")", {Slice=>{}});
} else {
ThrowCodeError('bad_arg',
{argument => 'id_list',
function => 'Bugzilla::Keyword::new_from_list'});
}
foreach my $keyword (@$keywords) {
bless($keyword, $class);
}
return $keywords;
}
###############################
#### Accessors ######
###############################
sub id { return $_[0]->{'id'}; }
sub name { return $_[0]->{'name'}; }
sub description { return $_[0]->{'description'}; }
###############################
#### Subroutines ######
###############################
sub get_all_keywords {
my $dbh = Bugzilla->dbh;
my $ids = $dbh->selectcol_arrayref(q{
SELECT id FROM keyworddefs ORDER BY name});
my $keywords = Bugzilla::Keyword->new_from_list($ids);
return @$keywords;
}
sub keyword_count {
my ($count) =
Bugzilla->dbh->selectrow_array('SELECT COUNT(*) FROM keyworddefs');
return $count;
}
1;
__END__
=head1 NAME
Bugzilla::Keyword - A Keyword that can be added to a bug.
=head1 SYNOPSIS
use Bugzilla::Keyword;
my $keyword = new Bugzilla::Keyword(1);
my $keyword = new Bugzilla::Keyword({name => 'perf'});
my $id = $keyword->id;
my $name = $keyword->name;
my $description = $keyword->description;
=head1 DESCRIPTION
Bugzilla::Keyword represents a keyword that can be added to a bug.
=head1 METHODS
=over
=item C<new($param)>
Description: The constructor is used to load an existing keyword
by passing a keyword id or a hash.
Params: $param - If you pass an integer, the integer is the
keyword id from the database that we want to
read in. If you pass in a hash with 'name' key,
then the value of the name key is the name of a
keyword from the DB.
Returns: A Bugzilla::Keyword object.
=item C<new_from_list(\@id_list)>
Description: Creates an array of Keyword objects, given an
array of ids.
Params: \@id_list - A reference to an array of numbers, keyword ids.
If any of these are not numeric, the function
will throw an error. If any of these are not
valid keyword ids, they will simply be skipped.
Returns: A reference to an array of C<Bugzilla::Keyword> objects.
=back
=head1 SUBROUTINES
=over
=item C<get_all_keywords()>
Description: Returns all keywords from the database.
Params: none.
Returns: A list of C<Bugzilla::Keyword> objects,
or an empty list if there are none.
=item C<keyword_count()>
Description: A utility function to get the total number
of keywords defined. Mostly used to see
if there are any keywords defined at all.
Params: none
Returns: An integer, the count of keywords.
=back
=cut
|
