Initial commit 4.0.5-3
[usit-rt.git] / lib / RT / SearchBuilder.pm
1 # BEGIN BPS TAGGED BLOCK {{{
2 #
3 # COPYRIGHT:
4 #
5 # This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
6 #                                          <sales@bestpractical.com>
7 #
8 # (Except where explicitly superseded by other copyright notices)
9 #
10 #
11 # LICENSE:
12 #
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
16 # from www.gnu.org.
17 #
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.
22 #
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.
28 #
29 #
30 # CONTRIBUTION SUBMISSION POLICY:
31 #
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.)
37 #
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.
46 #
47 # END BPS TAGGED BLOCK }}}
48
49 =head1 NAME
50
51   RT::SearchBuilder - a baseclass for RT collection objects
52
53 =head1 SYNOPSIS
54
55 =head1 DESCRIPTION
56
57
58 =head1 METHODS
59
60
61
62
63 =cut
64
65 package RT::SearchBuilder;
66
67 use RT::Base;
68 use DBIx::SearchBuilder "1.40";
69
70 use strict;
71 use warnings;
72
73
74 use base qw(DBIx::SearchBuilder RT::Base);
75
76 sub _Init  {
77     my $self = shift;
78     
79     $self->{'user'} = shift;
80     unless(defined($self->CurrentUser)) {
81         use Carp;
82         Carp::confess("$self was created without a CurrentUser");
83         $RT::Logger->err("$self was created without a CurrentUser");
84         return(0);
85     }
86     $self->SUPER::_Init( 'Handle' => $RT::Handle);
87 }
88
89 sub CleanSlate {
90     my $self = shift;
91     $self->{'_sql_aliases'} = {};
92     return $self->SUPER::CleanSlate(@_);
93 }
94
95 sub JoinTransactions {
96     my $self = shift;
97     my %args = ( New => 0, @_ );
98
99     return $self->{'_sql_aliases'}{'transactions'}
100         if !$args{'New'} && $self->{'_sql_aliases'}{'transactions'};
101
102     my $alias = $self->Join(
103         ALIAS1 => 'main',
104         FIELD1 => 'id',
105         TABLE2 => 'Transactions',
106         FIELD2 => 'ObjectId',
107     );
108     $self->RT::SearchBuilder::Limit(
109         LEFTJOIN => $alias,
110         FIELD    => 'ObjectType',
111         VALUE    => ref $self->NewItem,
112     );
113     $self->{'_sql_aliases'}{'transactions'} = $alias
114         unless $args{'New'};
115
116     return $alias;
117 }
118
119 sub OrderByCols {
120     my $self = shift;
121     my @sort;
122     for my $s (@_) {
123         next if defined $s->{FIELD} and $s->{FIELD} =~ /\W/;
124         $s->{FIELD} = $s->{FUNCTION} if $s->{FUNCTION};
125         push @sort, $s;
126     }
127     return $self->SUPER::OrderByCols( @sort );
128 }
129
130 # If we're setting RowsPerPage or FirstRow, ensure we get a natural number or undef.
131 sub RowsPerPage {
132     my $self = shift;
133     return if @_ and defined $_[0] and $_[0] =~ /\D/;
134     return $self->SUPER::RowsPerPage(@_);
135 }
136
137 sub FirstRow {
138     my $self = shift;
139     return if @_ and defined $_[0] and $_[0] =~ /\D/;
140     return $self->SUPER::FirstRow(@_);
141 }
142
143 =head2 LimitToEnabled
144
145 Only find items that haven't been disabled
146
147 =cut
148
149 sub LimitToEnabled {
150     my $self = shift;
151
152     $self->{'handled_disabled_column'} = 1;
153     $self->Limit( FIELD => 'Disabled', VALUE => '0' );
154 }
155
156 =head2 LimitToDeleted
157
158 Only find items that have been deleted.
159
160 =cut
161
162 sub LimitToDeleted {
163     my $self = shift;
164
165     $self->{'handled_disabled_column'} = $self->{'find_disabled_rows'} = 1;
166     $self->Limit( FIELD => 'Disabled', VALUE => '1' );
167 }
168
169 =head2 FindAllRows
170
171 Find all matching rows, regardless of whether they are disabled or not
172
173 =cut
174
175 sub FindAllRows {
176     shift->{'find_disabled_rows'} = 1;
177 }
178
179 =head2 LimitCustomField
180
181 Takes a paramhash of key/value pairs with the following keys:
182
183 =over 4
184
185 =item CUSTOMFIELD - CustomField id. Optional
186
187 =item OPERATOR - The usual Limit operators
188
189 =item VALUE - The value to compare against
190
191 =back
192
193 =cut
194
195 sub _SingularClass {
196     my $self = shift;
197     my $class = ref($self);
198     $class =~ s/s$// or die "Cannot deduce SingularClass for $class";
199     return $class;
200 }
201
202 sub LimitCustomField {
203     my $self = shift;
204     my %args = ( VALUE        => undef,
205                  CUSTOMFIELD  => undef,
206                  OPERATOR     => '=',
207                  @_ );
208
209     my $alias = $self->Join(
210         TYPE       => 'left',
211         ALIAS1     => 'main',
212         FIELD1     => 'id',
213         TABLE2     => 'ObjectCustomFieldValues',
214         FIELD2     => 'ObjectId'
215     );
216     $self->Limit(
217         ALIAS      => $alias,
218         FIELD      => 'CustomField',
219         OPERATOR   => '=',
220         VALUE      => $args{'CUSTOMFIELD'},
221     ) if ($args{'CUSTOMFIELD'});
222     $self->Limit(
223         ALIAS      => $alias,
224         FIELD      => 'ObjectType',
225         OPERATOR   => '=',
226         VALUE      => $self->_SingularClass,
227     );
228     $self->Limit(
229         ALIAS      => $alias,
230         FIELD      => 'Content',
231         OPERATOR   => $args{'OPERATOR'},
232         VALUE      => $args{'VALUE'},
233     );
234 }
235
236 =head2 Limit PARAMHASH
237
238 This Limit sub calls SUPER::Limit, but defaults "CASESENSITIVE" to 1, thus
239 making sure that by default lots of things don't do extra work trying to 
240 match lower(colname) agaist lc($val);
241
242 We also force VALUE to C<NULL> when the OPERATOR is C<IS> or C<IS NOT>.
243 This ensures that we don't pass invalid SQL to the database or allow SQL
244 injection attacks when we pass through user specified values.
245
246 =cut
247
248 sub Limit {
249     my $self = shift;
250     my %ARGS = (
251         CASESENSITIVE => 1,
252         OPERATOR => '=',
253         @_,
254     );
255
256     # We use the same regex here that DBIx::SearchBuilder uses to exclude
257     # values from quoting
258     if ( $ARGS{'OPERATOR'} =~ /IS/i ) {
259         # Don't pass anything but NULL for IS and IS NOT
260         $ARGS{'VALUE'} = 'NULL';
261     }
262
263     if ($ARGS{FUNCTION}) {
264         ($ARGS{ALIAS}, $ARGS{FIELD}) = split /\./, delete $ARGS{FUNCTION}, 2;
265         $self->SUPER::Limit(%ARGS);
266     } elsif ($ARGS{FIELD} =~ /\W/
267           or $ARGS{OPERATOR} !~ /^(=|<|>|!=|<>|<=|>=
268                                   |(NOT\s*)?LIKE
269                                   |(NOT\s*)?(STARTS|ENDS)WITH
270                                   |(NOT\s*)?MATCHES
271                                   |IS(\s*NOT)?
272                                   |IN
273                                   |\@\@)$/ix) {
274         $RT::Logger->crit("Possible SQL injection attack: $ARGS{FIELD} $ARGS{OPERATOR}");
275         $self->SUPER::Limit(
276             %ARGS,
277             FIELD    => 'id',
278             OPERATOR => '<',
279             VALUE    => '0',
280         );
281     } else {
282         $self->SUPER::Limit(%ARGS);
283     }
284 }
285
286 =head2 ItemsOrderBy
287
288 If it has a SortOrder attribute, sort the array by SortOrder.
289 Otherwise, if it has a "Name" attribute, sort alphabetically by Name
290 Otherwise, just give up and return it in the order it came from the
291 db.
292
293 =cut
294
295 sub ItemsOrderBy {
296     my $self = shift;
297     my $items = shift;
298   
299     if ($self->NewItem()->_Accessible('SortOrder','read')) {
300         $items = [ sort { $a->SortOrder <=> $b->SortOrder } @{$items} ];
301     }
302     elsif ($self->NewItem()->_Accessible('Name','read')) {
303         $items = [ sort { lc($a->Name) cmp lc($b->Name) } @{$items} ];
304     }
305
306     return $items;
307 }
308
309 =head2 ItemsArrayRef
310
311 Return this object's ItemsArray, in the order that ItemsOrderBy sorts
312 it.
313
314 =cut
315
316 sub ItemsArrayRef {
317     my $self = shift;
318     return $self->ItemsOrderBy($self->SUPER::ItemsArrayRef());
319 }
320
321 # make sure that Disabled rows never get seen unless
322 # we're explicitly trying to see them.
323
324 sub _DoSearch {
325     my $self = shift;
326
327     if ( $self->{'with_disabled_column'}
328         && !$self->{'handled_disabled_column'}
329         && !$self->{'find_disabled_rows'}
330     ) {
331         $self->LimitToEnabled;
332     }
333     return $self->SUPER::_DoSearch(@_);
334 }
335 sub _DoCount {
336     my $self = shift;
337
338     if ( $self->{'with_disabled_column'}
339         && !$self->{'handled_disabled_column'}
340         && !$self->{'find_disabled_rows'}
341     ) {
342         $self->LimitToEnabled;
343     }
344     return $self->SUPER::_DoCount(@_);
345 }
346
347 =head2 ColumnMapClassName
348
349 ColumnMap needs a Collection name to load the correct list display.
350 Depluralization is hard, so provide an easy way to correct the naive
351 algorithm that this code uses.
352
353 =cut
354
355 sub ColumnMapClassName {
356     my $self = shift;
357     my $Class = ref $self;
358     $Class =~ s/s$//;
359     $Class =~ s/:/_/g;
360     return $Class;
361 }
362
363 RT::Base->_ImportOverlays();
364
365 1;