share/html/Elements/TSVExport

   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 $Class => undef
  50 $Collection
  51 $Format
  52 $PreserveNewLines => 0
  53 </%ARGS>
  54 <%ONCE>
  55 my $no_html = HTML::Scrubber->new( deny => '*' );
  56 </%ONCE>
  57 <%INIT>
  58 require HTML::Entities;
  59 $Class ||= $Collection->ColumnMapClassName;
  60
  61 $r->content_type('application/vnd.ms-excel');
  62
  63 my $DisplayFormat = $m->comp('/Elements/ScrubHTML', Content => $Format);
  64
  65 my @Format = $m->comp('/Elements/CollectionAsTable/ParseFormat', Format => $DisplayFormat);
  66
  67 my @columns;
  68
  69 my $should_loc = { map { $_ => 1 } qw(Status) };
  70
  71 my $col_entry = sub {
  72     my $col = shift;
  73     # in tsv output, "#" is often a comment character but we use it for "id"
  74     delete $col->{title}
  75         if $col->{title} and $col->{title} =~ /^\s*#\s*$/;
  76     return {
  77         header => loc($col->{title} || $col->{attribute}),
  78         map    => $m->comp(
  79             "/Elements/ColumnMap",
  80             Name  => $col->{attribute},
  81             Attr  => 'value',
  82             Class => $Class,
  83         ),
  84         should_loc => $should_loc->{$col->{attribute}},
  85     }
  86 };
  87
  88 if ($PreserveNewLines) {
  89     my $col = [];
  90     push @columns, $col;
  91     for (@Format) {
  92         if ($_->{title} eq 'NEWLINE') {
  93             $col = [];
  94             push @columns, $col;
  95         }
  96         else {
  97             push @$col, $col_entry->($_);
  98         }
  99     }
 100 }
 101 else {
 102     push @columns, [map { $_->{attribute}
 103                           ? $col_entry->($_)
 104                           : () } @Format];
 105 }
 106
 107 for (@columns) {
 108     $m->out(join("\t", map { $_->{header} } @$_)."\n");
 109 }
 110
 111 my $ii = 0;
 112 while (my $row = $Collection->Next) {
 113     for my $col (@columns) {
 114         $m->out(join("\t", map {
 115             my $val = ProcessColumnMapValue($_->{map}, Arguments => [$row, $ii++], Escape => 0);
 116             $val = loc($val) if $_->{should_loc};
 117             # remove tabs from all field values, they screw up the tsv
 118             $val = '' unless defined $val;
 119             $val =~ s/(?:\n|\r)+/ /g; $val =~ s{\t}{    }g;
 120             $val = $no_html->scrub($val);
 121             $val = HTML::Entities::decode_entities($val);
 122             $val;
 123         } @$col)."\n");
 124     }
 125 }
 126 $m->abort();
 127
 128 </%INIT>