1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2012 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.40";
74 use base qw(DBIx::SearchBuilder RT::Base);
79 $self->{'user'} = shift;
80 unless(defined($self->CurrentUser)) {
82 Carp::confess("$self was created without a CurrentUser");
83 $RT::Logger->err("$self was created without a CurrentUser");
86 $self->SUPER::_Init( 'Handle' => $RT::Handle);
91 $self->{'_sql_aliases'} = {};
92 return $self->SUPER::CleanSlate(@_);
95 sub JoinTransactions {
97 my %args = ( New => 0, @_ );
99 return $self->{'_sql_aliases'}{'transactions'}
100 if !$args{'New'} && $self->{'_sql_aliases'}{'transactions'};
102 my $alias = $self->Join(
105 TABLE2 => 'Transactions',
106 FIELD2 => 'ObjectId',
108 $self->RT::SearchBuilder::Limit(
110 FIELD => 'ObjectType',
111 VALUE => ref $self->NewItem,
113 $self->{'_sql_aliases'}{'transactions'} = $alias
123 next if defined $s->{FIELD} and $s->{FIELD} =~ /\W/;
124 $s->{FIELD} = $s->{FUNCTION} if $s->{FUNCTION};
127 return $self->SUPER::OrderByCols( @sort );
130 =head2 LimitToEnabled
132 Only find items that haven't been disabled
139 $self->{'handled_disabled_column'} = 1;
140 $self->Limit( FIELD => 'Disabled', VALUE => '0' );
143 =head2 LimitToDeleted
145 Only find items that have been deleted.
152 $self->{'handled_disabled_column'} = $self->{'find_disabled_rows'} = 1;
153 $self->Limit( FIELD => 'Disabled', VALUE => '1' );
158 Find all matching rows, regardless of whether they are disabled or not
163 shift->{'find_disabled_rows'} = 1;
166 =head2 LimitCustomField
168 Takes a paramhash of key/value pairs with the following keys:
172 =item CUSTOMFIELD - CustomField id. Optional
174 =item OPERATOR - The usual Limit operators
176 =item VALUE - The value to compare against
184 my $class = ref($self);
185 $class =~ s/s$// or die "Cannot deduce SingularClass for $class";
189 sub LimitCustomField {
191 my %args = ( VALUE => undef,
192 CUSTOMFIELD => undef,
196 my $alias = $self->Join(
200 TABLE2 => 'ObjectCustomFieldValues',
205 FIELD => 'CustomField',
207 VALUE => $args{'CUSTOMFIELD'},
208 ) if ($args{'CUSTOMFIELD'});
211 FIELD => 'ObjectType',
213 VALUE => $self->_SingularClass,
218 OPERATOR => $args{'OPERATOR'},
219 VALUE => $args{'VALUE'},
223 =head2 Limit PARAMHASH
225 This Limit sub calls SUPER::Limit, but defaults "CASESENSITIVE" to 1, thus
226 making sure that by default lots of things don't do extra work trying to
227 match lower(colname) agaist lc($val);
229 We also force VALUE to C<NULL> when the OPERATOR is C<IS> or C<IS NOT>.
230 This ensures that we don't pass invalid SQL to the database or allow SQL
231 injection attacks when we pass through user specified values.
243 # We use the same regex here that DBIx::SearchBuilder uses to exclude
244 # values from quoting
245 if ( $ARGS{'OPERATOR'} =~ /IS/i ) {
246 # Don't pass anything but NULL for IS and IS NOT
247 $ARGS{'VALUE'} = 'NULL';
250 if ($ARGS{FUNCTION}) {
251 ($ARGS{ALIAS}, $ARGS{FIELD}) = split /\./, delete $ARGS{FUNCTION}, 2;
252 $self->SUPER::Limit(%ARGS);
253 } elsif ($ARGS{FIELD} =~ /\W/
254 or $ARGS{OPERATOR} !~ /^(=|<|>|!=|<>|<=|>=
256 |(NOT\s*)?(STARTS|ENDS)WITH
261 $RT::Logger->crit("Possible SQL injection attack: $ARGS{FIELD} $ARGS{OPERATOR}");
269 $self->SUPER::Limit(%ARGS);
275 If it has a SortOrder attribute, sort the array by SortOrder.
276 Otherwise, if it has a "Name" attribute, sort alphabetically by Name
277 Otherwise, just give up and return it in the order it came from the
286 if ($self->NewItem()->_Accessible('SortOrder','read')) {
287 $items = [ sort { $a->SortOrder <=> $b->SortOrder } @{$items} ];
289 elsif ($self->NewItem()->_Accessible('Name','read')) {
290 $items = [ sort { lc($a->Name) cmp lc($b->Name) } @{$items} ];
298 Return this object's ItemsArray, in the order that ItemsOrderBy sorts
305 return $self->ItemsOrderBy($self->SUPER::ItemsArrayRef());
308 # make sure that Disabled rows never get seen unless
309 # we're explicitly trying to see them.
314 if ( $self->{'with_disabled_column'}
315 && !$self->{'handled_disabled_column'}
316 && !$self->{'find_disabled_rows'}
318 $self->LimitToEnabled;
320 return $self->SUPER::_DoSearch(@_);
325 if ( $self->{'with_disabled_column'}
326 && !$self->{'handled_disabled_column'}
327 && !$self->{'find_disabled_rows'}
329 $self->LimitToEnabled;
331 return $self->SUPER::_DoCount(@_);
334 =head2 ColumnMapClassName
336 ColumnMap needs a Collection name to load the correct list display.
337 Depluralization is hard, so provide an easy way to correct the naive
338 algorithm that this code uses.
342 sub ColumnMapClassName {
344 my $Class = ref $self;
350 RT::Base->_ImportOverlays();