#
# COPYRIGHT:
#
-# This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
+# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
# <sales@bestpractical.com>
#
# (Except where explicitly superseded by other copyright notices)
use strict;
use warnings;
-sub Groupings {
- my $self = shift;
- my %args = (@_);
- my @fields = map {$_, $_} qw(
- Status
- Queue
- );
+use Scalar::Util qw(weaken);
- foreach my $type ( qw(Owner Creator LastUpdatedBy Requestor Cc AdminCc Watcher) ) {
- push @fields, $type.' '.$_, $type.'.'.$_ foreach qw(
- Name EmailAddress RealName NickName Organization Lang City Country Timezone
- );
- }
+our @GROUPINGS = (
+ Status => 'Enum', #loc_left_pair
+ Queue => 'Queue', #loc_left_pair
- for my $field (qw(Due Resolved Created LastUpdated Started Starts Told)) {
- for my $frequency (qw(Hourly Daily Monthly Annually)) {
- my $item = $field.$frequency;
- push @fields, $item, $item;
- }
- }
+ InitialPriority => 'Priority', #loc_left_pair
+ FinalPriority => 'Priority', #loc_left_pair
+ Priority => 'Priority', #loc_left_pair
- my $queues = $args{'Queues'};
- if ( !$queues && $args{'Query'} ) {
- require RT::Interface::Web::QueryBuilder::Tree;
- my $tree = RT::Interface::Web::QueryBuilder::Tree->new('AND');
- $tree->ParseSQL( Query => $args{'Query'}, CurrentUser => $self->CurrentUser );
- $queues = $tree->GetReferencedQueues;
- }
+ Owner => 'User', #loc_left_pair
+ Creator => 'User', #loc_left_pair
+ LastUpdatedBy => 'User', #loc_left_pair
+
+ Requestor => 'Watcher', #loc_left_pair
+ Cc => 'Watcher', #loc_left_pair
+ AdminCc => 'Watcher', #loc_left_pair
+ Watcher => 'Watcher', #loc_left_pair
+
+ Created => 'Date', #loc_left_pair
+ Starts => 'Date', #loc_left_pair
+ Started => 'Date', #loc_left_pair
+ Resolved => 'Date', #loc_left_pair
+ Due => 'Date', #loc_left_pair
+ Told => 'Date', #loc_left_pair
+ LastUpdated => 'Date', #loc_left_pair
+
+ CF => 'CustomField', #loc_left_pair
+);
+our %GROUPINGS;
+
+our %GROUPINGS_META = (
+ Queue => {
+ Display => sub {
+ my $self = shift;
+ my %args = (@_);
- if ( $queues ) {
- my $CustomFields = RT::CustomFields->new( $self->CurrentUser );
- foreach my $id (keys %$queues) {
my $queue = RT::Queue->new( $self->CurrentUser );
- $queue->Load($id);
- $CustomFields->LimitToQueue($queue->Id) if $queue->Id;
+ $queue->Load( $args{'VALUE'} );
+ return $queue->Name;
+ },
+ Localize => 1,
+ },
+ Priority => {
+ Sort => 'numeric raw',
+ },
+ User => {
+ SubFields => [grep RT::User->_Accessible($_, "public"), qw(
+ Name RealName NickName
+ EmailAddress
+ Organization
+ Lang City Country Timezone
+ )],
+ Function => 'GenerateUserFunction',
+ },
+ Watcher => {
+ SubFields => [grep RT::User->_Accessible($_, "public"), qw(
+ Name RealName NickName
+ EmailAddress
+ Organization
+ Lang City Country Timezone
+ )],
+ Function => 'GenerateWatcherFunction',
+ },
+ Date => {
+ SubFields => [qw(
+ Time
+ Hourly Hour
+ Date Daily
+ DayOfWeek Day DayOfMonth DayOfYear
+ Month Monthly
+ Year Annually
+ WeekOfYear
+ )], # loc_qw
+ Function => 'GenerateDateFunction',
+ Display => sub {
+ my $self = shift;
+ my %args = (@_);
+
+ my $raw = $args{'VALUE'};
+ return $raw unless defined $raw;
+
+ if ( $args{'SUBKEY'} eq 'DayOfWeek' ) {
+ return $self->loc($RT::Date::DAYS_OF_WEEK[ int $raw ]);
+ }
+ elsif ( $args{'SUBKEY'} eq 'Month' ) {
+ return $self->loc($RT::Date::MONTHS[ int($raw) - 1 ]);
+ }
+ return $raw;
+ },
+ Sort => 'raw',
+ },
+ CustomField => {
+ SubFields => sub {
+ my $self = shift;
+ my $args = shift;
+
+
+ my $queues = $args->{'Queues'};
+ if ( !$queues && $args->{'Query'} ) {
+ require RT::Interface::Web::QueryBuilder::Tree;
+ my $tree = RT::Interface::Web::QueryBuilder::Tree->new('AND');
+ $tree->ParseSQL( Query => $args->{'Query'}, CurrentUser => $self->CurrentUser );
+ $queues = $args->{'Queues'} = $tree->GetReferencedQueues;
+ }
+ return () unless $queues;
+
+ my @res;
+
+ my $CustomFields = RT::CustomFields->new( $self->CurrentUser );
+ foreach my $id (keys %$queues) {
+ my $queue = RT::Queue->new( $self->CurrentUser );
+ $queue->Load($id);
+ next unless $queue->id;
+
+ $CustomFields->LimitToQueue($queue->id);
+ }
+ $CustomFields->LimitToGlobal;
+ while ( my $CustomField = $CustomFields->Next ) {
+ push @res, ["Custom field", $CustomField->Name], "CF.{". $CustomField->id ."}";
+ }
+ return @res;
+ },
+ Function => 'GenerateCustomFieldFunction',
+ Label => sub {
+ my $self = shift;
+ my %args = (@_);
+
+ my ($cf) = ( $args{'SUBKEY'} =~ /^\{(.*)\}$/ );
+ if ( $cf =~ /^\d+$/ ) {
+ my $obj = RT::CustomField->new( $self->CurrentUser );
+ $obj->Load( $cf );
+ $cf = $obj->Name;
+ }
+
+ return 'Custom field [_1]', $cf;
+ },
+ },
+ Enum => {
+ Localize => 1,
+ },
+);
+
+# loc'able strings below generated with (s/loq/loc/):
+# perl -MRT=-init -MRT::Report::Tickets -E 'say qq{\# loq("$_->[0]")} while $_ = splice @RT::Report::Tickets::STATISTICS, 0, 2'
+#
+# loc("Ticket count")
+# loc("Summary of time worked")
+# loc("Total time worked")
+# loc("Average time worked")
+# loc("Minimum time worked")
+# loc("Maximum time worked")
+# loc("Summary of time estimated")
+# loc("Total time estimated")
+# loc("Average time estimated")
+# loc("Minimum time estimated")
+# loc("Maximum time estimated")
+# loc("Summary of time left")
+# loc("Total time left")
+# loc("Average time left")
+# loc("Minimum time left")
+# loc("Maximum time left")
+# loc("Summary of Created-Started")
+# loc("Total Created-Started")
+# loc("Average Created-Started")
+# loc("Minimum Created-Started")
+# loc("Maximum Created-Started")
+# loc("Summary of Created-Resolved")
+# loc("Total Created-Resolved")
+# loc("Average Created-Resolved")
+# loc("Minimum Created-Resolved")
+# loc("Maximum Created-Resolved")
+# loc("Summary of Created-LastUpdated")
+# loc("Total Created-LastUpdated")
+# loc("Average Created-LastUpdated")
+# loc("Minimum Created-LastUpdated")
+# loc("Maximum Created-LastUpdated")
+# loc("Summary of Starts-Started")
+# loc("Total Starts-Started")
+# loc("Average Starts-Started")
+# loc("Minimum Starts-Started")
+# loc("Maximum Starts-Started")
+# loc("Summary of Due-Resolved")
+# loc("Total Due-Resolved")
+# loc("Average Due-Resolved")
+# loc("Minimum Due-Resolved")
+# loc("Maximum Due-Resolved")
+# loc("Summary of Started-Resolved")
+# loc("Total Started-Resolved")
+# loc("Average Started-Resolved")
+# loc("Minimum Started-Resolved")
+# loc("Maximum Started-Resolved")
+
+our @STATISTICS = (
+ COUNT => ['Ticket count', 'Count', 'id'],
+);
+
+foreach my $field (qw(TimeWorked TimeEstimated TimeLeft)) {
+ my $friendly = lc join ' ', split /(?<=[a-z])(?=[A-Z])/, $field;
+ push @STATISTICS, (
+ "ALL($field)" => ["Summary of $friendly", 'TimeAll', $field ],
+ "SUM($field)" => ["Total $friendly", 'Time', 'SUM', $field ],
+ "AVG($field)" => ["Average $friendly", 'Time', 'AVG', $field ],
+ "MIN($field)" => ["Minimum $friendly", 'Time', 'MIN', $field ],
+ "MAX($field)" => ["Maximum $friendly", 'Time', 'MAX', $field ],
+ );
+}
+
+
+foreach my $pair (qw(
+ Created-Started
+ Created-Resolved
+ Created-LastUpdated
+ Starts-Started
+ Due-Resolved
+ Started-Resolved
+)) {
+ my ($from, $to) = split /-/, $pair;
+ push @STATISTICS, (
+ "ALL($pair)" => ["Summary of $pair", 'DateTimeIntervalAll', $from, $to ],
+ "SUM($pair)" => ["Total $pair", 'DateTimeInterval', 'SUM', $from, $to ],
+ "AVG($pair)" => ["Average $pair", 'DateTimeInterval', 'AVG', $from, $to ],
+ "MIN($pair)" => ["Minimum $pair", 'DateTimeInterval', 'MIN', $from, $to ],
+ "MAX($pair)" => ["Maximum $pair", 'DateTimeInterval', 'MAX', $from, $to ],
+ );
+}
+
+our %STATISTICS;
+
+our %STATISTICS_META = (
+ Count => {
+ Function => sub {
+ my $self = shift;
+ my $field = shift || 'id';
+
+ return (
+ FUNCTION => 'COUNT',
+ FIELD => 'id'
+ );
+ },
+ },
+ Simple => {
+ Function => sub {
+ my $self = shift;
+ my ($function, $field) = @_;
+ return (FUNCTION => $function, FIELD => $field);
+ },
+ },
+ Time => {
+ Function => sub {
+ my $self = shift;
+ my ($function, $field) = @_;
+ return (FUNCTION => "$function(?)*60", FIELD => $field);
+ },
+ Display => 'DurationAsString',
+ },
+ TimeAll => {
+ SubValues => sub { return ('Minimum', 'Average', 'Maximum', 'Total') },
+ Function => sub {
+ my $self = shift;
+ my $field = shift;
+ return (
+ Minimum => { FUNCTION => "MIN(?)*60", FIELD => $field },
+ Average => { FUNCTION => "AVG(?)*60", FIELD => $field },
+ Maximum => { FUNCTION => "MAX(?)*60", FIELD => $field },
+ Total => { FUNCTION => "SUM(?)*60", FIELD => $field },
+ );
+ },
+ Display => 'DurationAsString',
+ },
+ DateTimeInterval => {
+ Function => sub {
+ my $self = shift;
+ my ($function, $from, $to) = @_;
+
+ my $interval = $self->_Handle->DateTimeIntervalFunction(
+ From => { FUNCTION => $self->NotSetDateToNullFunction( FIELD => $from ) },
+ To => { FUNCTION => $self->NotSetDateToNullFunction( FIELD => $to ) },
+ );
+
+ return (FUNCTION => "$function($interval)");
+ },
+ Display => 'DurationAsString',
+ },
+ DateTimeIntervalAll => {
+ SubValues => sub { return ('Minimum', 'Average', 'Maximum', 'Total') },
+ Function => sub {
+ my $self = shift;
+ my ($from, $to) = @_;
+
+ my $interval = $self->_Handle->DateTimeIntervalFunction(
+ From => { FUNCTION => $self->NotSetDateToNullFunction( FIELD => $from ) },
+ To => { FUNCTION => $self->NotSetDateToNullFunction( FIELD => $to ) },
+ );
+
+ return (
+ Minimum => { FUNCTION => "MIN($interval)" },
+ Average => { FUNCTION => "AVG($interval)" },
+ Maximum => { FUNCTION => "MAX($interval)" },
+ Total => { FUNCTION => "SUM($interval)" },
+ );
+ },
+ Display => 'DurationAsString',
+ },
+);
+
+sub Groupings {
+ my $self = shift;
+ my %args = (@_);
+
+ my @fields;
+
+ my @tmp = @GROUPINGS;
+ while ( my ($field, $type) = splice @tmp, 0, 2 ) {
+ my $meta = $GROUPINGS_META{ $type } || {};
+ unless ( $meta->{'SubFields'} ) {
+ push @fields, [$field, $field], $field;
}
- $CustomFields->LimitToGlobal;
- while ( my $CustomField = $CustomFields->Next ) {
- push @fields, "Custom field '". $CustomField->Name ."'", "CF.{". $CustomField->id ."}";
+ elsif ( ref( $meta->{'SubFields'} ) eq 'ARRAY' ) {
+ push @fields, map { ([$field, $_], "$field.$_") } @{ $meta->{'SubFields'} };
+ }
+ elsif ( my $code = $self->FindImplementationCode( $meta->{'SubFields'} ) ) {
+ push @fields, $code->( $self, \%args );
+ }
+ else {
+ $RT::Logger->error(
+ "$type has unsupported SubFields."
+ ." Not an array, a method name or a code reference"
+ );
}
}
return @fields;
}
-sub Label {
+sub IsValidGrouping {
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);
+ my %args = (@_);
+ return 0 unless $args{'GroupBy'};
+
+ my ($key, $subkey) = split /\./, $args{'GroupBy'}, 2;
+
+ %GROUPINGS = @GROUPINGS unless keys %GROUPINGS;
+ my $type = $GROUPINGS{$key};
+ return 0 unless $type;
+ return 1 unless $subkey;
+
+ my $meta = $GROUPINGS_META{ $type } || {};
+ unless ( $meta->{'SubFields'} ) {
+ return 0;
+ }
+ elsif ( ref( $meta->{'SubFields'} ) eq 'ARRAY' ) {
+ return 1 if grep $_ eq $subkey, @{ $meta->{'SubFields'} };
+ }
+ elsif ( my $code = $self->FindImplementationCode( $meta->{'SubFields'}, 'silent' ) ) {
+ return 1 if grep $_ eq "$key.$subkey", $code->( $self, \%args );
+ }
+ return 0;
}
-sub SetupGroupings {
+sub Statistics {
+ my $self = shift;
+ return map { ref($_)? $_->[0] : $_ } @STATISTICS;
+}
+
+sub Label {
my $self = shift;
- my %args = (Query => undef, GroupBy => undef, @_);
+ my $column = shift;
- $self->FromSQL( $args{'Query'} );
- my @group_by = ref( $args{'GroupBy'} )? @{ $args{'GroupBy'} } : ($args{'GroupBy'});
- $self->GroupBy( map { {FIELD => $_} } @group_by );
+ my $info = $self->ColumnInfo( $column );
+ unless ( $info ) {
+ $RT::Logger->error("Unknown column '$column'");
+ return $self->CurrentUser->loc('(Incorrect data)');
+ }
- # UseSQLForACLChecks may add late joins
- my $joined = ($self->_isJoined || RT->Config->Get('UseSQLForACLChecks')) ? 1 : 0;
+ if ( $info->{'META'}{'Label'} ) {
+ my $code = $self->FindImplementationCode( $info->{'META'}{'Label'} );
+ return $self->CurrentUser->loc( $code->( $self, %$info ) )
+ if $code;
+ }
- my @res;
- push @res, $self->Column( FUNCTION => ($joined? 'DISTINCT COUNT' : 'COUNT'), FIELD => 'id' );
- push @res, map $self->Column( FIELD => $_ ), @group_by;
- return @res;
+ my $res = '';
+ if ( $info->{'TYPE'} eq 'statistic' ) {
+ $res = $info->{'INFO'}[0];
+ }
+ else {
+ $res = join ' ', grep defined && length, @{ $info }{'KEY', 'SUBKEY'};
+ }
+ return $self->CurrentUser->loc( $res );
}
-sub GroupBy {
+sub ColumnInfo {
my $self = shift;
- my @args = ref $_[0]? @_ : { @_ };
+ my $column = shift;
- @{ $self->{'_group_by_field'} ||= [] } = map $_->{'FIELD'}, @args;
- $_ = { $self->_FieldToFunction( %$_ ) } foreach @args;
+ return $self->{'column_info'}{$column};
+}
- $self->SUPER::GroupBy( @args );
+sub ColumnsList {
+ my $self = shift;
+ return sort { $self->{'column_info'}{$a}{'POSITION'} <=> $self->{'column_info'}{$b}{'POSITION'} }
+ keys %{ $self->{'column_info'} || {} };
}
-sub Column {
+sub SetupGroupings {
my $self = shift;
- my %args = (@_);
+ my %args = (
+ Query => undef,
+ GroupBy => undef,
+ Function => undef,
+ @_
+ );
+
+ $self->FromSQL( $args{'Query'} ) if $args{'Query'};
+
+ # Apply ACL checks
+ $self->CurrentUserCanSee if RT->Config->Get('UseSQLForACLChecks');
+
+ # See if our query is distinct
+ if (not $self->{'joins_are_distinct'} and $self->_isJoined) {
+ # If it isn't, we need to do this in two stages -- first, find
+ # the distinct matching tickets (with no group by), then search
+ # within the matching tickets grouped by what is wanted.
+ my @match = (0);
+ $self->Columns( 'id' );
+ while (my $row = $self->Next) {
+ push @match, $row->id;
+ }
+
+ # Replace the query with one that matches precisely those
+ # tickets, with no joins. We then mark it as having been ACL'd,
+ # since it was by dint of being in the search results above
+ $self->CleanSlate;
+ while ( @match > 1000 ) {
+ my @batch = splice( @match, 0, 1000 );
+ $self->Limit( FIELD => 'Id', OPERATOR => 'IN', VALUE => \@batch );
+ }
+ $self->Limit( FIELD => 'Id', OPERATOR => 'IN', VALUE => \@match );
+ $self->{'_sql_current_user_can_see_applied'} = 1
+ }
+
+
+ %GROUPINGS = @GROUPINGS unless keys %GROUPINGS;
+
+ my $i = 0;
+
+ my @group_by = grep defined && length,
+ ref( $args{'GroupBy'} )? @{ $args{'GroupBy'} } : ($args{'GroupBy'});
+ @group_by = ('Status') unless @group_by;
+
+ foreach my $e ( splice @group_by ) {
+ unless ($self->IsValidGrouping( Query => $args{Query}, GroupBy => $e )) {
+ RT->Logger->error("'$e' is not a valid grouping for reports; skipping");
+ next;
+ }
+ my ($key, $subkey) = split /\./, $e, 2;
+ $e = { $self->_FieldToFunction( KEY => $key, SUBKEY => $subkey ) };
+ $e->{'TYPE'} = 'grouping';
+ $e->{'INFO'} = $GROUPINGS{ $key };
+ $e->{'META'} = $GROUPINGS_META{ $e->{'INFO'} };
+ $e->{'POSITION'} = $i++;
+ push @group_by, $e;
+ }
+ $self->GroupBy( map { {
+ ALIAS => $_->{'ALIAS'},
+ FIELD => $_->{'FIELD'},
+ FUNCTION => $_->{'FUNCTION'},
+ } } @group_by );
+
+ my %res = (Groups => [], Functions => []);
+ my %column_info;
+
+ foreach my $group_by ( @group_by ) {
+ $group_by->{'NAME'} = $self->Column( %$group_by );
+ $column_info{ $group_by->{'NAME'} } = $group_by;
+ push @{ $res{'Groups'} }, $group_by->{'NAME'};
+ }
+
+ %STATISTICS = @STATISTICS unless keys %STATISTICS;
- if ( $args{'FIELD'} && !$args{'FUNCTION'} ) {
- %args = $self->_FieldToFunction( %args );
+ my @function = grep defined && length,
+ ref( $args{'Function'} )? @{ $args{'Function'} } : ($args{'Function'});
+ push @function, 'COUNT' unless @function;
+ foreach my $e ( @function ) {
+ $e = {
+ TYPE => 'statistic',
+ KEY => $e,
+ INFO => $STATISTICS{ $e },
+ META => $STATISTICS_META{ $STATISTICS{ $e }[1] },
+ POSITION => $i++,
+ };
+ unless ( $e->{'INFO'} && $e->{'META'} ) {
+ $RT::Logger->error("'". $e->{'KEY'} ."' is not valid statistic for report");
+ $e->{'FUNCTION'} = 'NULL';
+ $e->{'NAME'} = $self->Column( FUNCTION => 'NULL' );
+ }
+ elsif ( $e->{'META'}{'Function'} ) {
+ my $code = $self->FindImplementationCode( $e->{'META'}{'Function'} );
+ unless ( $code ) {
+ $e->{'FUNCTION'} = 'NULL';
+ $e->{'NAME'} = $self->Column( FUNCTION => 'NULL' );
+ }
+ elsif ( $e->{'META'}{'SubValues'} ) {
+ my %tmp = $code->( $self, @{ $e->{INFO} }[2 .. $#{$e->{INFO}}] );
+ $e->{'NAME'} = 'postfunction'. $self->{'postfunctions'}++;
+ while ( my ($k, $v) = each %tmp ) {
+ $e->{'MAP'}{ $k }{'NAME'} = $self->Column( %$v );
+ @{ $e->{'MAP'}{ $k } }{'FUNCTION', 'ALIAS', 'FIELD'} =
+ @{ $v }{'FUNCTION', 'ALIAS', 'FIELD'};
+ }
+ }
+ else {
+ my %tmp = $code->( $self, @{ $e->{INFO} }[2 .. $#{$e->{INFO}}] );
+ $e->{'NAME'} = $self->Column( %tmp );
+ @{ $e }{'FUNCTION', 'ALIAS', 'FIELD'} = @tmp{'FUNCTION', 'ALIAS', 'FIELD'};
+ }
+ }
+ elsif ( $e->{'META'}{'Calculate'} ) {
+ $e->{'NAME'} = 'postfunction'. $self->{'postfunctions'}++;
+ }
+ push @{ $res{'Functions'} }, $e->{'NAME'};
+ $column_info{ $e->{'NAME'} } = $e;
}
- return $self->SUPER::Column( %args );
+ $self->{'column_info'} = \%column_info;
+
+ return %res;
}
=head2 _DoSearch
);
}
else {
- $self->AddEmptyRows;
+ $self->PostProcessRecords;
}
}
my $self = shift;
my %args = (@_);
- my $field = $args{'FIELD'};
+ $args{'FIELD'} ||= $args{'KEY'};
- if ($field =~ /^(.*)(Hourly|Daily|Monthly|Annually)$/) {
- my ($field, $grouping) = ($1, $2);
- my $alias = $args{'ALIAS'} || 'main';
+ my $meta = $GROUPINGS_META{ $GROUPINGS{ $args{'KEY'} } };
+ return ('FUNCTION' => 'NULL') unless $meta;
- my $func = "$alias.$field";
+ return %args unless $meta->{'Function'};
- my $db_type = RT->Config->Get('DatabaseType');
- if ( RT->Config->Get('ChartsTimezonesInDB') ) {
- my $tz = $self->CurrentUser->UserObj->Timezone
- || RT->Config->Get('Timezone')
- || 'UTC';
- if ( lc $tz eq 'utc' ) {
- # do nothing
- }
- elsif ( $db_type eq 'Pg' ) {
- $func = "timezone('UTC', $func)";
- $func = "timezone(". $self->_Handle->dbh->quote($tz) .", $func)";
- }
- elsif ( $db_type eq 'mysql' ) {
- $func = "CONVERT_TZ($func, 'UTC', "
- . $self->_Handle->dbh->quote($tz)
- .")";
- }
- else {
- $RT::Logger->warning(
- "ChartsTimezonesInDB config option"
- ." is not supported on $db_type."
- );
- }
+ my $code = $self->FindImplementationCode( $meta->{'Function'} );
+ return ('FUNCTION' => 'NULL') unless $code;
+
+ return $code->( $self, %args );
+}
+
+
+# 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;
+ my $res = RT::Report::Tickets::Entry->new($self->CurrentUser);
+ $res->{'report'} = $self;
+ weaken $res->{'report'};
+ return $res;
+}
+
+# This is necessary since normally NewItem (above) is used to intuit the
+# correct class. However, since we're abusing a subclass, it's incorrect.
+sub _RoleGroupClass { "RT::Ticket" }
+sub _SingularClass { "RT::Report::Tickets::Entry" }
+
+sub SortEntries {
+ my $self = shift;
+
+ $self->_DoSearch if $self->{'must_redo_search'};
+ return unless $self->{'items'} && @{ $self->{'items'} };
+
+ my @groups =
+ grep $_->{'TYPE'} eq 'grouping',
+ map $self->ColumnInfo($_),
+ $self->ColumnsList;
+ return unless @groups;
+
+ my @SORT_OPS;
+ my $by_multiple = sub ($$) {
+ for my $f ( @SORT_OPS ) {
+ my $r = $f->($_[0], $_[1]);
+ return $r if $r;
}
+ };
+ my @data = map [$_], @{ $self->{'items'} };
+
+ for ( my $i = 0; $i < @groups; $i++ ) {
+ my $group_by = $groups[$i];
+ my $idx = $i+1;
+ my $method;
+
+ # If this is a CF, traverse the values being used for labels.
+ # If they all look like numbers or undef, flag for a numeric sort
+
+ my $looks_like_number;
+ if ( $group_by->{'KEY'} eq 'CF' ){
+ $looks_like_number = 1;
- # Pg 8.3 requires explicit casting
- $func .= '::text' if $db_type eq 'Pg';
+ foreach my $item (@data){
+ my $cf_label = $item->[0]->RawValue($group_by->{'NAME'});
- if ( $grouping eq 'Hourly' ) {
- $func = "SUBSTR($func,1,13)";
+ $looks_like_number = 0
+ unless (not defined $cf_label)
+ or Scalar::Util::looks_like_number( $cf_label );
+ }
}
- if ( $grouping eq 'Daily' ) {
- $func = "SUBSTR($func,1,10)";
+
+ my $order = $looks_like_number ? 'numeric label' : 'label';
+ $order = $group_by->{'META'}{Sort} if exists $group_by->{'META'}{Sort};
+
+ if ( $order eq 'label' ) {
+ push @SORT_OPS, sub { $_[0][$idx] cmp $_[1][$idx] };
+ $method = 'LabelValue';
}
- elsif ( $grouping eq 'Monthly' ) {
- $func = "SUBSTR($func,1,7)";
+ elsif ( $order eq 'numeric label' ) {
+ my $nv = $self->loc("(no value)");
+ # Sort the (no value) elements first, by comparing for them
+ # first, and falling back to a numeric sort on all other
+ # values.
+ push @SORT_OPS, sub {
+ (($_[0][$idx] ne $nv) <=> ($_[1][$idx] ne $nv))
+ || ( $_[0][$idx] <=> $_[1][$idx] ) };
+ $method = 'LabelValue';
}
- elsif ( $grouping eq 'Annually' ) {
- $func = "SUBSTR($func,1,4)";
+ elsif ( $order eq 'raw' ) {
+ push @SORT_OPS, sub { ($_[0][$idx]//'') cmp ($_[1][$idx]//'') };
+ $method = 'RawValue';
}
- $args{'FUNCTION'} = $func;
- } 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");
+ elsif ( $order eq 'numeric raw' ) {
+ push @SORT_OPS, sub { $_[0][$idx] <=> $_[1][$idx] };
+ $method = 'RawValue';
} else {
- my ($ticket_cf_alias, $cf_alias) = $self->_CustomFieldJoin($cf->id, $cf->id, $cf_name);
- @args{qw(ALIAS FIELD)} = ($ticket_cf_alias, 'Content');
+ $RT::Logger->error("Unknown sorting function '$order'");
+ next;
}
- } elsif ( $field =~ /^(?:(Owner|Creator|LastUpdatedBy))(?:\.(.*))?$/ ) {
- my $type = $1 || '';
- my $column = $2 || 'Name';
- my $u_alias = $self->{"_sql_report_${type}_users_${column}"}
- ||= $self->Join(
- TYPE => 'LEFT',
- ALIAS1 => 'main',
- FIELD1 => $type,
- TABLE2 => 'Users',
- FIELD2 => 'id',
- );
- @args{qw(ALIAS FIELD)} = ($u_alias, $column);
- } elsif ( $field =~ /^(?:Watcher|(Requestor|Cc|AdminCc))(?:\.(.*))?$/ ) {
- my $type = $1 || '';
- my $column = $2 || 'Name';
- my $u_alias = $self->{"_sql_report_watcher_users_alias_$type"};
- unless ( $u_alias ) {
- my ($g_alias, $gm_alias);
- ($g_alias, $gm_alias, $u_alias) = $self->_WatcherJoin( $type );
- $self->{"_sql_report_watcher_users_alias_$type"} = $u_alias;
+ $_->[$idx] = $_->[0]->$method( $group_by->{'NAME'} ) for @data;
+ }
+ $self->{'items'} = [
+ map $_->[0],
+ sort $by_multiple @data
+ ];
+}
+
+sub PostProcessRecords {
+ my $self = shift;
+
+ my $info = $self->{'column_info'};
+ foreach my $column ( values %$info ) {
+ next unless $column->{'TYPE'} eq 'statistic';
+ if ( $column->{'META'}{'Calculate'} ) {
+ $self->CalculatePostFunction( $column );
+ }
+ elsif ( $column->{'META'}{'SubValues'} ) {
+ $self->MapSubValues( $column );
+ }
+ }
+}
+
+sub CalculatePostFunction {
+ my $self = shift;
+ my $info = shift;
+
+ my $code = $self->FindImplementationCode( $info->{'META'}{'Calculate'} );
+ unless ( $code ) {
+ # TODO: fill in undefs
+ return;
+ }
+
+ my $column = $info->{'NAME'};
+
+ my $base_query = $self->Query;
+ foreach my $item ( @{ $self->{'items'} } ) {
+ $item->{'values'}{ lc $column } = $code->(
+ $self,
+ Query => join(
+ ' AND ', map "($_)", grep defined && length, $base_query, $item->Query,
+ ),
+ );
+ $item->{'fetched'}{ lc $column } = 1;
+ }
+}
+
+sub MapSubValues {
+ my $self = shift;
+ my $info = shift;
+
+ my $to = $info->{'NAME'};
+ my $map = $info->{'MAP'};
+
+ foreach my $item ( @{ $self->{'items'} } ) {
+ my $dst = $item->{'values'}{ lc $to } = { };
+ while (my ($k, $v) = each %{ $map } ) {
+ $dst->{ $k } = delete $item->{'values'}{ lc $v->{'NAME'} };
+ # This mirrors the logic in RT::Record::__Value When that
+ # ceases tp use the UTF-8 flag as a character/byte
+ # distinction from the database, this can as well.
+ utf8::decode( $dst->{ $k } )
+ if defined $dst->{ $k }
+ and not utf8::is_utf8( $dst->{ $k } );
+ delete $item->{'fetched'}{ lc $v->{'NAME'} };
}
- @args{qw(ALIAS FIELD)} = ($u_alias, $column);
+ $item->{'fetched'}{ lc $to } = 1;
+ }
+}
+
+sub GenerateDateFunction {
+ my $self = shift;
+ my %args = @_;
+
+ my $tz;
+ if ( RT->Config->Get('ChartsTimezonesInDB') ) {
+ my $to = $self->CurrentUser->UserObj->Timezone
+ || RT->Config->Get('Timezone');
+ $tz = { From => 'UTC', To => $to }
+ if $to && lc $to ne 'utc';
}
+
+ $args{'FUNCTION'} = $RT::Handle->DateTimeFunction(
+ Type => $args{'SUBKEY'},
+ Field => $self->NotSetDateToNullFunction,
+ Timezone => $tz,
+ );
return %args;
}
+sub GenerateCustomFieldFunction {
+ my $self = shift;
+ my %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 ($name) = ( $args{'SUBKEY'} =~ /^\{(.*)\}$/ );
+ my $cf = RT::CustomField->new( $self->CurrentUser );
+ $cf->Load($name);
+ unless ( $cf->id ) {
+ $RT::Logger->error("Couldn't load CustomField #$name");
+ @args{qw(FUNCTION FIELD)} = ('NULL', undef);
+ } else {
+ my ($ticket_cf_alias, $cf_alias) = $self->_CustomFieldJoin($cf->id, $cf);
+ @args{qw(ALIAS FIELD)} = ($ticket_cf_alias, 'Content');
+ }
+ return %args;
+}
+
+sub GenerateUserFunction {
my $self = shift;
- my $record = shift;
- push @{$self->{'items'}}, $record;
- $self->{'rows'}++;
+ my %args = @_;
+
+ my $column = $args{'SUBKEY'} || 'Name';
+ my $u_alias = $self->{"_sql_report_$args{FIELD}_users_$column"}
+ ||= $self->Join(
+ TYPE => 'LEFT',
+ ALIAS1 => 'main',
+ FIELD1 => $args{'FIELD'},
+ TABLE2 => 'Users',
+ FIELD2 => 'id',
+ );
+ @args{qw(ALIAS FIELD)} = ($u_alias, $column);
+ return %args;
}
-1;
+sub GenerateWatcherFunction {
+ my $self = shift;
+ my %args = @_;
+ my $type = $args{'FIELD'};
+ $type = '' if $type eq 'Watcher';
+ my $column = $args{'SUBKEY'} || 'Name';
-# Gotta skip over RT::Tickets->Next, since it does all sorts of crazy magic we
-# don't want.
-sub Next {
+ my $u_alias = $self->{"_sql_report_watcher_users_alias_$type"};
+ unless ( $u_alias ) {
+ my ($g_alias, $gm_alias);
+ ($g_alias, $gm_alias, $u_alias) = $self->_WatcherJoin( Name => $type );
+ $self->{"_sql_report_watcher_users_alias_$type"} = $u_alias;
+ }
+ @args{qw(ALIAS FIELD)} = ($u_alias, $column);
+
+ return %args;
+}
+
+sub DurationAsString {
my $self = shift;
- $self->RT::SearchBuilder::Next(@_);
+ my %args = @_;
+ my $v = $args{'VALUE'};
+ unless ( ref $v ) {
+ return $self->loc("(no value)") unless defined $v && length $v;
+ return RT::Date->new( $self->CurrentUser )->DurationAsString(
+ $v, Show => 3, Short => 1
+ );
+ }
+ my $date = RT::Date->new( $self->CurrentUser );
+ my %res = %$v;
+ foreach my $e ( values %res ) {
+ $e = $date->DurationAsString( $e, Short => 1, Show => 3 )
+ if defined $e && length $e;
+ $e = $self->loc("(no value)") unless defined $e && length $e;
+ }
+ return \%res;
}
-sub NewItem {
+sub LabelValueCode {
my $self = shift;
- return RT::Report::Tickets::Entry->new(RT->SystemUser); # $self->CurrentUser);
+ my $name = shift;
+
+ my $display = $self->ColumnInfo( $name )->{'META'}{'Display'};
+ return undef unless $display;
+ return $self->FindImplementationCode( $display );
}
-=head2 AddEmptyRows
+sub FindImplementationCode {
+ my $self = shift;
+ my $value = shift;
+ my $silent = shift;
-If we're grouping on a criterion we know how to add zero-value rows
-for, do that.
+ my $code;
+ unless ( $value ) {
+ $RT::Logger->error("Value is not defined. Should be method name or code reference")
+ unless $silent;
+ return undef;
+ }
+ elsif ( !ref $value ) {
+ $code = $self->can( $value );
+ unless ( $code ) {
+ $RT::Logger->error("No method $value in ". (ref $self || $self) ." class" )
+ unless $silent;
+ return undef;
+ }
+ }
+ elsif ( ref( $value ) eq 'CODE' ) {
+ $code = $value;
+ }
+ else {
+ $RT::Logger->error("$value is not method name or code reference")
+ unless $silent;
+ return undef;
+ }
+ return $code;
+}
-=cut
+sub Serialize {
+ my $self = shift;
+
+ my %clone = %$self;
+# current user, handle and column_info
+ delete @clone{'user', 'DBIxHandle', 'column_info'};
+ $clone{'items'} = [ map $_->{'values'}, @{ $clone{'items'} || [] } ];
+ $clone{'column_info'} = {};
+ while ( my ($k, $v) = each %{ $self->{'column_info'} } ) {
+ $clone{'column_info'}{$k} = { %$v };
+ delete $clone{'column_info'}{$k}{'META'};
+ }
+ return \%clone;
+}
-sub AddEmptyRows {
+sub Deserialize {
my $self = shift;
- if ( @{ $self->{'_group_by_field'} || [] } == 1 && $self->{'_group_by_field'}[0] eq 'Status' ) {
- my %has = map { $_->__Value('Status') => 1 } @{ $self->ItemsArrayRef || [] };
+ my $data = shift;
+
+ $self->CleanSlate;
+ %$self = (%$self, %$data);
+
+ $self->{'items'} = [
+ map { my $r = $self->NewItem; $r->LoadFromHash( $_ ); $r }
+ @{ $self->{'items'} }
+ ];
+ foreach my $e ( values %{ $self->{column_info} } ) {
+ $e->{'META'} = $e->{'TYPE'} eq 'grouping'
+ ? $GROUPINGS_META{ $e->{'INFO'} }
+ : $STATISTICS_META{ $e->{'INFO'}[1] }
+ }
+}
+
+
+sub FormatTable {
+ my $self = shift;
+ my %columns = @_;
+
+ my (@head, @body, @footer);
+
+ @head = ({ cells => []});
+ foreach my $column ( @{ $columns{'Groups'} } ) {
+ push @{ $head[0]{'cells'} }, { type => 'head', value => $self->Label( $column ) };
+ }
+
+ my $i = 0;
+ while ( my $entry = $self->Next ) {
+ $body[ $i ] = { even => ($i+1)%2, cells => [] };
+ $i++;
+ }
+ @footer = ({ even => ++$i%2, cells => []});
+
+ my $g = 0;
+ foreach my $column ( @{ $columns{'Groups'} } ) {
+ $i = 0;
+ my $last;
+ while ( my $entry = $self->Next ) {
+ my $value = $entry->LabelValue( $column );
+ if ( !$last || $last->{'value'} ne $value ) {
+ push @{ $body[ $i++ ]{'cells'} }, $last = { type => 'label', value => $value };
+ $last->{even} = $g++ % 2
+ unless $column eq $columns{'Groups'}[-1];
+ }
+ else {
+ $i++;
+ $last->{rowspan} = ($last->{rowspan}||1) + 1;
+ }
+ }
+ }
+ push @{ $footer[0]{'cells'} }, {
+ type => 'label',
+ value => $self->loc('Total'),
+ colspan => scalar @{ $columns{'Groups'} },
+ };
+
+ my $pick_color = do {
+ my @colors = RT->Config->Get("ChartColors");
+ sub { $colors[ $_[0] % @colors - 1 ] }
+ };
- foreach my $status ( grep !$has{$_}, RT::Queue->new($self->CurrentUser)->StatusArray ) {
+ my $function_count = 0;
+ foreach my $column ( @{ $columns{'Functions'} } ) {
+ $i = 0;
- my $record = $self->NewItem;
- $record->LoadFromHash( {
- id => 0,
- status => $status
- } );
- $self->AddRecord($record);
+ my $info = $self->ColumnInfo( $column );
+
+ my @subs = ('');
+ if ( $info->{'META'}{'SubValues'} ) {
+ @subs = $self->FindImplementationCode( $info->{'META'}{'SubValues'} )->(
+ $self
+ );
+ }
+
+ my %total;
+ unless ( $info->{'META'}{'NoTotals'} ) {
+ while ( my $entry = $self->Next ) {
+ my $raw = $entry->RawValue( $column ) || {};
+ $raw = { '' => $raw } unless ref $raw;
+ $total{ $_ } += $raw->{ $_ } foreach grep $raw->{$_}, @subs;
+ }
+ @subs = grep $total{$_}, @subs
+ unless $info->{'META'}{'NoHideEmpty'};
+ }
+
+ my $label = $self->Label( $column );
+
+ unless (@subs) {
+ while ( my $entry = $self->Next ) {
+ push @{ $body[ $i++ ]{'cells'} }, {
+ type => 'value',
+ value => undef,
+ query => $entry->Query,
+ };
+ }
+ push @{ $head[0]{'cells'} }, {
+ type => 'head',
+ value => $label,
+ rowspan => scalar @head,
+ color => $pick_color->(++$function_count),
+ };
+ push @{ $footer[0]{'cells'} }, { type => 'value', value => undef };
+ next;
+ }
+
+ if ( @subs > 1 && @head == 1 ) {
+ $_->{rowspan} = 2 foreach @{ $head[0]{'cells'} };
+ }
+
+ if ( @subs == 1 ) {
+ push @{ $head[0]{'cells'} }, {
+ type => 'head',
+ value => $label,
+ rowspan => scalar @head,
+ color => $pick_color->(++$function_count),
+ };
+ } else {
+ push @{ $head[0]{'cells'} }, { type => 'head', value => $label, colspan => scalar @subs };
+ push @{ $head[1]{'cells'} }, { type => 'head', value => $_, color => $pick_color->(++$function_count) }
+ foreach @subs;
+ }
+
+ while ( my $entry = $self->Next ) {
+ my $query = $entry->Query;
+ my $value = $entry->LabelValue( $column ) || {};
+ $value = { '' => $value } unless ref $value;
+ foreach my $e ( @subs ) {
+ push @{ $body[ $i ]{'cells'} }, {
+ type => 'value',
+ value => $value->{ $e },
+ query => $query,
+ };
+ }
+ $i++;
+ }
+
+ unless ( $info->{'META'}{'NoTotals'} ) {
+ my $total_code = $self->LabelValueCode( $column );
+ foreach my $e ( @subs ) {
+ my $total = $total{ $e };
+ $total = $total_code->( $self, %$info, VALUE => $total )
+ if $total_code;
+ push @{ $footer[0]{'cells'} }, { type => 'value', value => $total };
+ }
+ }
+ else {
+ foreach my $e ( @subs ) {
+ push @{ $footer[0]{'cells'} }, { type => 'value', value => undef };
+ }
}
}
+
+ return thead => \@head, tbody => \@body, tfoot => \@footer;
}
RT::Base->_ImportOverlays();
projects / freeside.git / blobdiff