Putting 4.2.0 on top of 4.0.17
[usit-rt.git] / share / html / Search / Results.tsv
1 %# BEGIN BPS TAGGED BLOCK {{{
2 %#
3 %# COPYRIGHT:
4 %#
5 %# This software is Copyright (c) 1996-2013 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 $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 => Encode::encode_utf8(loc($col->{title} || $col->{attribute})),
78         map    => $m->comp(
79             "/Elements/ColumnMap",
80             Name  => $col->{attribute},
81             Attr  => 'value'
82         ),
83         should_loc => $should_loc->{$col->{attribute}},
84     }
85 };
86
87 if ($PreserveNewLines) {
88     my $col = [];
89     push @columns, $col;
90     for (@Format) {
91         if ($_->{title} eq 'NEWLINE') {
92             $col = [];
93             push @columns, $col;
94         }
95         else {
96             push @$col, $col_entry->($_);
97         }
98     }
99 }
100 else {
101     push @columns, [map { $_->{attribute}
102                           ? $col_entry->($_)
103                           : () } @Format];
104 }
105
106 for (@columns) {
107     $m->out(join("\t", map { $_->{header} } @$_)."\n");
108 }
109
110 my $Tickets = RT::Tickets->new( $session{'CurrentUser'} );
111 $Tickets->FromSQL( $Query );
112 if ( $OrderBy =~ /\|/ ) {
113     # Multiple Sorts
114     my @OrderBy = split /\|/, $OrderBy;
115     my @Order   = split /\|/, $Order;
116     $Tickets->OrderByCols(
117         map { { FIELD => $OrderBy[$_], ORDER => $Order[$_] } }
118         ( 0 .. $#OrderBy )
119     );
120 }
121 else {
122     $Tickets->OrderBy( FIELD => $OrderBy, ORDER => $Order );
123 }
124
125 my $ii = 0;
126 while (my $row = $Tickets->Next) {
127     for my $col (@columns) {
128         $m->out(join("\t", map {
129             my $val = ProcessColumnMapValue($_->{map}, Arguments => [$row, $ii++], Escape => 0);
130             $val = loc($val) if $_->{should_loc};
131             # remove tabs from all field values, they screw up the tsv
132             $val = '' unless defined $val;
133             $val =~ s/(?:\n|\r)//g; $val =~ s{\t}{    }g;
134             $val = $no_html->scrub($val);
135             $val = HTML::Entities::decode_entities($val);
136             Encode::encode_utf8($val);
137         } @$col)."\n");
138     }
139 }
140 $m->abort();
141
142 </%INIT>