rt/share/html/Search/Elements/BuildFormatString

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