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 # This callback will only run once and will be removed in 4.4
 103 # If you want to add a new item to @fields, use the Default callback below.
 104 $m->callback( CallbackOnce => 1, CallbackName => 'SetFieldsOnce', Fields => \@fields );
 105
 106 my $CustomFields = RT::CustomFields->new( $session{'CurrentUser'});
 107 foreach my $id (keys %queues) {
 108     # Gotta load up the $queue object, since queues get stored by name now.
 109     my $queue = RT::Queue->new($session{'CurrentUser'});
 110     $queue->Load($id);
 111     next unless $queue->Id;
 112     $CustomFields->LimitToQueue($queue->Id);
 113     $CustomFields->SetContextObject( $queue ) if keys %queues == 1;
 114 }
 115 $CustomFields->LimitToGlobal;
 116
 117 while ( my $CustomField = $CustomFields->Next ) {
 118     push @fields, "CustomField.{" . $CustomField->Name . "}";
 119 }
 120
 121 $m->callback( Fields => \@fields, ARGSRef => \%ARGS );
 122
 123 my ( @seen);
 124
 125 $Format ||= RT->Config->Get('DefaultSearchResultFormat');
 126 my @format = $m->comp('/Elements/CollectionAsTable/ParseFormat', Format => $Format);
 127 foreach my $field (@format) {
 128     # "title" is for columns like NEWLINE, which doesn't have "attribute"
 129     $field->{Column} = $field->{attribute} || $field->{title} || '<blank>';
 130     push @seen, $field;
 131 }
 132
 133 if ( $RemoveCol ) {
 134     # we do this regex match to avoid a non-numeric warning
 135     my ($index) = $CurrentDisplayColumns =~ /^(\d+)/;
 136     my $column = $seen[$index];
 137     if ( defined($index) ) {
 138         delete $seen[$index];
 139         my @temp = @seen;
 140         @seen = ();
 141         foreach my $element (@temp) {
 142             next unless $element;
 143             push @seen, $element;
 144         }
 145     }
 146 }
 147 elsif ( $AddCol ) {
 148     if ( defined $SelectDisplayColumns ) {
 149         my $selected = $SelectDisplayColumns;
 150         my @columns;
 151         if (ref($selected) eq 'ARRAY') {
 152             @columns = @$selected;
 153         } else {
 154             push @columns, $selected;
 155         }
 156         foreach my $col (@columns) {
 157             my %column = ();
 158             $column{Column} = $col;
 159
 160             if ( $Face eq "Bold" ) {
 161                 $column{Prefix} .= "<b>";
 162                 $column{Suffix} .= "</b>";
 163             }
 164             if ( $Face eq "Italic" ) {
 165                 $column{Prefix} .= "<i>";
 166                 $column{Suffix} .= "</i>";
 167             }
 168             if ($Size) {
 169                 $column{Prefix} .= "<" . $m->interp->apply_escapes( $Size,  'h' ) . ">";
 170                 $column{Suffix} .= "</" . $m->interp->apply_escapes( $Size, 'h' ) . ">";
 171             }
 172             if ( $Link eq "Display" ) {
 173                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Display.html?id=__id__">};
 174                 $column{Suffix} .= "</a>";
 175             }
 176             elsif ( $Link eq "Take" ) {
 177                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Display.html?Action=Take&id=__id__">};
 178                 $column{Suffix} .= "</a>";
 179             }
 180             elsif ( $Link eq "Respond" ) {
 181                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Update.html?Action=Respond&id=__id__">};
 182                 $column{Suffix} .= "</a>";
 183             }
 184             elsif ( $Link eq "Comment" ) {
 185                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Update.html?Action=Comment&id=__id__">};
 186                 $column{Suffix} .= "</a>";
 187             }
 188             elsif ( $Link eq "Resolve" ) {
 189                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Update.html?Action=Comment&DefaultStatus=resolved&id=__id__">};
 190                 $column{Suffix} .= "</a>";
 191             }
 192
 193             if ($Title) {
 194                 $column{Suffix} .= "/TITLE:" . $m->interp->apply_escapes( $Title, 'h' );
 195             }
 196             push @seen, \%column;
 197         }
 198     }
 199 }
 200 elsif ( $ColUp ) {
 201     my $index = $CurrentDisplayColumns;
 202     if ( defined $index && ( $index - 1 ) >= 0 ) {
 203         my $column = $seen[$index];
 204         $seen[$index]       = $seen[ $index - 1 ];
 205         $seen[ $index - 1 ] = $column;
 206         $CurrentDisplayColumns     = $index - 1;
 207     }
 208 }
 209 elsif ( $ColDown ) {
 210     my $index = $CurrentDisplayColumns;
 211     if ( defined $index && ( $index + 1 ) < scalar @seen ) {
 212         my $column = $seen[$index];
 213         $seen[$index]       = $seen[ $index + 1 ];
 214         $seen[ $index + 1 ] = $column;
 215         $CurrentDisplayColumns     = $index + 1;
 216     }
 217 }
 218
 219
 220 my @format_string;
 221 foreach my $field (@seen) {
 222     next unless $field;
 223     my $row = "";
 224     if ( $field->{'original_string'} ) {
 225         $row = $field->{'original_string'};
 226     }
 227     else {
 228         $row .= $field->{'Prefix'} if defined $field->{'Prefix'};
 229         $row .= "__$field->{'Column'}__"
 230           unless ( $field->{'Column'} eq "<blank>" );
 231         $row .= $field->{'Suffix'} if defined $field->{'Suffix'};
 232         $row =~ s!([\\'])!\\$1!g;
 233         $row = "'$row'";
 234     }
 235     push( @format_string, $row );
 236 }
 237
 238 $Format = join(",\n", @format_string);
 239
 240
 241 return($Format, \@fields, \@seen);
 242
 243 </%init>