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
|
# 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.
package Bugzilla::Search::Recent;
use 5.10.1;
use strict;
use parent qw(Bugzilla::Object);
use Bugzilla::Constants;
use Bugzilla::Error;
use Bugzilla::Util;
#############
# Constants #
#############
use constant DB_TABLE => 'profile_search';
use constant LIST_ORDER => 'id DESC';
# Do not track buglists viewed by users.
use constant AUDIT_CREATES => 0;
use constant AUDIT_UPDATES => 0;
use constant AUDIT_REMOVES => 0;
use constant DB_COLUMNS => qw(
id
user_id
bug_list
list_order
);
use constant VALIDATORS => {
user_id => \&_check_user_id,
bug_list => \&_check_bug_list,
list_order => \&_check_list_order,
};
use constant UPDATE_COLUMNS => qw(bug_list list_order);
# There's no gain to caching these objects
use constant USE_MEMCACHED => 0;
###################
# DB Manipulation #
###################
sub create {
my $class = shift;
my $dbh = Bugzilla->dbh;
$dbh->bz_start_transaction();
my $search = $class->SUPER::create(@_);
my $user_id = $search->user_id;
# Enforce there only being SAVE_NUM_SEARCHES per user.
my @ids = @{ $dbh->selectcol_arrayref(
"SELECT id FROM profile_search WHERE user_id = ? ORDER BY id",
undef, $user_id) };
if (scalar(@ids) > SAVE_NUM_SEARCHES) {
splice(@ids, - SAVE_NUM_SEARCHES);
$dbh->do(
"DELETE FROM profile_search WHERE id IN (" . join(',', @ids) . ")");
}
$dbh->bz_commit_transaction();
return $search;
}
sub create_placeholder {
my $class = shift;
return $class->create({ user_id => Bugzilla->user->id,
bug_list => '' });
}
###############
# Constructor #
###############
sub check {
my $class = shift;
my $search = $class->SUPER::check(@_);
my $user = Bugzilla->user;
if ($search->user_id != $user->id) {
ThrowUserError('object_does_not_exist', { id => $search->id });
}
return $search;
}
sub check_quietly {
my $class = shift;
my $error_mode = Bugzilla->error_mode;
Bugzilla->error_mode(ERROR_MODE_DIE);
my $search = eval { $class->check(@_) };
Bugzilla->error_mode($error_mode);
return $search;
}
sub new_from_cookie {
my ($invocant, $bug_ids) = @_;
my $class = ref($invocant) || $invocant;
my $search = { id => 'cookie',
user_id => Bugzilla->user->id,
bug_list => join(',', @$bug_ids) };
bless $search, $class;
return $search;
}
####################
# Simple Accessors #
####################
sub bug_list { return [split(',', $_[0]->{'bug_list'})]; }
sub list_order { return $_[0]->{'list_order'}; }
sub user_id { return $_[0]->{'user_id'}; }
############
# Mutators #
############
sub set_bug_list { $_[0]->set('bug_list', $_[1]); }
sub set_list_order { $_[0]->set('list_order', $_[1]); }
##############
# Validators #
##############
sub _check_user_id {
my ($invocant, $id) = @_;
require Bugzilla::User;
return Bugzilla::User->check({ id => $id })->id;
}
sub _check_bug_list {
my ($invocant, $list) = @_;
my @bug_ids = ref($list) ? @$list : split(',', $list || '');
detaint_natural($_) foreach @bug_ids;
return join(',', @bug_ids);
}
sub _check_list_order { defined $_[1] ? trim($_[1]) : '' }
1;
__END__
=head1 NAME
Bugzilla::Search::Recent - A search recently run by a logged-in user.
=head1 SYNOPSIS
use Bugzilla::Search::Recent;
=head1 DESCRIPTION
This is an implementation of L<Bugzilla::Object>, and so has all the
same methods available as L<Bugzilla::Object>, in addition to what is
documented below.
=head1 B<Methods in need of POD>
=over
=item create
=item list_order
=item check_quietly
=item new_from_cookie
=item create_placeholder
=item bug_list
=item set_bug_list
=item user_id
=item set_list_order
=back
|
