rt/html/Search/Chart

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
   6 %#                                          <jesse@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 <%args>
  49 $Query => "id > 0"
  50 $PrimaryGroupBy => 'Queue'
  51 $SecondaryGroupBy => undef
  52 $ChartStyle => 'bars'
  53 </%args>
  54 <%init>
  55 my @keys;
  56 my @values;
  57 my $chart_class;
  58 use GD;
  59 use GD::Text;
  60
  61 if ($ChartStyle eq 'pie') {
  62     require GD::Graph::pie;
  63     $chart_class = "GD::Graph::pie";
  64 } else {
  65     require GD::Graph::bars;
  66     $chart_class = "GD::Graph::bars";
  67 }
  68
  69 use RT::Report::Tickets;
  70 my $tix = RT::Report::Tickets->new( $session{'CurrentUser'} );
  71 $tix->FromSQL( $Query );
  72 my $count_name = $tix->Column( FUNCTION => 'COUNT', FIELD => 'id' );
  73 $tix->GroupBy( FIELD => $PrimaryGroupBy );
  74 my $value_name = $tix->Column( FIELD => $PrimaryGroupBy );
  75
  76 my $chart = $chart_class->new( 600 => 400 );
  77
  78 my $font = $RT::ChartFont || ['verdana', 'arial', gdMediumBoldFont];
  79 $chart->set_title_font( $font, 12 ) if $chart->can('set_title_font');
  80 $chart->set_legend_font( $font, 12 ) if $chart->can('set_legend_font');
  81 $chart->set_x_label_font( $font, 10 ) if $chart->can('set_x_label_font');
  82 $chart->set_y_label_font( $font, 10 ) if $chart->can('set_y_label_font');
  83 $chart->set_label_font( $font, 10 ) if $chart->can('set_label_font');
  84 $chart->set_x_axis_font( $font, 9 ) if $chart->can('set_x_axis_font');
  85 $chart->set_y_axis_font( $font, 9 ) if $chart->can('set_y_axis_font');
  86 $chart->set_values_font( $font, 9 ) if $chart->can('set_values_font');
  87 $chart->set_value_font( $font, 9 ) if $chart->can('set_value_font');
  88
  89 # Pie charts don't like having no input, so we show a special image
  90 # that indicates an error message. Because this is used in an <img>
  91 # context, it can't be a simple error message. Without this check,
  92 # the chart will just be a non-loading image.
  93 if ($tix->Count == 0) {
  94     my $plot = GD::Image->new(600 => 400);
  95     $plot->colorAllocate(255, 255, 255); # background
  96     my $black = $plot->colorAllocate(0, 0, 0);
  97
  98     require GD::Text::Wrap;
  99     my $error = GD::Text::Wrap->new($plot,
 100         color => $black,
 101         text  => loc("No tickets found."),
 102     );
 103     $error->set_font( $font, 12 );
 104     $error->draw(0, 0);
 105
 106     $m->comp( 'SELF:Plot', plot => $plot, %ARGS );
 107 }
 108
 109 if ($chart_class eq "GD::Graph::bars") {
 110     $chart->set(
 111         x_label => $tix->Label( $PrimaryGroupBy ),
 112         x_labels_vertical => 1,
 113         y_label => loc('Tickets'),
 114         show_values => 1
 115     );
 116 }
 117
 118 my %class = (
 119     Queue => 'RT::Queue',
 120     Owner => 'RT::User',
 121 );
 122 my $class = $class{ $PrimaryGroupBy };
 123
 124 while ( my $entry = $tix->Next ) {
 125     if ( $class ) {
 126         my $q = $class->new( $session{'CurrentUser'} );
 127         $q->Load( $entry->__Value( $value_name ) );
 128         push @keys, $q->Name;
 129     }
 130     else {
 131         push @keys, $entry->__Value($value_name);
 132     }
 133
 134     $keys[-1] ||= loc('(no value)');
 135     if ($chart_class eq 'GD::Graph::pie') {
 136         $keys[-1] .= " - ". $entry->__Value( $count_name );
 137     }
 138     push @values, $entry->__Value($count_name);
 139 }
 140
 141 # XXX: Convert 1970-01-01 date to the 'Not Set'
 142 # this code should be generalized!!!
 143 if ( $PrimaryGroupBy =~ /(Daily|Monthly|Annually)$/ ) {
 144     my $re;
 145     $re = qr{1970-01-01} if $PrimaryGroupBy =~ /Daily$/;
 146     $re = qr{1970-01} if $PrimaryGroupBy =~ /Monthly$/;
 147     $re = qr{1970} if $PrimaryGroupBy =~ /Annually$/;
 148     foreach (@keys) {
 149         s/^$re/loc('Not Set')/e;
 150     }
 151 }
 152
 153 unless (@keys && @values) {
 154     @keys = ('');
 155     @values = (0);
 156 }
 157
 158 my %data;
 159 foreach my $key (@keys) { $data{$key} = shift @values; }
 160 my @sorted_keys = sort @keys;
 161 my @sorted_values = map { $data{$_}} @sorted_keys;
 162
 163
 164
 165 my $plot = $chart->plot( [ [@sorted_keys], [@sorted_values] ] ) or die $chart->error;
 166 $m->comp( 'SELF:Plot', plot => $plot, %ARGS );
 167 </%init>
 168
 169 <%METHOD Plot>
 170 <%ARGS>
 171 $plot => undef
 172 </%ARGS>
 173 <%INIT>
 174 my @types = ('png', 'gif');
 175
 176 for my $type (@types) {
 177     $plot->can($type)
 178         or next;
 179
 180     $r->content_type("image/$type");
 181     $m->out( $plot->$type );
 182     $m->abort();
 183 }
 184
 185 die "Your GD library appears to support none of the following image types: " . join(', ', @types);
 186 </%INIT>
 187
 188 </%METHOD>