diff options
Diffstat (limited to 'rt/lib/RT/Report/Tickets.pm')
-rw-r--r-- | rt/lib/RT/Report/Tickets.pm | 451 |
1 files changed, 451 insertions, 0 deletions
diff --git a/rt/lib/RT/Report/Tickets.pm b/rt/lib/RT/Report/Tickets.pm new file mode 100644 index 000000000..4fdde1a48 --- /dev/null +++ b/rt/lib/RT/Report/Tickets.pm @@ -0,0 +1,451 @@ +# BEGIN BPS TAGGED BLOCK {{{ +# +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC +# <jesse@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/copyleft/gpl.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::Report::Tickets; + +use base qw/RT::Tickets/; +use RT::Report::Tickets::Entry; + +use strict; +use warnings; + +sub Groupings { + my $self = shift; + my %args = (@_); + my @fields = qw( + Owner + Status + Queue + DueDaily + DueMonthly + DueAnnually + ResolvedDaily + ResolvedMonthly + ResolvedAnnually + CreatedDaily + CreatedMonthly + CreatedAnnually + LastUpdatedDaily + LastUpdatedMonthly + LastUpdatedAnnually + StartedDaily + StartedMonthly + StartedAnnually + StartsDaily + StartsMonthly + StartsAnnually + ); + + @fields = map {$_, $_} @fields; + + my $queues = $args{'Queues'}; + if ( !$queues && $args{'Query'} ) { + my @actions; + my $tree; + # XXX TODO REFACTOR OUT + $self->_ParseQuery( $args{'Query'}, \$tree, \@actions ); + $queues = $tree->GetReferencedQueues; + } + + if ( $queues ) { + my $CustomFields = RT::CustomFields->new( $self->CurrentUser ); + foreach my $id (keys %$queues) { + my $queue = RT::Queue->new( $self->CurrentUser ); + $queue->Load($id); + unless ($queue->id) { + # XXX TODO: This ancient code dates from a former developer + # we have no idea what it means or why cfqueues are so encoded. + $id =~ s/^.'*(.*).'*$/$1/; + $queue->Load($id); + } + $CustomFields->LimitToQueue($queue->Id); + } + $CustomFields->LimitToGlobal; + while ( my $CustomField = $CustomFields->Next ) { + push @fields, "Custom field '". $CustomField->Name ."'", "CF.{". $CustomField->id ."}"; + } + } + return @fields; +} + +sub Label { + my $self = shift; + my $field = shift; + if ( $field =~ /^(?:CF|CustomField)\.{(.*)}$/ ) { + my $cf = $1; + return $self->CurrentUser->loc( "Custom field '[_1]'", $cf ) if $cf =~ /\D/; + my $obj = RT::CustomField->new( $self->CurrentUser ); + $obj->Load( $cf ); + return $self->CurrentUser->loc( "Custom field '[_1]'", $obj->Name ); + } + return $self->CurrentUser->loc($field); +} + +sub GroupBy { + my $self = shift; + my %args = ref $_[0]? %{ $_[0] }: (@_); + + $self->{'_group_by_field'} = $args{'FIELD'}; + %args = $self->_FieldToFunction( %args ); + + $self->SUPER::GroupBy( \%args ); +} + +sub Column { + my $self = shift; + my %args = (@_); + + if ( $args{'FIELD'} && !$args{'FUNCTION'} ) { + %args = $self->_FieldToFunction( %args ); + } + + return $self->SUPER::Column( %args ); +} + +=head2 _DoSearch + +Subclass _DoSearch from our parent so we can go through and add in empty +columns if it makes sense + +=cut + +sub _DoSearch { + my $self = shift; + $self->SUPER::_DoSearch( @_ ); + $self->AddEmptyRows; +} + +=head2 _FieldToFunction FIELD + +Returns a tuple of the field or a database function to allow grouping on that +field. + +=cut + +sub _FieldToFunction { + my $self = shift; + my %args = (@_); + + my $field = $args{'FIELD'}; + + if ($field =~ /^(.*)(Daily|Monthly|Annually)$/) { + my ($field, $grouping) = ($1, $2); + if ( $grouping =~ /Daily/ ) { + $args{'FUNCTION'} = "SUBSTR($field,1,10)"; + } + elsif ( $grouping =~ /Monthly/ ) { + $args{'FUNCTION'} = "SUBSTR($field,1,7)"; + } + elsif ( $grouping =~ /Annually/ ) { + $args{'FUNCTION'} = "SUBSTR($field,1,4)"; + } + } elsif ( $field =~ /^(?:CF|CustomField)\.{(.*)}$/ ) { #XXX: use CFDecipher method + my $cf_name = $1; + my $cf = RT::CustomField->new( $self->CurrentUser ); + $cf->Load($cf_name); + unless ( $cf->id ) { + $RT::Logger->error("Couldn't load CustomField #$cf_name"); + } else { + my ($ticket_cf_alias, $cf_alias) = $self->_CustomFieldJoin($cf->id, $cf->id, $cf_name); + @args{qw(ALIAS FIELD)} = ($ticket_cf_alias, 'Content'); + } + } + return %args; +} + + +# Override the AddRecord from DBI::SearchBuilder::Unique. id isn't id here +# wedon't want to disambiguate all the items with a count of 1. +sub AddRecord { + my $self = shift; + my $record = shift; + push @{$self->{'items'}}, $record; + $self->{'rows'}++; +} + +1; + + + +# Gotta skip over RT::Tickets->Next, since it does all sorts of crazy magic we +# don't want. +sub Next { + my $self = shift; + $self->RT::SearchBuilder::Next(@_); + +} + +sub NewItem { + my $self = shift; + return RT::Report::Tickets::Entry->new($RT::SystemUser); # $self->CurrentUser); +} + + +=head2 AddEmptyRows + +If we're grouping on a criterion we know how to add zero-value rows +for, do that. + +=cut + +sub AddEmptyRows { + my $self = shift; + if ( $self->{'_group_by_field'} eq 'Status' ) { + my %has = map { $_->__Value('Status') => 1 } @{ $self->ItemsArrayRef || [] }; + + foreach my $status ( grep !$has{$_}, RT::Queue->new($self->CurrentUser)->StatusArray ) { + + my $record = $self->NewItem; + $record->LoadFromHash( { + id => 0, + status => $status + } ); + $self->AddRecord($record); + } + } +} + + +# XXX TODO: this code cut and pasted from html/Search/Build.html +# This has already been improved (But not backported) in 3.7 +# +# This code is hacky, evil and wrong. But it's end of lifed from day one and is +# less likely to destabilize the codebase than the full refactoring it should get. +use Regexp::Common qw /delimited/; + +# States +use constant VALUE => 1; +use constant AGGREG => 2; +use constant OP => 4; +use constant PAREN => 8; +use constant KEYWORD => 16; + +sub _match { + + # Case insensitive equality + my ( $y, $x ) = @_; + return 1 if $x =~ /^$y$/i; + + # return 1 if ((lc $x) eq (lc $y)); # Why isnt this equiv? + return 0; +} + +sub _ParseQuery { + my $self = shift; + my $string = shift; + my $tree = shift; + my @actions = shift; + my $want = KEYWORD | PAREN; + my $last = undef; + + my $depth = 1; + + # make a tree root + use RT::Interface::Web::QueryBuilder::Tree; + $$tree = RT::Interface::Web::QueryBuilder::Tree->new; + my $root = RT::Interface::Web::QueryBuilder::Tree->new( 'AND', $$tree ); + my $lastnode = $root; + my $parentnode = $root; + + # get the FIELDS from Tickets_Overlay + my $tickets = new RT::Tickets( $self->CurrentUser ); + my %FIELDS = %{ $tickets->FIELDS }; + + # Lower Case version of FIELDS, for case insensitivity + my %lcfields = map { ( lc($_) => $_ ) } ( keys %FIELDS ); + + my @tokens = qw[VALUE AGGREG OP PAREN KEYWORD]; + my $re_aggreg = qr[(?i:AND|OR)]; + my $re_value = qr[$RE{delimited}{-delim=>qq{\'\"}}|\d+]; + my $re_keyword = qr[$RE{delimited}{-delim=>qq{\'\"}}|(?:\{|\}|\w|\.)+]; + my $re_op = + qr[=|!=|>=|<=|>|<|(?i:IS NOT)|(?i:IS)|(?i:NOT LIKE)|(?i:LIKE)] + ; # long to short + my $re_paren = qr'\(|\)'; + + # assume that $ea is AND if it is not set + my ( $ea, $key, $op, $value ) = ( "AND", "", "", "" ); + + # order of matches in the RE is important.. op should come early, + # because it has spaces in it. otherwise "NOT LIKE" might be parsed + # as a keyword or value. + + while ( + $string =~ /( + $re_aggreg + |$re_op + |$re_keyword + |$re_value + |$re_paren + )/igx + ) + { + my $val = $1; + my $current = 0; + + # Highest priority is last + $current = OP if _match( $re_op, $val ); + $current = VALUE if _match( $re_value, $val ); + $current = KEYWORD + if _match( $re_keyword, $val ) && ( $want & KEYWORD ); + $current = AGGREG if _match( $re_aggreg, $val ); + $current = PAREN if _match( $re_paren, $val ); + + unless ( $current && $want & $current ) { + + # Error + # FIXME: I will only print out the highest $want value + my $token = $tokens[ ( ( log $want ) / ( log 2 ) ) ]; + push @actions, + [ + $self->CurrentUser->loc( +"current: $current, want $want, Error near ->$val<- expecting a " + . $token + . " in '$string'\n" + ), + -1 + ]; + } + + # State Machine: + my $parentdepth = $depth; + + # Parens are highest priority + if ( $current & PAREN ) { + if ( $val eq "(" ) { + $depth++; + + # make a new node that the clauses can be children of + $parentnode = RT::Interface::Web::QueryBuilder::Tree->new( $ea, $parentnode ); + } + else { + $depth--; + $parentnode = $parentnode->getParent(); + $lastnode = $parentnode; + } + + $want = KEYWORD | PAREN | AGGREG; + } + elsif ( $current & AGGREG ) { + $ea = $val; + $want = KEYWORD | PAREN; + } + elsif ( $current & KEYWORD ) { + $key = $val; + $want = OP; + } + elsif ( $current & OP ) { + $op = $val; + $want = VALUE; + } + elsif ( $current & VALUE ) { + $value = $val; + + # Remove surrounding quotes from $key, $val + # (in future, simplify as for($key,$val) { action on $_ }) + if ( $key =~ /$RE{delimited}{-delim=>qq{\'\"}}/ ) { + substr( $key, 0, 1 ) = ""; + substr( $key, -1, 1 ) = ""; + } + if ( $val =~ /$RE{delimited}{-delim=>qq{\'\"}}/ ) { + substr( $val, 0, 1 ) = ""; + substr( $val, -1, 1 ) = ""; + } + + # Unescape escaped characters + $key =~ s!\\(.)!$1!g; + $val =~ s!\\(.)!$1!g; + + my $class; + if ( exists $lcfields{ lc $key } ) { + $key = $lcfields{ lc $key }; + $class = $FIELDS{$key}->[0]; + } + if ( $class ne 'INT' ) { + $val = "'$val'"; + } + + push @actions, [ $self->CurrentUser->loc("Unknown field: $key"), -1 ] unless $class; + + $want = PAREN | AGGREG; + } + else { + push @actions, [ $self->CurrentUser->loc("I'm lost"), -1 ]; + } + + if ( $current & VALUE ) { + if ( $key =~ /^CF./ ) { + $key = "'" . $key . "'"; + } + my $clause = { + Key => $key, + Op => $op, + Value => $val + }; + + # explicity add a child to it + $lastnode = RT::Interface::Web::QueryBuilder::Tree->new( $clause, $parentnode ); + $lastnode->getParent()->setNodeValue($ea); + + ( $ea, $key, $op, $value ) = ( "", "", "", "" ); + } + + $last = $current; + } # while + + push @actions, [ $self->CurrentUser->loc("Incomplete query"), -1 ] + unless ( ( $want | PAREN ) || ( $want | KEYWORD ) ); + + push @actions, [ $self->CurrentUser->loc("Incomplete Query"), -1 ] + unless ( $last && ( $last | PAREN ) || ( $last || VALUE ) ); + + # This will never happen, because the parser will complain + push @actions, [ $self->CurrentUser->loc("Mismatched parentheses"), -1 ] + unless $depth == 1; +}; + +1; |