html/Search/Results.xls

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2014 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 $Format => undef
  50 $Query => ''
  51 $OrderBy => 'id'
  52 $Order => 'ASC'
  53 $PreserveNewLines => 0
  54 </%ARGS>
  55 <%ONCE>
  56 my $no_html = HTML::Scrubber->new( deny => '*' );
  57 </%ONCE>
  58 <%INIT>
  59 require HTML::Entities;
  60
  61 use Spreadsheet::WriteExcel;
  62 my $xls;
  63 my $fh;
  64 open ($fh, ">",  \$xls) or die "$!";
  65 my $workbook = Spreadsheet::WriteExcel->new($fh) or die $!;
  66 my $worksheet = $workbook->add_worksheet();
  67
  68
  69 $r->content_type('application/vnd.ms-excel');
  70
  71 my $DisplayFormat = $m->comp('/Elements/ScrubHTML', Content => $Format);
  72
  73 my @Format = $m->comp('/Elements/CollectionAsTable/ParseFormat', Format => $DisplayFormat);
  74
  75 my @columns;
  76
  77 my $should_loc = { map { $_ => 1 } qw(Status) };
  78
  79 my $col_entry = sub {
  80     my $col = shift;
  81     # in tsv output, "#" is often a comment character but we use it for "id"
  82     delete $col->{title}
  83         if $col->{title} and $col->{title} =~ /^\s*#\s*$/;
  84     return {
  85         header => loc($col->{title} || $col->{attribute}),
  86         map    => $m->comp(
  87             "/Elements/ColumnMap",
  88             Name  => $col->{attribute},
  89             Attr  => 'value'
  90         ),
  91         should_loc => $should_loc->{$col->{attribute}},
  92     }
  93 };
  94
  95 if ($PreserveNewLines) {
  96     my $col = [];
  97     push @columns, $col;
  98     for (@Format) {
  99         if ($_->{title} eq 'NEWLINE') {
 100             $col = [];
 101             push @columns, $col;
 102         }
 103         else {
 104             push @$col, $col_entry->($_);
 105         }
 106     }
 107 }
 108 else {
 109     push @columns, [map { $_->{attribute}
 110                           ? $col_entry->($_)
 111                           : () } @Format];
 112 }
 113
 114 my $ws_col = 0;
 115 for (@columns) {
 116     foreach my $ws_val (map { $_->{header} } @$_) {
 117         $worksheet->write_string(0, $ws_col, $ws_val);
 118         $ws_col++;
 119     }
 120 }
 121
 122 my $Tickets = RT::Tickets->new( $session{'CurrentUser'} );
 123 $Tickets->FromSQL( $Query );
 124 if ( $OrderBy =~ /\|/ ) {
 125     # Multiple Sorts
 126     my @OrderBy = split /\|/, $OrderBy;
 127     my @Order   = split /\|/, $Order;
 128     $Tickets->OrderByCols(
 129         map { { FIELD => $OrderBy[$_], ORDER => $Order[$_] } }
 130         ( 0 .. $#OrderBy )
 131     );
 132 }
 133 else {
 134     $Tickets->OrderBy( FIELD => $OrderBy, ORDER => $Order );
 135 }
 136
 137 my $ws_row = 1;
 138 my $ii = 0;
 139 while (my $row = $Tickets->Next) {
 140     $ws_col = 0;
 141     for my $col (@columns) {
 142         for (@$col) {
 143             my $val = ProcessColumnMapValue($_->{map}, Arguments => [$row, $ii++], Escape => 0);
 144             $val = loc($val) if $_->{should_loc};
 145             $val = '' unless defined $val;
 146             $val = $no_html->scrub($val);
 147             $val = HTML::Entities::decode_entities($val);
 148             $worksheet->write_string($ws_row, $ws_col, $val);
 149             $ws_col++;
 150         }
 151     }
 152     $ws_row++;
 153 }
 154
 155 $workbook->close;
 156 close($fh);
 157 $m->print($xls);
 158 $m->abort();
 159
 160 </%INIT>