rt/share/html/Search/Results.tsv

   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 <%INIT>
  56
  57 $r->content_type('text/tab-separated-values');
  58 $r->header_out('Content-Disposition' => 'attachment;filename="Results.tsv"');
  59
  60 my $DisplayFormat = $m->comp('/Elements/ScrubHTML', Content => $Format);
  61
  62 my @Format = $m->comp('/Elements/CollectionAsTable/ParseFormat', Format => $DisplayFormat);
  63
  64 my @columns;
  65
  66 my $should_loc = { map { $_ => 1 } qw(Status) };
  67
  68 my $col_entry = sub {
  69     my $col = shift;
  70     # in tsv output, "#" is often a comment character but we use it for "id"
  71     delete $col->{title}
  72         if $col->{title} and $col->{title} =~ /^\s*#\s*$/;
  73     return {
  74         header => Encode::encode_utf8(loc($col->{title} || $col->{attribute})),
  75         map    => $m->comp(
  76             "/Elements/ColumnMap",
  77             Name  => $col->{attribute},
  78             Attr  => 'value'
  79         ),
  80         should_loc => $should_loc->{$col->{attribute}},
  81     }
  82 };
  83
  84 if ($PreserveNewLines) {
  85     my $col = [];
  86     push @columns, $col;
  87     for (@Format) {
  88         if ($_->{title} eq 'NEWLINE') {
  89             $col = [];
  90             push @columns, $col;
  91         }
  92         else {
  93             push @$col, $col_entry->($_);
  94         }
  95     }
  96 }
  97 else {
  98     push @columns, [map { $_->{attribute}
  99                           ? $col_entry->($_)
 100                           : () } @Format];
 101 }
 102
 103 for (@columns) {
 104     $m->out(join("\t", map { $_->{header} } @$_)."\n");
 105 }
 106
 107 my $Tickets = RT::Tickets->new( $session{'CurrentUser'} );
 108 $Tickets->FromSQL( $Query );
 109 if ( $OrderBy =~ /\|/ ) {
 110     # Multiple Sorts
 111     my @OrderBy = split /\|/, $OrderBy;
 112     my @Order   = split /\|/, $Order;
 113     $Tickets->OrderByCols(
 114         map { { FIELD => $OrderBy[$_], ORDER => $Order[$_] } }
 115         ( 0 .. $#OrderBy )
 116     );
 117 }
 118 else {
 119     $Tickets->OrderBy( FIELD => $OrderBy, ORDER => $Order );
 120 }
 121
 122 my $ii = 0;
 123 while (my $row = $Tickets->Next) {
 124     for my $col (@columns) {
 125         $m->out(join("\t", map {
 126             my $val = ProcessColumnMapValue($_->{map}, Arguments => [$row, $ii++], Escape => 0);
 127             $val = loc($val) if $_->{should_loc};
 128             # remove tabs from all field values, they screw up the tsv
 129             $val = '' unless defined $val;
 130             $val =~ s/(?:\n|\r)//g; $val =~ s{\t}{    }g;
 131             Encode::encode_utf8($val);
 132         } @$col)."\n");
 133     }
 134 }
 135 $m->abort();
 136
 137 </%INIT>