rt/share/html/Search/Elements/BuildFormatString

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2019 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 # referenced by their ColumnMap keys
  73 my @fields = (
  74   qw(
  75     id QueueName Subject
  76   ),
  77
  78     $m->comp('/Elements/CustomerFields', 'Names'), #freeside
  79     $m->comp('/Elements/ServiceFields', 'Names'), #freeside
  80
  81   qw(
  82     Status ExtendedStatus UpdateStatus
  83     Type
  84
  85     OwnerName Requestors Cc AdminCc CreatedBy LastUpdatedBy
  86
  87     Priority InitialPriority FinalPriority
  88
  89     TimeWorked TimeLeft TimeEstimated
  90
  91     Starts      StartsRelative
  92     Started     StartedRelative
  93     Created     CreatedRelative
  94     LastUpdated LastUpdatedRelative
  95     Told        ToldRelative
  96     Due         DueRelative
  97     WillResolve WillResolveRelative
  98     Resolved    ResolvedRelative
  99
 100     RefersTo    ReferredToBy
 101     DependsOn   DependedOnBy
 102     MemberOf    Members
 103     Parents     Children
 104
 105     Bookmark
 106
 107     NEWLINE
 108     NBSP
 109   )
 110 ); # loc_qw
 111
 112 # This callback will only run once and will be removed in 4.4
 113 # If you want to add a new item to @fields, use the Default callback below.
 114 $m->callback( CallbackOnce => 1, CallbackName => 'SetFieldsOnce', Fields => \@fields );
 115
 116 my $CustomFields = RT::CustomFields->new( $session{'CurrentUser'});
 117 foreach my $id (keys %queues) {
 118     # Gotta load up the $queue object, since queues get stored by name now.
 119     my $queue = RT::Queue->new($session{'CurrentUser'});
 120     $queue->Load($id);
 121     next unless $queue->Id;
 122     $CustomFields->LimitToQueue($queue->Id);
 123     $CustomFields->SetContextObject( $queue ) if keys %queues == 1;
 124 }
 125 $CustomFields->LimitToGlobal;
 126
 127 while ( my $CustomField = $CustomFields->Next ) {
 128     push @fields, "CustomField.{" . $CustomField->Name . "}";
 129 }
 130
 131 $m->callback( Fields => \@fields, ARGSRef => \%ARGS );
 132
 133 my ( @seen);
 134
 135 $Format ||= RT->Config->Get('DefaultSearchResultFormat');
 136 my @format = $m->comp('/Elements/CollectionAsTable/ParseFormat', Format => $Format);
 137 foreach my $field (@format) {
 138     # "title" is for columns like NEWLINE, which doesn't have "attribute"
 139     $field->{Column} = $field->{attribute} || $field->{title} || '<blank>';
 140     push @seen, $field;
 141 }
 142
 143 if ( $RemoveCol ) {
 144     # we do this regex match to avoid a non-numeric warning
 145     my ($index) = ($CurrentDisplayColumns // '') =~ /^(\d+)/;
 146     if ( defined($index) ) {
 147         delete $seen[$index];
 148         my @temp = @seen;
 149         @seen = ();
 150         foreach my $element (@temp) {
 151             next unless $element;
 152             push @seen, $element;
 153         }
 154     }
 155 }
 156 elsif ( $AddCol ) {
 157     if ( defined $SelectDisplayColumns ) {
 158         my $selected = $SelectDisplayColumns;
 159         my @columns;
 160         if (ref($selected) eq 'ARRAY') {
 161             @columns = @$selected;
 162         } else {
 163             push @columns, $selected;
 164         }
 165         foreach my $col (@columns) {
 166             my %column = ();
 167             $column{Column} = $col;
 168
 169             if ( $Face eq "Bold" ) {
 170                 $column{Prefix} .= "<b>";
 171                 $column{Suffix} .= "</b>";
 172             }
 173             if ( $Face eq "Italic" ) {
 174                 $column{Prefix} .= "<i>";
 175                 $column{Suffix} .= "</i>";
 176             }
 177             if ($Size) {
 178                 if ( $Size eq 'Large' ) {
 179                     $column{Prefix} .= '<span style="font-size:larger">';
 180                     $column{Suffix} .= '</span>';
 181                 }
 182                 else {
 183                     $column{Prefix} .= "<" . $m->interp->apply_escapes( $Size,  'h' ) . ">";
 184                     $column{Suffix} .= "</" . $m->interp->apply_escapes( $Size, 'h' ) . ">";
 185                 }
 186             }
 187             if ( $Link eq "Display" ) {
 188                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Display.html?id=__id__">};
 189                 $column{Suffix} .= "</a>";
 190             }
 191             elsif ( $Link eq "Take" ) {
 192                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Display.html?Action=Take&id=__id__">};
 193                 $column{Suffix} .= "</a>";
 194             }
 195             elsif ( $Link eq "Respond" ) {
 196                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Update.html?Action=Respond&id=__id__">};
 197                 $column{Suffix} .= "</a>";
 198             }
 199             elsif ( $Link eq "Comment" ) {
 200                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Update.html?Action=Comment&id=__id__">};
 201                 $column{Suffix} .= "</a>";
 202             }
 203             elsif ( $Link eq "Resolve" ) {
 204                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Update.html?Action=Comment&DefaultStatus=resolved&id=__id__">};
 205                 $column{Suffix} .= "</a>";
 206             }
 207
 208             if ($Title) {
 209                 $column{Suffix} .= "/TITLE:" . $m->interp->apply_escapes( $Title, 'h' );
 210             }
 211             push @seen, \%column;
 212         }
 213     }
 214 }
 215 elsif ( $ColUp ) {
 216     my ($index) = ($CurrentDisplayColumns // '') =~ /^(\d+)/;
 217     if ( defined $index && ( $index - 1 ) >= 0 ) {
 218         my $column = $seen[$index];
 219         $seen[$index]       = $seen[ $index - 1 ];
 220         $seen[ $index - 1 ] = $column;
 221         $CurrentDisplayColumns     = $index - 1;
 222     }
 223 }
 224 elsif ( $ColDown ) {
 225     my ($index) = ($CurrentDisplayColumns // '') =~ /^(\d+)/;
 226     if ( defined $index && ( $index + 1 ) < scalar @seen ) {
 227         my $column = $seen[$index];
 228         $seen[$index]       = $seen[ $index + 1 ];
 229         $seen[ $index + 1 ] = $column;
 230         $CurrentDisplayColumns     = $index + 1;
 231     }
 232 }
 233
 234
 235 my @format_string;
 236 foreach my $field (@seen) {
 237     next unless $field;
 238     my $row = "";
 239     if ( $field->{'original_string'} ) {
 240         $row = $field->{'original_string'};
 241     }
 242     else {
 243         $row .= $field->{'Prefix'} if defined $field->{'Prefix'};
 244         $row .= "__$field->{'Column'}__"
 245           unless ( $field->{'Column'} eq "<blank>" );
 246         $row .= $field->{'Suffix'} if defined $field->{'Suffix'};
 247         $row =~ s!([\\'])!\\$1!g;
 248         $row = "'$row'";
 249     }
 250     push( @format_string, $row );
 251 }
 252
 253 $Format = join(",\n", @format_string);
 254
 255
 256 return($Format, \@fields, \@seen);
 257
 258 </%init>