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