Merge branch 'master' of git.freeside.biz:/home/git/freeside
[freeside.git] / rt / lib / RT / Report / Tickets / Entry.pm
1 # BEGIN BPS TAGGED BLOCK {{{
2 #
3 # COPYRIGHT:
4 #
5 # This software is Copyright (c) 1996-2015 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 package RT::Report::Tickets::Entry;
50
51 use warnings;
52 use strict;
53
54 use base qw/RT::Record/;
55
56 # XXX TODO: how the heck do we acl a report?
57 sub CurrentUserHasRight {1}
58
59 =head2 LabelValue
60
61 If you're pulling a value out of this collection and using it as a label,
62 you may want the "cleaned up" version.  This includes scrubbing 1970 dates
63 and ensuring that dates are in local not DB timezones.
64
65 =cut
66
67 sub LabelValue {
68     my $self  = shift;
69     my $name = shift;
70
71     my $raw = $self->RawValue( $name, @_ );
72
73     if ( my $code = $self->Report->LabelValueCode( $name ) ) {
74         $raw = $code->( $self, %{ $self->Report->ColumnInfo( $name ) }, VALUE => $raw );
75         return $self->loc('(no value)') unless defined $raw && length $raw;
76         return $raw;
77     }
78
79     unless ( ref $raw ) {
80         return $self->loc('(no value)') unless defined $raw && length $raw;
81         return $self->loc($raw) if $self->Report->ColumnInfo( $name )->{'META'}{'Localize'};
82         return $raw;
83     } else {
84         my $loc = $self->Report->ColumnInfo( $name )->{'META'}{'Localize'};
85         my %res = %$raw;
86         if ( $loc ) {
87             $res{ $self->loc($_) } = delete $res{ $_ } foreach keys %res;
88             $_ = $self->loc($_) foreach values %res;
89         }
90         $_ = $self->loc('(no value)') foreach grep !defined || !length, values %res;
91         return \%res;
92     }
93 }
94
95 sub RawValue {
96     return (shift)->__Value( @_ );
97 }
98
99 sub ObjectType {
100     return 'RT::Ticket';
101 }
102
103 sub CustomFieldLookupType {
104     RT::Ticket->CustomFieldLookupType
105 }
106
107 sub Query {
108     my $self = shift;
109
110     my @parts;
111     foreach my $column ( $self->Report->ColumnsList ) {
112         my $info = $self->Report->ColumnInfo( $column );
113         next unless $info->{'TYPE'} eq 'grouping';
114
115         my $custom = $info->{'META'}{'Query'};
116         if ( $custom and my $code = $self->Report->FindImplementationCode( $custom ) ) {
117             push @parts, $code->( $self, COLUMN => $column, %$info );
118         }
119         else {
120             my $field = join '.', grep $_, $info->{KEY}, $info->{SUBKEY};
121             my $value = $self->RawValue( $column );
122             my $op = '=';
123             if ( defined $value ) {
124                 unless ( $value =~ /^\d+$/ ) {
125                     $value =~ s/(['\\])/\\$1/g;
126                     $value = "'$value'";
127                 }
128             }
129             else {
130                 ($op, $value) = ('IS', 'NULL');
131             }
132             unless ( $field =~ /^[{}\w\.]+$/ ) {
133                 $field =~ s/(['\\])/\\$1/g;
134                 $field = "'$field'";
135             }
136             push @parts, "$field $op $value";
137         }
138     }
139     return () unless @parts;
140     return join ' AND ', map "($_)", grep defined && length, @parts;
141 }
142
143 sub Report {
144     return $_[0]->{'report'};
145 }
146
147 RT::Base->_ImportOverlays();
148
149 1;