share/html/Search/Elements/BuildFormatString

   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 => RT->Config->Get('DefaultSearchResultFormat')
  50
  51 %queues => ()
  52
  53 $Face => undef
  54 $Size => undef
  55 $Link => undef
  56 $Title => undef
  57
  58 $AddCol => undef
  59 $RemoveCol => undef
  60 $ColUp => undef
  61 $ColDown => undef
  62
  63 $SelectDisplayColumns => undef
  64 $CurrentDisplayColumns => undef
  65 </%ARGS>
  66 <%init>
  67 # This can't be in a <once> block, because otherwise we return the
  68 # same \@fields every request, and keep tacking more CustomFields onto
  69 # it -- and it grows per request.
  70
  71 # All the things we can display in the format string by default
  72 my @fields = qw(
  73     id QueueName Subject
  74     Status ExtendedStatus UpdateStatus
  75     Type
  76
  77     OwnerName Requestors Cc AdminCc CreatedBy LastUpdatedBy
  78
  79     Priority InitialPriority FinalPriority
  80
  81     TimeWorked TimeLeft TimeEstimated
  82
  83     Starts      StartsRelative
  84     Started     StartedRelative
  85     Created     CreatedRelative
  86     LastUpdated LastUpdatedRelative
  87     Told        ToldRelative
  88     Due         DueRelative
  89     Resolved    ResolvedRelative
  90
  91     RefersTo    ReferredToBy
  92     DependsOn   DependedOnBy
  93     MemberOf    Members
  94     Parents     Children
  95
  96     Bookmark
  97
  98     NEWLINE
  99     NBSP
 100 ); # loc_qw
 101
 102 $m->callback( CallbackOnce => 1, CallbackName => 'SetFieldsOnce', Fields => \@fields );
 103
 104 my $CustomFields = RT::CustomFields->new( $session{'CurrentUser'});
 105 foreach my $id (keys %queues) {
 106     # Gotta load up the $queue object, since queues get stored by name now.
 107     my $queue = RT::Queue->new($session{'CurrentUser'});
 108     $queue->Load($id);
 109     $CustomFields->LimitToQueue($queue->Id) if $queue->Id;
 110 }
 111 $CustomFields->LimitToGlobal;
 112
 113 while ( my $CustomField = $CustomFields->Next ) {
 114     push @fields, "CustomField.{" . $CustomField->Name . "}";
 115 }
 116
 117 $m->callback( Fields => \@fields, ARGSRef => \%ARGS );
 118
 119 my ( @seen);
 120
 121 $Format ||= RT->Config->Get('DefaultSearchResultFormat');
 122 my @format = $m->comp('/Elements/CollectionAsTable/ParseFormat', Format => $Format);
 123 foreach my $field (@format) {
 124     # "title" is for columns like NEWLINE, which doesn't have "attribute"
 125     $field->{Column} = $field->{attribute} || $field->{title} || '<blank>';
 126     push @seen, $field;
 127 }
 128
 129 if ( $RemoveCol ) {
 130     # we do this regex match to avoid a non-numeric warning
 131     my ($index) = $CurrentDisplayColumns =~ /^(\d+)/;
 132     my $column = $seen[$index];
 133     if ( defined($index) ) {
 134         delete $seen[$index];
 135         my @temp = @seen;
 136         @seen = ();
 137         foreach my $element (@temp) {
 138             next unless $element;
 139             push @seen, $element;
 140         }
 141     }
 142 }
 143 elsif ( $AddCol ) {
 144     if ( defined $SelectDisplayColumns ) {
 145         my $selected = $SelectDisplayColumns;
 146         my @columns;
 147         if (ref($selected) eq 'ARRAY') {
 148             @columns = @$selected;
 149         } else {
 150             push @columns, $selected;
 151         }
 152         foreach my $col (@columns) {
 153             my %column = ();
 154             $column{Column} = $col;
 155
 156             if ( $Face eq "Bold" ) {
 157                 $column{Prefix} .= "<b>";
 158                 $column{Suffix} .= "</b>";
 159             }
 160             if ( $Face eq "Italic" ) {
 161                 $column{Prefix} .= "<i>";
 162                 $column{Suffix} .= "</i>";
 163             }
 164             if ($Size) {
 165                 $column{Prefix} .= "<" . $m->interp->apply_escapes( $Size,  'h' ) . ">";
 166                 $column{Suffix} .= "</" . $m->interp->apply_escapes( $Size, 'h' ) . ">";
 167             }
 168             if ( $Link eq "Display" ) {
 169                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Display.html?id=__id__">};
 170                 $column{Suffix} .= "</a>";
 171             }
 172             elsif ( $Link eq "Take" ) {
 173                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Display.html?Action=Take&id=__id__">};
 174                 $column{Suffix} .= "</a>";
 175             }
 176             elsif ( $Link eq "Respond" ) {
 177                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Update.html?Action=Respond&id=__id__">};
 178                 $column{Suffix} .= "</a>";
 179             }
 180             elsif ( $Link eq "Comment" ) {
 181                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Update.html?Action=Comment&id=__id__">};
 182                 $column{Suffix} .= "</a>";
 183             }
 184             elsif ( $Link eq "Resolve" ) {
 185                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Update.html?Action=Comment&DefaultStatus=resolved&id=__id__">};
 186                 $column{Suffix} .= "</a>";
 187             }
 188
 189             if ($Title) {
 190                 $column{Suffix} .= "/TITLE:" . $m->interp->apply_escapes( $Title, 'h' );
 191             }
 192             push @seen, \%column;
 193         }
 194     }
 195 }
 196 elsif ( $ColUp ) {
 197     my $index = $CurrentDisplayColumns;
 198     if ( defined $index && ( $index - 1 ) >= 0 ) {
 199         my $column = $seen[$index];
 200         $seen[$index]       = $seen[ $index - 1 ];
 201         $seen[ $index - 1 ] = $column;
 202         $CurrentDisplayColumns     = $index - 1;
 203     }
 204 }
 205 elsif ( $ColDown ) {
 206     my $index = $CurrentDisplayColumns;
 207     if ( defined $index && ( $index + 1 ) < scalar @seen ) {
 208         my $column = $seen[$index];
 209         $seen[$index]       = $seen[ $index + 1 ];
 210         $seen[ $index + 1 ] = $column;
 211         $CurrentDisplayColumns     = $index + 1;
 212     }
 213 }
 214
 215
 216 my @format_string;
 217 foreach my $field (@seen) {
 218     next unless $field;
 219     my $row = "";
 220     if ( $field->{'output'} ) {
 221         $row = join '', @{$field->{'output'}};
 222     }
 223     else {
 224         $row .= $field->{'Prefix'} if defined $field->{'Prefix'};
 225         $row .= "__$field->{'Column'}__"
 226           unless ( $field->{'Column'} eq "<blank>" );
 227         $row .= $field->{'Suffix'} if defined $field->{'Suffix'};
 228     }
 229     $row =~ s!([\\'])!\\$1!g;
 230     $row = "'$row'";
 231     push( @format_string, $row );
 232 }
 233
 234 $Format = join(",\n", @format_string);
 235
 236
 237 return($Format, \@fields, \@seen);
 238
 239 </%init>