1 # {{{ BEGIN BPS TAGGED BLOCK
5 # This software is Copyright (c) 1996-2004 Best Practical Solutions, LLC
6 # <jesse@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., 675 Mass Ave, Cambridge, MA 02139, USA.
28 # CONTRIBUTION SUBMISSION POLICY:
30 # (The following paragraph is not intended to limit the rights granted
31 # to you to modify and distribute this software under the terms of
32 # the GNU General Public License and is only of importance to you if
33 # you choose to contribute your changes and enhancements to the
34 # community by submitting them to Best Practical Solutions, LLC.)
36 # By intentionally submitting any modifications, corrections or
37 # derivatives to this work, or any other work intended for use with
38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
39 # you are the copyright holder for those contributions and you grant
40 # Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
41 # royalty-free, perpetual, license to use, copy, create derivative
42 # works based on those contributions, and sublicense and distribute
43 # those contributions and any derivatives thereof.
45 # }}} END BPS TAGGED BLOCK
51 # Import configuration data from the lexcial scope of __PACKAGE__ (or
52 # at least where those two Subroutines are defined.)
54 my %FIELDS = %{FIELDS()};
55 my %dispatch = %{dispatch()};
56 my %can_bundle = %{can_bundle()};
58 # Lower Case version of FIELDS, for case insensitivity
59 my %lcfields = map { ( lc($_) => $_ ) } (keys %FIELDS);
64 # How many of these do we actually still use?
66 # Private Member Variales (which should get cleaned)
67 $self->{'_sql_linksc'} = 0;
68 $self->{'_sql_watchersc'} = 0;
69 $self->{'_sql_keywordsc'} = 0;
70 $self->{'_sql_subclause'} = "a";
71 $self->{'_sql_first'} = 0;
72 $self->{'_sql_opstack'} = [''];
73 $self->{'_sql_linkalias'} = undef;
74 $self->{'_sql_transalias'} = undef;
75 $self->{'_sql_trattachalias'} = undef;
76 $self->{'_sql_keywordalias'} = undef;
77 $self->{'_sql_depth'} = 0;
78 $self->{'_sql_localdepth'} = 0;
79 $self->{'_sql_query'} = '';
80 $self->{'_sql_looking_at'} = {};
81 $self->{'_sql_columns_to_display'} = [];
88 if ($args{'FIELD'} eq 'EffectiveId') {
89 $self->{'looking_at_effective_id'} = 1;
92 if ($args{'FIELD'} eq 'Type') {
93 $self->{'looking_at_type'} = 1;
96 # All SQL stuff goes into one SB subclause so we can deal with all
98 $self->SUPER::Limit(%args,
99 SUBCLAUSE => 'ticketsql');
103 # All SQL stuff goes into one SB subclause so we can deal with all
107 $this->SUPER::Join(@_,
108 SUBCLAUSE => 'ticketsql');
113 $_[0]->SUPER::_OpenParen( 'ticketsql' );
116 $_[0]->SUPER::_CloseParen( 'ticketsql' );
123 =head2 Robert's Simple SQL Parser
125 Documentation In Progress
127 The Parser/Tokenizer is a relatively simple state machine that scans through a SQL WHERE clause type string extracting a token at a time (where a token is:
129 VALUE -> quoted string or number
130 AGGREGator -> AND or OR
131 KEYWORD -> quoted string or single word
132 OPerator -> =,!=,LIKE,etc..
133 PARENthesis -> open or close.
135 And that stream of tokens is passed through the "machine" in order to build up a structure that looks like:
141 That also deals with parenthesis for nesting. (The parentheses are
142 just handed off the SearchBuilder)
146 use Regexp::Common qw /delimited/;
149 use constant VALUE => 1;
150 use constant AGGREG => 2;
151 use constant OP => 4;
152 use constant PAREN => 8;
153 use constant KEYWORD => 16;
154 my @tokens = qw[VALUE AGGREG OP PAREN KEYWORD];
156 my $re_aggreg = qr[(?i:AND|OR)];
157 my $re_value = qr[$RE{delimited}{-delim=>qq{\'\"}}|\d+];
158 my $re_keyword = qr[$RE{delimited}{-delim=>qq{\'\"}}|(?:\{|\}|\w|\.)+];
159 my $re_op = qr[=|!=|>=|<=|>|<|(?i:IS NOT)|(?i:IS)|(?i:NOT LIKE)|(?i:LIKE)]; # long to short
160 my $re_paren = qr'\(|\)';
164 my ($self, @bundle) = @_;
165 return unless @bundle;
167 $bundle[0]->{dispatch}->(
173 ENTRYAGGREGATOR => $bundle[0]->{ea},
174 SUBKEY => $bundle[0]->{subkey},
178 for my $chunk (@bundle) {
184 ENTRYAGGREGATOR => $chunk->{ea},
185 SUBKEY => $chunk->{subkey},
188 $bundle[0]->{dispatch}->(
195 my ($self,$string) = @_;
196 my $want = KEYWORD | PAREN;
202 my ($ea,$key,$op,$value) = ("","","","");
204 # order of matches in the RE is important.. op should come early,
205 # because it has spaces in it. otherwise "NOT LIKE" might be parsed
206 # as a keyword or value.
222 # Highest priority is last
223 $current = OP if $val =~ /^$re_op$/io;
224 $current = VALUE if $val =~ /^$re_value$/io;
225 $current = KEYWORD if $val =~ /^$re_keyword$/io && ($want & KEYWORD);
226 $current = AGGREG if $val =~ /^$re_aggreg$/io;
227 $current = PAREN if $val =~ /^$re_paren$/io;
230 unless ($current && $want & $current) {
232 # FIXME: I will only print out the highest $want value
233 die "Error near ->$val<- expecting a ", $tokens[((log $want)/(log 2))], " in $string\n";
238 #$RT::Logger->debug("We've just found a '$current' called '$val'");
240 # Parens are highest priority
241 if ($current & PAREN) {
243 $self->_close_bundle(@bundle); @bundle = ();
248 $self->_close_bundle(@bundle); @bundle = ();
253 $want = KEYWORD | PAREN | AGGREG;
256 elsif ( $current & AGGREG ) {
258 $want = KEYWORD | PAREN;
260 elsif ( $current & KEYWORD ) {
264 elsif ( $current & OP ) {
268 elsif ( $current & VALUE ) {
271 # Remove surrounding quotes from $key, $val
272 # (in future, simplify as for($key,$val) { action on $_ })
273 if ($key =~ /$RE{delimited}{-delim=>qq{\'\"}}/) {
274 substr($key,0,1) = "";
275 substr($key,-1,1) = "";
277 if ($val =~ /$RE{delimited}{-delim=>qq{\'\"}}/) {
278 substr($val,0,1) = "";
279 substr($val,-1,1) = "";
281 # Unescape escaped characters
282 $key =~ s!\\(.)!$1!g;
283 $val =~ s!\\(.)!$1!g;
284 # print "$ea Key=[$key] op=[$op] val=[$val]\n";
288 if ($key =~ /^(.+?)\.(.+)$/) {
294 if (exists $lcfields{lc $key}) {
295 $key = $lcfields{lc $key};
296 $class = $FIELDS{$key}->[0];
298 # no longer have a default, since CF's are now a real class, not fallthrough
299 # fixme: "default class" is not Generic.
302 die "Unknown field: $key" unless $class;
304 $self->{_sql_localdepth} = 0;
305 die "No such dispatch method: $class"
306 unless exists $dispatch{$class};
307 my $sub = $dispatch{$class} || die;;
308 if ($can_bundle{$class} &&
310 ($bundle[-1]->{dispatch} == $sub &&
311 $bundle[-1]->{key} eq $key &&
312 $bundle[-1]->{subkey} eq $subkey)))
323 $self->_close_bundle(@bundle); @bundle = ();
329 SUBCLAUSE => "", # don't need anymore
330 ENTRYAGGREGATOR => $ea || "",
335 $self->{_sql_looking_at}{lc $key} = 1;
337 ($ea,$key,$op,$value) = ("","","","");
339 $want = PAREN | AGGREG;
347 $self->_close_bundle(@bundle); @bundle = ();
349 die "Incomplete query"
350 unless (($want | PAREN) || ($want | KEYWORD));
352 die "Incomplete Query"
353 unless ($last && ($last | PAREN) || ($last || VALUE));
355 # This will never happen, because the parser will complain
356 die "Mismatched parentheses"
371 for my $f (keys %{$clauses}) {
375 # Build SQL from the data hash
376 for my $data ( @{ $clauses->{$f} } ) {
377 $sql .= $data->[0] unless $first; $first=0;
378 $sql .= " '". $data->[2] . "' ";
379 $sql .= $data->[3] . " ";
380 $sql .= "'". $data->[4] . "' ";
383 push @sql, " ( " . $sql . " ) ";
386 return join("AND",@sql);
391 Convert a RT-SQL string into a set of SearchBuilder restrictions.
393 Returns (1, 'Status message') on success and (0, 'Error Message') on
403 my $tix = RT::Tickets->new($RT::SystemUser);
405 my $query = "Status = 'open'";
406 my ($id, $msg) = $tix->FromSQL($query);
411 my (@ids, @expectedids);
413 my $t = RT::Ticket->new($RT::SystemUser);
415 my $string = 'subject/content SQL test';
416 ok( $t->Create(Queue => 'General', Subject => $string), "Ticket Created");
420 my $Message = MIME::Entity->build(
421 Subject => 'this is my subject',
422 From => 'jesse@example.com',
426 ok( $t->Create(Queue => 'General', Subject => 'another ticket', MIMEObj => $Message, MemberOf => $ids[0]), "Ticket Created");
430 $query = ("Subject LIKE '$string' OR Content LIKE '$string'");
432 my ($id, $msg) = $tix->FromSQL($query);
436 is ($tix->Count, scalar @ids, "number of returned tickets same as entered");
438 while (my $tick = $tix->Next) {
439 push @expectedids, $tick->Id;
442 ok (eq_array(\@ids, \@expectedids), "returned expected tickets");
444 $query = ("id = $ids[0] OR MemberOf = $ids[0]");
446 my ($id, $msg) = $tix->FromSQL($query);
450 is ($tix->Count, scalar @ids, "number of returned tickets same as entered");
453 while (my $tick = $tix->Next) {
454 push @expectedids, $tick->Id;
457 ok (eq_array(\@ids, \@expectedids), "returned expected tickets");
465 my ($self,$query) = @_;
468 # preserve first_row and show_rows across the CleanSlate
469 local($self->{'first_row'}, $self->{'show_rows'});
474 return (1,$self->loc("No Query")) unless $query;
476 $self->{_sql_query} = $query;
477 eval { $self->_parser( $query ); };
479 $RT::Logger->error( $@ );
482 # We only want to look at EffectiveId's (mostly) for these searches.
483 unless (exists $self->{_sql_looking_at}{'effectiveid'}) {
484 $self->SUPER::Limit( FIELD => 'EffectiveId',
485 ENTRYAGGREGATOR => 'AND',
489 ); #TODO, we shouldn't be hard #coding the tablename to main.
491 # FIXME: Need to bring this logic back in
493 # if ($self->_isLimited && (! $self->{'looking_at_effective_id'})) {
494 # $self->SUPER::Limit( FIELD => 'EffectiveId',
497 # VALUE => 'main.id'); #TODO, we shouldn't be hard coding the tablename to main.
499 # --- This is hardcoded above. This comment block can probably go.
500 # Or, we need to reimplement the looking_at_effective_id toggle.
502 # Unless we've explicitly asked to look at a specific Type, we need
504 unless ($self->{looking_at_type}) {
505 $self->SUPER::Limit( FIELD => 'Type', OPERATOR => '=', VALUE => 'ticket');
508 # We never ever want to show deleted tickets
509 $self->SUPER::Limit(FIELD => 'Status' , OPERATOR => '!=', VALUE => 'deleted');
512 # set SB's dirty flag
513 $self->{'must_redo_search'} = 1;
514 $self->{'RecalcTicketLimits'} = 0;
516 return (1,$self->loc("Valid Query"));
522 Returns the query that this object was initialized with
528 return ($self->{_sql_query});
539 Most of the RT code does not use Exceptions (die/eval) but it is used
540 in the TicketSQL code for simplicity and historical reasons. Lest you
541 be worried that the dies will trigger user visible errors, all are
544 99% of the dies fall in subroutines called via FromSQL and then parse.
545 (This includes all of the _FooLimit routines in Tickets_Overlay.pm.)
546 The other 1% or so are via _ProcessRestrictions.
548 All dies are trapped by eval {}s, and will be logged at the 'error'
549 log level. The general failure mode is to not display any tickets.
555 Legacy LimitFoo routines build up a RestrictionsHash
557 _ProcessRestrictions converts the Restrictions to Clauses
560 Clauses are converted to RT-SQL (TicketSQL)
564 FromSQL calls the parser
566 The parser calls the _FooLimit routines to do DBIx::SearchBuilder
569 And then the normal SearchBuilder/Ticket routines are used for