summaryrefslogtreecommitdiff
path: root/rt/lib/RT/Tickets_SQL.pm
diff options
context:
space:
mode:
Diffstat (limited to 'rt/lib/RT/Tickets_SQL.pm')
-rw-r--r--rt/lib/RT/Tickets_SQL.pm512
1 files changed, 0 insertions, 512 deletions
diff --git a/rt/lib/RT/Tickets_SQL.pm b/rt/lib/RT/Tickets_SQL.pm
deleted file mode 100644
index 77313c3..0000000
--- a/rt/lib/RT/Tickets_SQL.pm
+++ /dev/null
@@ -1,512 +0,0 @@
-# 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 }}}
-
-package RT::Tickets;
-
-use strict;
-use warnings;
-
-
-use RT::SQL;
-
-# Import configuration data from the lexcial scope of __PACKAGE__ (or
-# at least where those two Subroutines are defined.)
-
-our (%FIELD_METADATA, %LOWER_CASE_FIELDS, %dispatch, %can_bundle);
-
-sub _InitSQL {
- my $self = shift;
-
- # Private Member Variables (which should get cleaned)
- $self->{'_sql_transalias'} = undef;
- $self->{'_sql_trattachalias'} = undef;
- $self->{'_sql_cf_alias'} = undef;
- $self->{'_sql_object_cfv_alias'} = undef;
- $self->{'_sql_watcher_join_users_alias'} = undef;
- $self->{'_sql_query'} = '';
- $self->{'_sql_looking_at'} = {};
-}
-
-sub _SQLLimit {
- my $self = shift;
- my %args = (FIELD => '', @_);
- if ($args{'FIELD'} eq 'EffectiveId' &&
- (!$args{'ALIAS'} || $args{'ALIAS'} eq 'main' ) ) {
- $self->{'looking_at_effective_id'} = 1;
- }
-
- if ($args{'FIELD'} eq 'Type' &&
- (!$args{'ALIAS'} || $args{'ALIAS'} eq 'main' ) ) {
- $self->{'looking_at_type'} = 1;
- }
-
- # All SQL stuff goes into one SB subclause so we can deal with all
- # the aggregation
- $self->SUPER::Limit(%args,
- SUBCLAUSE => 'ticketsql');
-}
-
-sub _SQLJoin {
- # All SQL stuff goes into one SB subclause so we can deal with all
- # the aggregation
- my $this = shift;
-
- $this->SUPER::Join(@_,
- SUBCLAUSE => 'ticketsql');
-}
-
-# Helpers
-sub _OpenParen {
- $_[0]->SUPER::_OpenParen( 'ticketsql' );
-}
-sub _CloseParen {
- $_[0]->SUPER::_CloseParen( 'ticketsql' );
-}
-
-=head1 SQL Functions
-
-=cut
-
-=head2 Robert's Simple SQL Parser
-
-Documentation In Progress
-
-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:
-
- VALUE -> quoted string or number
- AGGREGator -> AND or OR
- KEYWORD -> quoted string or single word
- OPerator -> =,!=,LIKE,etc..
- PARENthesis -> open or close.
-
-And that stream of tokens is passed through the "machine" in order to build up a structure that looks like:
-
- KEY OP VALUE
- AND KEY OP VALUE
- OR KEY OP VALUE
-
-That also deals with parenthesis for nesting. (The parentheses are
-just handed off the SearchBuilder)
-
-=cut
-
-sub _close_bundle {
- my ($self, @bundle) = @_;
- return unless @bundle;
-
- if ( @bundle == 1 ) {
- $bundle[0]->{'dispatch'}->(
- $self,
- $bundle[0]->{'key'},
- $bundle[0]->{'op'},
- $bundle[0]->{'val'},
- SUBCLAUSE => '',
- ENTRYAGGREGATOR => $bundle[0]->{ea},
- SUBKEY => $bundle[0]->{subkey},
- );
- }
- else {
- my @args;
- foreach my $chunk (@bundle) {
- push @args, [
- $chunk->{key},
- $chunk->{op},
- $chunk->{val},
- SUBCLAUSE => '',
- ENTRYAGGREGATOR => $chunk->{ea},
- SUBKEY => $chunk->{subkey},
- ];
- }
- $bundle[0]->{dispatch}->( $self, \@args );
- }
-}
-
-sub _parser {
- my ($self,$string) = @_;
- my @bundle;
- my $ea = '';
-
- # Bundling of joins is implemented by dynamically tracking a parallel query
- # tree in %sub_tree as the TicketSQL is parsed. Don't be fooled by
- # _close_bundle(), @bundle, and %can_bundle; they are completely unused for
- # quite a long time and removed in RT 4.2. For now they stay, a useless
- # relic.
- #
- # Only positive, OR'd watcher conditions are bundled currently. Each key
- # in %sub_tree is a watcher type (Requestor, Cc, AdminCc) or the generic
- # "Watcher" for any watcher type. Owner is not bundled because it is
- # denormalized into a Tickets column and doesn't need a join. AND'd
- # conditions are not bundled since a record may have multiple watchers
- # which independently match the conditions, thus necessitating two joins.
- #
- # The values of %sub_tree are arrayrefs made up of:
- #
- # * Open parentheses "(" pushed on by the OpenParen callback
- # * Arrayrefs of bundled join aliases pushed on by the Condition callback
- # * Entry aggregators (AND/OR) pushed on by the EntryAggregator callback
- #
- # The CloseParen callback takes care of backing off the query trees until
- # outside of the just-closed parenthetical, thus restoring the tree state
- # an equivalent of before the parenthetical was entered.
- #
- # The Condition callback handles starting a new subtree or extending an
- # existing one, determining if bundling the current condition with any
- # subtree is possible, and pruning any dangling entry aggregators from
- # trees.
- #
-
- my %sub_tree;
- my $depth = 0;
-
- my %callback;
- $callback{'OpenParen'} = sub {
- $self->_close_bundle(@bundle); @bundle = ();
- $self->_OpenParen;
- $depth++;
- push @$_, '(' foreach values %sub_tree;
- };
- $callback{'CloseParen'} = sub {
- $self->_close_bundle(@bundle); @bundle = ();
- $self->_CloseParen;
- $depth--;
- foreach my $list ( values %sub_tree ) {
- if ( $list->[-1] eq '(' ) {
- pop @$list;
- pop @$list if $list->[-1] =~ /^(?:AND|OR)$/i;
- }
- else {
- pop @$list while $list->[-2] ne '(';
- $list->[-1] = pop @$list;
- }
- }
- };
- $callback{'EntryAggregator'} = sub {
- $ea = $_[0] || '';
- push @$_, $ea foreach grep @$_ && $_->[-1] ne '(', values %sub_tree;
- };
- $callback{'Condition'} = sub {
- my ($key, $op, $value) = @_;
-
- my ($negative_op, $null_op, $inv_op, $range_op)
- = $self->ClassifySQLOperation( $op );
- # key has dot then it's compound variant and we have subkey
- my $subkey = '';
- ($key, $subkey) = ($1, $2) if $key =~ /^([^\.]+)\.(.+)$/;
-
- # normalize key and get class (type)
- my $class;
- if (exists $LOWER_CASE_FIELDS{lc $key}) {
- $key = $LOWER_CASE_FIELDS{lc $key};
- $class = $FIELD_METADATA{$key}->[0];
- }
- die "Unknown field '$key' in '$string'" unless $class;
-
- # replace __CurrentUser__ with id
- $value = $self->CurrentUser->id if $value eq '__CurrentUser__';
-
-
- unless( $dispatch{ $class } ) {
- die "No dispatch method for class '$class'"
- }
- my $sub = $dispatch{ $class };
-
- if ( $can_bundle{ $class }
- && ( !@bundle
- || ( $bundle[-1]->{dispatch} == $sub
- && $bundle[-1]->{key} eq $key
- && $bundle[-1]->{subkey} eq $subkey
- )
- )
- )
- {
- push @bundle, {
- dispatch => $sub,
- key => $key,
- op => $op,
- val => $value,
- ea => $ea,
- subkey => $subkey,
- };
- }
- else {
- $self->_close_bundle(@bundle); @bundle = ();
- my @res; my $bundle_with;
- if ( $class eq 'WATCHERFIELD' && $key ne 'Owner' && !$negative_op && (!$null_op || $subkey) ) {
- if ( !$sub_tree{$key} ) {
- $sub_tree{$key} = [ ('(')x$depth, \@res ];
- } else {
- $bundle_with = $self->_check_bundling_possibility( $string, @{ $sub_tree{$key} } );
- if ( $sub_tree{$key}[-1] eq '(' ) {
- push @{ $sub_tree{$key} }, \@res;
- }
- }
- }
-
- # Remove our aggregator from subtrees where our condition didn't get added
- pop @$_ foreach grep @$_ && $_->[-1] =~ /^(?:AND|OR)$/i, values %sub_tree;
-
- # A reference to @res may be pushed onto $sub_tree{$key} from
- # above, and we fill it here.
- @res = $sub->( $self, $key, $op, $value,
- SUBCLAUSE => '', # don't need anymore
- ENTRYAGGREGATOR => $ea,
- SUBKEY => $subkey,
- BUNDLE => $bundle_with,
- );
- }
- $self->{_sql_looking_at}{lc $key} = 1;
- $ea = '';
- };
- RT::SQL::Parse($string, \%callback);
- $self->_close_bundle(@bundle); @bundle = ();
-}
-
-sub _check_bundling_possibility {
- my $self = shift;
- my $string = shift;
- my @list = reverse @_;
- while (my $e = shift @list) {
- next if $e eq '(';
- if ( lc($e) eq 'and' ) {
- return undef;
- }
- elsif ( lc($e) eq 'or' ) {
- return shift @list;
- }
- else {
- # should not happen
- $RT::Logger->error(
- "Joins optimization failed when parsing '$string'. It's bug in RT, contact Best Practical"
- );
- die "Internal error. Contact your system administrator.";
- }
- }
- return undef;
-}
-
-=head2 ClausesToSQL
-
-=cut
-
-sub ClausesToSQL {
- my $self = shift;
- my $clauses = shift;
- my @sql;
-
- for my $f (keys %{$clauses}) {
- my $sql;
- my $first = 1;
-
- # Build SQL from the data hash
- for my $data ( @{ $clauses->{$f} } ) {
- $sql .= $data->[0] unless $first; $first=0; # ENTRYAGGREGATOR
- $sql .= " '". $data->[2] . "' "; # FIELD
- $sql .= $data->[3] . " "; # OPERATOR
- $sql .= "'". $data->[4] . "' "; # VALUE
- }
-
- push @sql, " ( " . $sql . " ) ";
- }
-
- return join("AND",@sql);
-}
-
-=head2 FromSQL
-
-Convert a RT-SQL string into a set of SearchBuilder restrictions.
-
-Returns (1, 'Status message') on success and (0, 'Error Message') on
-failure.
-
-
-
-
-=cut
-
-sub FromSQL {
- my ($self,$query) = @_;
-
- {
- # preserve first_row and show_rows across the CleanSlate
- local ($self->{'first_row'}, $self->{'show_rows'});
- $self->CleanSlate;
- }
- $self->_InitSQL();
-
- return (1, $self->loc("No Query")) unless $query;
-
- $self->{_sql_query} = $query;
- eval { $self->_parser( $query ); };
- if ( $@ ) {
- my $error = "$@";
- $RT::Logger->error("Couldn't parse query: $error");
- return (0, $error);
- }
-
- # We only want to look at EffectiveId's (mostly) for these searches.
- unless ( exists $self->{_sql_looking_at}{'effectiveid'} ) {
- #TODO, we shouldn't be hard #coding the tablename to main.
- $self->SUPER::Limit( FIELD => 'EffectiveId',
- VALUE => 'main.id',
- ENTRYAGGREGATOR => 'AND',
- QUOTEVALUE => 0,
- );
- }
- # FIXME: Need to bring this logic back in
-
- # if ($self->_isLimited && (! $self->{'looking_at_effective_id'})) {
- # $self->SUPER::Limit( FIELD => 'EffectiveId',
- # OPERATOR => '=',
- # QUOTEVALUE => 0,
- # VALUE => 'main.id'); #TODO, we shouldn't be hard coding the tablename to main.
- # }
- # --- This is hardcoded above. This comment block can probably go.
- # Or, we need to reimplement the looking_at_effective_id toggle.
-
- # Unless we've explicitly asked to look at a specific Type, we need
- # to limit to it.
- unless ( $self->{looking_at_type} ) {
- $self->SUPER::Limit( FIELD => 'Type', VALUE => 'ticket' );
- }
-
- # We don't want deleted tickets unless 'allow_deleted_search' is set
- unless( $self->{'allow_deleted_search'} ) {
- $self->SUPER::Limit( FIELD => 'Status',
- OPERATOR => '!=',
- VALUE => 'deleted',
- );
- }
-
- # set SB's dirty flag
- $self->{'must_redo_search'} = 1;
- $self->{'RecalcTicketLimits'} = 0;
-
- return (1, $self->loc("Valid Query"));
-}
-
-=head2 Query
-
-Returns the query that this object was initialized with
-
-=cut
-
-sub Query {
- return ($_[0]->{_sql_query});
-}
-
-{
-my %inv = (
- '=' => '!=', '!=' => '=', '<>' => '=',
- '>' => '<=', '<' => '>=', '>=' => '<', '<=' => '>',
- 'is' => 'IS NOT', 'is not' => 'IS',
- 'like' => 'NOT LIKE', 'not like' => 'LIKE',
- 'matches' => 'NOT MATCHES', 'not matches' => 'MATCHES',
- 'startswith' => 'NOT STARTSWITH', 'not startswith' => 'STARTSWITH',
- 'endswith' => 'NOT ENDSWITH', 'not endswith' => 'ENDSWITH',
-);
-
-my %range = map { $_ => 1 } qw(> >= < <=);
-
-sub ClassifySQLOperation {
- my $self = shift;
- my $op = shift;
-
- my $is_negative = 0;
- if ( $op eq '!=' || $op =~ /\bNOT\b/i ) {
- $is_negative = 1;
- }
-
- my $is_null = 0;
- if ( 'is not' eq lc($op) || 'is' eq lc($op) ) {
- $is_null = 1;
- }
-
- return ($is_negative, $is_null, $inv{lc $op}, $range{lc $op});
-} }
-
-1;
-
-=pod
-
-=head2 Exceptions
-
-Most of the RT code does not use Exceptions (die/eval) but it is used
-in the TicketSQL code for simplicity and historical reasons. Lest you
-be worried that the dies will trigger user visible errors, all are
-trapped via evals.
-
-99% of the dies fall in subroutines called via FromSQL and then parse.
-(This includes all of the _FooLimit routines in Tickets_Overlay.pm.)
-The other 1% or so are via _ProcessRestrictions.
-
-All dies are trapped by eval {}s, and will be logged at the 'error'
-log level. The general failure mode is to not display any tickets.
-
-=head2 General Flow
-
-Legacy Layer:
-
- Legacy LimitFoo routines build up a RestrictionsHash
-
- _ProcessRestrictions converts the Restrictions to Clauses
- ([key,op,val,rest]).
-
- Clauses are converted to RT-SQL (TicketSQL)
-
-New RT-SQL Layer:
-
- FromSQL calls the parser
-
- The parser calls the _FooLimit routines to do DBIx::SearchBuilder
- limits.
-
-And then the normal SearchBuilder/Ticket routines are used for
-display/navigation.
-
-=cut
-
generated by cgit v1.1 at 2024-06-26 13:09:32 +0000