rt/share/html/Search/Elements/BuildFormatString

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