rt/share/html/Search/Results.csv

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2011 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 <%ARGS>
  49 $Query => ''
  50 $OrderBy => 'id'
  51 $Order => 'ASC'
  52 </%ARGS>
  53 <%INIT>
  54
  55 eval "use Text::CSV_XS";
  56 if ( $@ ) {
  57   $m->comp('/Error', Why => "Error loading Text::CSV_XS.\n$@");
  58   $m->abort;
  59   return;
  60 }
  61
  62 my $csv = Text::CSV_XS->new( { eol => "\n" } );
  63
  64 my $Tickets = RT::Tickets->new( $session{'CurrentUser'} );
  65 $Tickets->FromSQL( $Query );
  66 if ( $OrderBy =~ /\|/ ) {
  67     # Multiple Sorts
  68     my @OrderBy = split /\|/, $OrderBy;
  69     my @Order   = split /\|/, $Order;
  70     $Tickets->OrderByCols(
  71         map { { FIELD => $OrderBy[$_], ORDER => $Order[$_] } }
  72         ( 0 .. $#OrderBy )
  73     );
  74 }
  75 else {
  76     $Tickets->OrderBy( FIELD => $OrderBy, ORDER => $Order );
  77 }
  78
  79 my %cf_id_to_name;
  80 my %cf_name_to_pos;
  81 {
  82     my $cfs = RT::SQL::PossibleCustomFields(
  83         Query => $Query, CurrentUser => $session{'CurrentUser'},
  84     );
  85     while ( my $cf = $cfs->Next ) {
  86         my $name = $cf->Name;
  87         $cf_id_to_name{ $cf->id } = $name;
  88         next if $cf_name_to_pos{ $name };
  89
  90         $cf_name_to_pos{ $name } =
  91             (sort { $b <=> $a } values %cf_name_to_pos)[0] + 1;
  92     }
  93 }
  94
  95 my @attrs = qw(
  96     id QueueObj->Name Subject Status
  97     TimeEstimated TimeWorked TimeLeft
  98     Priority FinalPriority
  99     OwnerObj->Name
 100     Requestors->MemberEmailAddressesAsString
 101     Cc->MemberEmailAddressesAsString
 102     AdminCc->MemberEmailAddressesAsString
 103     DueObj->ISO ToldObj->ISO CreatedObj->ISO
 104     ResolvedObj->ISO LastUpdatedObj->ISO LastUpdatedByObj->Name
 105 );
 106
 107 $r->content_type('text/csv');
 108 $r->header_out('Content-Disposition' => 'attachment;filename="Results.csv"');
 109 {
 110     my @header;
 111     foreach my $attr (@attrs) {
 112         my $label = $attr;
 113         $label =~ s'Obj-.(?:AsString|Name|ISO)''g;
 114         $label =~ s'-\>MemberEmailAddressesAsString''g;
 115         push @header, $label;
 116     }
 117
 118     $_ += @header - 1 foreach values %cf_name_to_pos;
 119
 120     foreach my $name ( sort { $cf_name_to_pos{$a} <=> $cf_name_to_pos{$b} } keys %cf_name_to_pos ) {
 121         push @header, "CF-". $name;
 122     }
 123     $csv->combine(@header);
 124     $m->out($csv->string());
 125     $m->flush_buffer;
 126 }
 127
 128 my $i = 0;
 129 while ( my $Ticket = $Tickets->Next()) {
 130     my @row;
 131     foreach my $attr (@attrs) {
 132         my $value;
 133         if ($attr =~ /(.*)->ISO$/ and $Ticket->$1->Unix <= 0) {
 134             $value = '';
 135         } else {
 136             my $method = '$Ticket->'.$attr.'()';
 137             $method =~ s/->ISO\(\)$/->ISO( Timezone => 'user' )/;
 138             $value = eval $method;
 139             if ($@) {die "Failed to find $attr - ". $@};
 140         }
 141         push @row, $value;
 142     }
 143
 144     my $values = $Ticket->CustomFieldValues;
 145     $values->OrderByCols; # don't sort them
 146     while (my $value = $values->Next) {
 147         my $pos = $cf_name_to_pos{ $cf_id_to_name{ $value->CustomField } };
 148         next unless $pos;
 149
 150         $row[$pos] = '' unless defined $row[$pos];
 151         $row[$pos] .= ', ' if $row[$pos];
 152         $row[$pos] .= $value->Content;
 153     }
 154
 155     # remove tabs from all field values, they screw up the tsv
 156     for (@row) {
 157         $_ = '' unless defined;
 158         $_ =~ s/(?:\n|\r)//g;
 159         $_ =~ s{\t}{    }g;
 160     }
 161
 162     $csv->combine(@row);
 163     $m->out($csv->string());
 164
 165     unless (++$i%10) {
 166         $i = 0;
 167         $m->flush_buffer;
 168     }
 169 }
 170
 171 $m->abort();
 172 </%INIT>