rt/share/html/Search/Elements/BuildFormatString

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