rt/share/html/Search/Elements/BuildFormatString

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2015 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. my $id
 119     my $queue = RT::Queue->new($session{'CurrentUser'});
 120     $queue->Load($id);
 121     $CustomFields->LimitToQueue($queue->Id) if $queue->Id;
 122 }
 123 $CustomFields->LimitToGlobal;
 124
 125 while ( my $CustomField = $CustomFields->Next ) {
 126     push @fields, "CustomField.{" . $CustomField->Name . "}";
 127 }
 128
 129 $m->callback( Fields => \@fields, ARGSRef => \%ARGS );
 130
 131 my ( @seen);
 132
 133 $Format ||= RT->Config->Get('DefaultSearchResultFormat');
 134 my @format = $m->comp('/Elements/CollectionAsTable/ParseFormat', Format => $Format);
 135 foreach my $field (@format) {
 136     # "title" is for columns like NEWLINE, which doesn't have "attribute"
 137     $field->{Column} = $field->{attribute} || $field->{title} || '<blank>';
 138     push @seen, $field;
 139 }
 140
 141 if ( $RemoveCol ) {
 142     # we do this regex match to avoid a non-numeric warning
 143     my ($index) = $CurrentDisplayColumns =~ /^(\d+)/;
 144     my $column = $seen[$index];
 145     if ( defined($index) ) {
 146         delete $seen[$index];
 147         my @temp = @seen;
 148         @seen = ();
 149         foreach my $element (@temp) {
 150             next unless $element;
 151             push @seen, $element;
 152         }
 153     }
 154 }
 155 elsif ( $AddCol ) {
 156     if ( defined $SelectDisplayColumns ) {
 157         my $selected = $SelectDisplayColumns;
 158         my @columns;
 159         if (ref($selected) eq 'ARRAY') {
 160             @columns = @$selected;
 161         } else {
 162             push @columns, $selected;
 163         }
 164         foreach my $col (@columns) {
 165             my %column = ();
 166             $column{Column} = $col;
 167
 168             if ( $Face eq "Bold" ) {
 169                 $column{Prefix} .= "<b>";
 170                 $column{Suffix} .= "</b>";
 171             }
 172             if ( $Face eq "Italic" ) {
 173                 $column{Prefix} .= "<i>";
 174                 $column{Suffix} .= "</i>";
 175             }
 176             if ($Size) {
 177                 $column{Prefix} .= "<" . $m->interp->apply_escapes( $Size,  'h' ) . ">";
 178                 $column{Suffix} .= "</" . $m->interp->apply_escapes( $Size, 'h' ) . ">";
 179             }
 180             if ( $Link eq "Display" ) {
 181                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Display.html?id=__id__">};
 182                 $column{Suffix} .= "</a>";
 183             }
 184             elsif ( $Link eq "Take" ) {
 185                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Display.html?Action=Take&id=__id__">};
 186                 $column{Suffix} .= "</a>";
 187             }
 188             elsif ( $Link eq "Respond" ) {
 189                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Update.html?Action=Respond&id=__id__">};
 190                 $column{Suffix} .= "</a>";
 191             }
 192             elsif ( $Link eq "Comment" ) {
 193                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Update.html?Action=Comment&id=__id__">};
 194                 $column{Suffix} .= "</a>";
 195             }
 196             elsif ( $Link eq "Resolve" ) {
 197                 $column{Prefix} .= q{<a HREF="__WebPath__/Ticket/Update.html?Action=Comment&DefaultStatus=resolved&id=__id__">};
 198                 $column{Suffix} .= "</a>";
 199             }
 200
 201             if ($Title) {
 202                 $column{Suffix} .= "/TITLE:" . $m->interp->apply_escapes( $Title, 'h' );
 203             }
 204             push @seen, \%column;
 205         }
 206     }
 207 }
 208 elsif ( $ColUp ) {
 209     my $index = $CurrentDisplayColumns;
 210     if ( defined $index && ( $index - 1 ) >= 0 ) {
 211         my $column = $seen[$index];
 212         $seen[$index]       = $seen[ $index - 1 ];
 213         $seen[ $index - 1 ] = $column;
 214         $CurrentDisplayColumns     = $index - 1;
 215     }
 216 }
 217 elsif ( $ColDown ) {
 218     my $index = $CurrentDisplayColumns;
 219     if ( defined $index && ( $index + 1 ) < scalar @seen ) {
 220         my $column = $seen[$index];
 221         $seen[$index]       = $seen[ $index + 1 ];
 222         $seen[ $index + 1 ] = $column;
 223         $CurrentDisplayColumns     = $index + 1;
 224     }
 225 }
 226
 227
 228 my @format_string;
 229 foreach my $field (@seen) {
 230     next unless $field;
 231     my $row = "";
 232     if ( $field->{'original_string'} ) {
 233         $row = $field->{'original_string'};
 234     }
 235     else {
 236         $row .= $field->{'Prefix'} if defined $field->{'Prefix'};
 237         $row .= "__$field->{'Column'}__"
 238           unless ( $field->{'Column'} eq "<blank>" );
 239         $row .= $field->{'Suffix'} if defined $field->{'Suffix'};
 240         $row =~ s!([\\'])!\\$1!g;
 241         $row = "'$row'";
 242     }
 243     push( @format_string, $row );
 244 }
 245
 246 $Format = join(",\n", @format_string);
 247
 248
 249 return($Format, \@fields, \@seen);
 250
 251 </%init>