rt/share/html/Search/Elements/BuildFormatString

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