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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
|
# BEGIN BPS TAGGED BLOCK {{{
#
# COPYRIGHT:
#
# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
# <sales@bestpractical.com>
#
# (Except where explicitly superseded by other copyright notices)
#
#
# LICENSE:
#
# This work is made available to you under the terms of Version 2 of
# the GNU General Public License. A copy of that license should have
# been provided with this software, but in any event can be snarfed
# from www.gnu.org.
#
# This work is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 or visit their web page on the internet at
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
#
#
# CONTRIBUTION SUBMISSION POLICY:
#
# (The following paragraph is not intended to limit the rights granted
# to you to modify and distribute this software under the terms of
# the GNU General Public License and is only of importance to you if
# you choose to contribute your changes and enhancements to the
# community by submitting them to Best Practical Solutions, LLC.)
#
# By intentionally submitting any modifications, corrections or
# derivatives to this work, or any other work intended for use with
# Request Tracker, to Best Practical Solutions, LLC, you confirm that
# you are the copyright holder for those contributions and you grant
# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
# royalty-free, perpetual, license to use, copy, create derivative
# works based on those contributions, and sublicense and distribute
# those contributions and any derivatives thereof.
#
# END BPS TAGGED BLOCK }}}
=head1 NAME
RT::CustomFields - a collection of RT CustomField objects
=head1 SYNOPSIS
use RT::CustomFields;
=head1 DESCRIPTION
=head1 METHODS
=cut
package RT::CustomFields;
use strict;
use warnings;
use base 'RT::SearchBuilder';
use RT::CustomField;
sub Table { 'CustomFields'}
sub _Init {
my $self = shift;
# By default, order by SortOrder
$self->OrderByCols(
{ ALIAS => 'main',
FIELD => 'SortOrder',
ORDER => 'ASC' },
{ ALIAS => 'main',
FIELD => 'Name',
ORDER => 'ASC' },
{ ALIAS => 'main',
FIELD => 'id',
ORDER => 'ASC' },
);
$self->{'with_disabled_column'} = 1;
return ( $self->SUPER::_Init(@_) );
}
=head2 LimitToGrouping
Limits this collection object to custom fields which appear under a
specified grouping by calling L</Limit> for each CF name as appropriate.
Requires an L<RT::Record> object or class name as the first argument and
accepts a grouping name as the second. If the grouping name is false
(usually via the empty string), limits to custom fields which appear in no
grouping.
I<Caveat:> While the record object or class name is used to find the
available groupings, no automatic limit is placed on the lookup type of
the custom fields. It's highly suggested you limit the collection by
queue or another lookup type first. This is already done for you if
you're creating the collection via the L</CustomFields> method on an
L<RT::Record> object.
=cut
sub LimitToGrouping {
my $self = shift;
my $obj = shift;
my $grouping = shift;
my $grouping_class = $self->NewItem->_GroupingClass($obj);
my $config = RT->Config->Get('CustomFieldGroupings');
$config = {} unless ref($config) eq 'HASH';
$config = $config->{$grouping_class} || [];
my %h = ref $config eq "ARRAY" ? @{$config} : %{$config};
if ( $grouping ) {
my $list = $h{$grouping};
unless ( $list and ref($list) eq 'ARRAY' and @$list ) {
return $self->Limit( FIELD => 'id', VALUE => 0, ENTRYAGGREGATOR => 'AND' );
}
$self->Limit(
FIELD => 'Name',
FUNCTION => 'LOWER(?)',
OPERATOR => 'IN',
VALUE => [map {lc $_} @{$list}],
CASESENSITIVE => 1,
);
} else {
my @list = map {@$_} grep defined && ref($_) eq 'ARRAY',
values %h;
return unless @list;
$self->Limit(
FIELD => 'Name',
FUNCTION => 'LOWER(?)',
OPERATOR => 'NOT IN',
VALUE => [ map {lc $_} @list ],
CASESENSITIVE => 1,
);
}
return;
}
=head2 LimitToLookupType
Takes LookupType and limits collection.
=cut
sub LimitToLookupType {
my $self = shift;
my $lookup = shift;
$self->Limit( FIELD => 'LookupType', VALUE => "$lookup" );
}
=head2 LimitToChildType
Takes partial LookupType and limits collection to records
where LookupType is equal or ends with the value.
=cut
sub LimitToChildType {
my $self = shift;
my $lookup = shift;
$self->Limit( FIELD => 'LookupType', VALUE => "$lookup", OPERATOR => "ENDSWITH" );
}
=head2 LimitToParentType
Takes partial LookupType and limits collection to records
where LookupType is equal or starts with the value.
=cut
sub LimitToParentType {
my $self = shift;
my $lookup = shift;
$self->Limit( FIELD => 'LookupType', VALUE => "$lookup", OPERATOR => "STARTSWITH" );
}
=head2 LimitToObjectId
Takes an ObjectId and limits the collection to CFs applied to said object.
When called multiple times the ObjectId limits are joined with OR.
=cut
sub LimitToObjectId {
my $self = shift;
my $id = shift;
$self->Limit(
ALIAS => $self->_OCFAlias,
FIELD => 'ObjectId',
OPERATOR => '=',
VALUE => $id || 0,
ENTRYAGGREGATOR => 'OR'
);
}
=head2 LimitToGlobalOrObjectId
Takes list of object IDs and limits collection to custom
fields that are added to these objects or globally.
=cut
sub LimitToGlobalOrObjectId {
my $self = shift;
my $global_only = 1;
foreach my $id (@_) {
$self->LimitToObjectId($id);
$global_only = 0 if $id;
}
$self->LimitToObjectId(0) unless $global_only;
}
=head2 LimitToNotAdded
Takes either list of object ids or nothing. Limits collection
to custom fields to listed objects or any corespondingly. Use
zero to mean global.
=cut
sub LimitToNotAdded {
my $self = shift;
return RT::ObjectCustomFields->new( $self->CurrentUser )
->LimitTargetToNotAdded( $self => @_ );
}
=head2 LimitToAdded
Limits collection to custom fields to listed objects or any corespondingly. Use
zero to mean global.
=cut
sub LimitToAdded {
my $self = shift;
return RT::ObjectCustomFields->new( $self->CurrentUser )
->LimitTargetToAdded( $self => @_ );
}
=head2 LimitToGlobalOrQueue QUEUEID
Limits the set of custom fields found to global custom fields or those
tied to the queue C<QUEUEID>, similar to L</LimitToGlobalOrObjectId>.
Note that this will cause the collection to only return ticket CFs.
=cut
sub LimitToGlobalOrQueue {
my $self = shift;
my $queue = shift;
$self->LimitToGlobalOrObjectId( $queue );
$self->LimitToLookupType( 'RT::Queue-RT::Ticket' );
}
=head2 LimitToQueue QUEUEID
Takes a numeric C<QUEUEID>, and limits the Custom Field collection to
those only applied directly to it; this limit is OR'd with other
L</LimitToQueue> and L</LimitToGlobal> limits.
Note that this will cause the collection to only return ticket CFs.
=cut
sub LimitToQueue {
my $self = shift;
my $queue = shift;
$self->Limit (ALIAS => $self->_OCFAlias,
ENTRYAGGREGATOR => 'OR',
FIELD => 'ObjectId',
VALUE => "$queue")
if defined $queue;
$self->LimitToLookupType( 'RT::Queue-RT::Ticket' );
}
=head2 LimitToGlobal
Limits the Custom Field collection to global ticket CFs; this limit is
OR'd with L</LimitToQueue> limits.
Note that this will cause the collection to only return ticket CFs.
=cut
sub LimitToGlobal {
my $self = shift;
$self->Limit (ALIAS => $self->_OCFAlias,
ENTRYAGGREGATOR => 'OR',
FIELD => 'ObjectId',
VALUE => 0);
$self->LimitToLookupType( 'RT::Queue-RT::Ticket' );
}
=head2 ApplySortOrder
Sort custom fields according to thier order application to objects. It's
expected that collection contains only records of one
L<RT::CustomField/LookupType> and applied to one object or globally
(L</LimitToGlobalOrObjectId>), otherwise sorting makes no sense.
=cut
sub ApplySortOrder {
my $self = shift;
my $order = shift || 'ASC';
$self->OrderByCols( {
ALIAS => $self->_OCFAlias,
FIELD => 'SortOrder',
ORDER => $order,
} );
}
=head2 ContextObject
Returns context object for this collection of custom fields,
but only if it's defined.
=cut
sub ContextObject {
my $self = shift;
return $self->{'context_object'};
}
=head2 SetContextObject
Sets context object for this collection of custom fields.
=cut
sub SetContextObject {
my $self = shift;
return $self->{'context_object'} = shift;
}
sub _OCFAlias {
my $self = shift;
return RT::ObjectCustomFields->new( $self->CurrentUser )
->JoinTargetToThis( $self => @_ );
}
=head2 AddRecord
Overrides the collection to ensure that only custom fields the user can
see are returned; also propagates down the L</ContextObject>.
=cut
sub AddRecord {
my $self = shift;
my ($record) = @_;
$record->SetContextObject( $self->ContextObject );
return unless $record->CurrentUserHasRight('SeeCustomField');
return $self->SUPER::AddRecord( $record );
}
=head2 NewItem
Returns an empty new RT::CustomField item
Overrides <RT::SearchBuilder/NewItem> to make sure </ContextObject>
is inherited.
=cut
sub NewItem {
my $self = shift;
my $res = RT::CustomField->new($self->CurrentUser);
$res->SetContextObject($self->ContextObject);
return $res;
}
RT::Base->_ImportOverlays();
1;
|