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