1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
6 # <sales@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
13 # This work is made available to you under the terms of Version 2 of
14 # the GNU General Public License. A copy of that license should have
15 # been provided with this software, but in any event can be snarfed
18 # This work is distributed in the hope that it will be useful, but
19 # WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 # General Public License for more details.
23 # You should have received a copy of the GNU General Public License
24 # along with this program; if not, write to the Free Software
25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26 # 02110-1301 or visit their web page on the internet at
27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
30 # CONTRIBUTION SUBMISSION POLICY:
32 # (The following paragraph is not intended to limit the rights granted
33 # to you to modify and distribute this software under the terms of
34 # the GNU General Public License and is only of importance to you if
35 # you choose to contribute your changes and enhancements to the
36 # community by submitting them to Best Practical Solutions, LLC.)
38 # By intentionally submitting any modifications, corrections or
39 # derivatives to this work, or any other work intended for use with
40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
41 # you are the copyright holder for those contributions and you grant
42 # Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
43 # royalty-free, perpetual, license to use, copy, create derivative
44 # works based on those contributions, and sublicense and distribute
45 # those contributions and any derivatives thereof.
47 # END BPS TAGGED BLOCK }}}
51 RT::SearchBuilder - a baseclass for RT collection objects
65 package RT::SearchBuilder;
68 use DBIx::SearchBuilder "1.50";
73 use base qw(DBIx::SearchBuilder RT::Base);
78 $self->{'user'} = shift;
79 unless(defined($self->CurrentUser)) {
81 Carp::confess("$self was created without a CurrentUser");
82 $RT::Logger->err("$self was created without a CurrentUser");
85 $self->SUPER::_Init( 'Handle' => $RT::Handle);
92 next if defined $s->{FIELD} and $s->{FIELD} =~ /\W/;
93 $s->{FIELD} = $s->{FUNCTION} if $s->{FUNCTION};
96 return $self->SUPER::OrderByCols( @sort );
101 Only find items that haven't been disabled
108 $self->{'handled_disabled_column'} = 1;
109 $self->Limit( FIELD => 'Disabled', VALUE => '0' );
112 =head2 LimitToDeleted
114 Only find items that have been deleted.
121 $self->{'handled_disabled_column'} = $self->{'find_disabled_rows'} = 1;
122 $self->Limit( FIELD => 'Disabled', VALUE => '1' );
127 Find all matching rows, regardless of whether they are disabled or not
132 shift->{'find_disabled_rows'} = 1;
135 =head2 LimitAttribute PARAMHASH
137 Takes NAME, OPERATOR and VALUE to find records that has the
140 If EMPTY is set, also select rows with an empty string as
143 If NULL is set, also select rows without the named Attribute.
154 'LIKE' => 'NOT LIKE',
155 'NOT LIKE' => 'LIKE',
161 my ($self, %args) = @_;
162 my $clause = 'ALIAS';
163 my $operator = ($args{OPERATOR} || '=');
165 if ($args{NULL} and exists $args{VALUE}) {
166 $clause = 'LEFTJOIN';
167 $operator = $Negate{$operator};
169 elsif ($args{NEGATE}) {
170 $operator = $Negate{$operator};
173 my $alias = $self->Join(
175 ALIAS1 => $args{ALIAS} || 'main',
177 TABLE2 => 'Attributes',
181 my $type = ref($self);
182 $type =~ s/(?:s|Collection)$//; # XXX - Hack!
186 FIELD => 'ObjectType',
194 VALUE => $args{NAME},
195 ) if exists $args{NAME};
197 return unless exists $args{VALUE};
202 OPERATOR => $operator,
203 VALUE => $args{VALUE},
206 # Capture rows with the attribute defined as an empty string.
212 ENTRYAGGREGATOR => $args{NULL} ? 'AND' : 'OR',
215 # Capture rows without the attribute defined
220 OPERATOR => ($args{NEGATE} ? 'IS NOT' : 'IS'),
225 =head2 LimitCustomField
227 Takes a paramhash of key/value pairs with the following keys:
231 =item CUSTOMFIELD - CustomField id. Optional
233 =item OPERATOR - The usual Limit operators
235 =item VALUE - The value to compare against
243 my $class = ref($self);
244 $class =~ s/s$// or die "Cannot deduce SingularClass for $class";
248 sub LimitCustomField {
250 my %args = ( VALUE => undef,
251 CUSTOMFIELD => undef,
255 my $alias = $self->Join(
259 TABLE2 => 'ObjectCustomFieldValues',
264 FIELD => 'CustomField',
266 VALUE => $args{'CUSTOMFIELD'},
267 ) if ($args{'CUSTOMFIELD'});
270 FIELD => 'ObjectType',
272 VALUE => $self->_SingularClass,
277 OPERATOR => $args{'OPERATOR'},
278 VALUE => $args{'VALUE'},
282 =head2 Limit PARAMHASH
284 This Limit sub calls SUPER::Limit, but defaults "CASESENSITIVE" to 1, thus
285 making sure that by default lots of things don't do extra work trying to
286 match lower(colname) agaist lc($val);
288 We also force VALUE to C<NULL> when the OPERATOR is C<IS> or C<IS NOT>.
289 This ensures that we don't pass invalid SQL to the database or allow SQL
290 injection attacks when we pass through user specified values.
302 # We use the same regex here that DBIx::SearchBuilder uses to exclude
303 # values from quoting
304 if ( $ARGS{'OPERATOR'} =~ /IS/i ) {
305 # Don't pass anything but NULL for IS and IS NOT
306 $ARGS{'VALUE'} = 'NULL';
309 if ($ARGS{FUNCTION}) {
310 ($ARGS{ALIAS}, $ARGS{FIELD}) = split /\./, delete $ARGS{FUNCTION}, 2;
311 $self->SUPER::Limit(%ARGS);
312 } elsif ($ARGS{FIELD} =~ /\W/
313 or $ARGS{OPERATOR} !~ /^(=|<|>|!=|<>|<=|>=
315 |(NOT\s*)?(STARTS|ENDS)WITH
319 $RT::Logger->crit("Possible SQL injection attack: $ARGS{FIELD} $ARGS{OPERATOR}");
327 $self->SUPER::Limit(%ARGS);
333 If it has a SortOrder attribute, sort the array by SortOrder.
334 Otherwise, if it has a "Name" attribute, sort alphabetically by Name
335 Otherwise, just give up and return it in the order it came from the
344 if ($self->NewItem()->_Accessible('SortOrder','read')) {
345 $items = [ sort { $a->SortOrder <=> $b->SortOrder } @{$items} ];
347 elsif ($self->NewItem()->_Accessible('Name','read')) {
348 $items = [ sort { lc($a->Name) cmp lc($b->Name) } @{$items} ];
356 Return this object's ItemsArray, in the order that ItemsOrderBy sorts
363 return $self->ItemsOrderBy($self->SUPER::ItemsArrayRef());
366 # make sure that Disabled rows never get seen unless
367 # we're explicitly trying to see them.
372 if ( $self->{'with_disabled_column'}
373 && !$self->{'handled_disabled_column'}
374 && !$self->{'find_disabled_rows'}
376 $self->LimitToEnabled;
378 return $self->SUPER::_DoSearch(@_);
383 if ( $self->{'with_disabled_column'}
384 && !$self->{'handled_disabled_column'}
385 && !$self->{'find_disabled_rows'}
387 $self->LimitToEnabled;
389 return $self->SUPER::_DoCount(@_);
392 RT::Base->_ImportOverlays();