Upgrade to 4.2.2
[usit-rt.git] / share / html / Search / Build.html
CommitLineData
84fb5b46
MKG
1%# BEGIN BPS TAGGED BLOCK {{{
2%#
3%# COPYRIGHT:
4%#
320f0092 5%# This software is Copyright (c) 1996-2014 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%#
49%# Data flow here:
50%# The page receives a Query from the previous page, and maybe arguments
51%# corresponding to actions. (If it doesn't get a Query argument, it pulls
52%# one out of the session hash. Also, it could be getting just a raw query from
53%# Build/Edit.html (Advanced).)
54%#
55%# After doing some stuff with default arguments and saved searches, the ParseQuery
af59614d 56%# function (which is similar to, but not the same as, _parser in lib/RT/Tickets.pm)
84fb5b46
MKG
57%# converts the Query into a RT::Interface::Web::QueryBuilder::Tree. This mason file
58%# then adds stuff to or modifies the tree based on the actions that had been requested
59%# by clicking buttons. It then calls GetQueryAndOptionList on the tree to generate
60%# the SQL query (which is saved as a hidden input) and the option list for the Clauses
61%# box in the top right corner.
62%#
63%# Worthwhile refactoring: the tree manipulation code for the actions could use some cleaning
64%# up. The node-adding code is different in the "add" actions from in ParseQuery, which leads
65%# to things like ParseQuery correctly not quoting numbers in numerical fields, while the "add"
66%# action does quote it (this breaks SQLite).
67%#
68<& /Elements/Header, Title => $title &>
69<& /Elements/Tabs, %TabArgs &>
70
71<form method="post" action="Build.html" name="BuildQuery" id="BuildQuery">
72<input type="hidden" class="hidden" name="SavedSearchId" value="<% $saved_search{'Id'} %>" />
73<input type="hidden" class="hidden" name="SavedChartSearchId" value="<% $ARGS{'SavedChartSearchId'} %>" />
74<input type="hidden" class="hidden" name="Query" value="<% $query{'Query'} %>" />
75<input type="hidden" class="hidden" name="Format" value="<% $query{'Format'} %>" />
76
77
78
79
80<div id="pick-criteria">
b5747ff2 81 <& Elements/PickCriteria, query => $query{'Query'}, queues => $queues &>
84fb5b46
MKG
82</div>
83<& /Elements/Submit, Label => loc('Add these terms'), SubmitId => 'AddClause', Name => 'AddClause'&>
84<& /Elements/Submit, Label => loc('Add these terms and Search'), SubmitId => 'DoSearch', Name => 'DoSearch'&>
85
86
87<div id="editquery">
88<& Elements/EditQuery,
89 %ARGS,
90 actions => \@actions,
91 optionlist => $optionlist,
92 Description => $saved_search{'Description'},
93 &>
94</div>
95<div id="editsearches">
96 <& Elements/EditSearches, %saved_search, CurrentSearch => \%query &>
97</div>
98
99<span id="display-options">
100<& Elements/DisplayOptions,
101 %ARGS, %query,
102 AvailableColumns => $AvailableColumns,
103 CurrentFormat => $CurrentFormat,
104&>
105</span>
106<& /Elements/Submit, Label => loc('Update format and Search'), Name => 'DoSearch', id=>"formatbuttons"&>
107</form>
108
109<%INIT>
110use RT::Interface::Web::QueryBuilder;
111use RT::Interface::Web::QueryBuilder::Tree;
112
113$ARGS{SavedChartSearchId} ||= 'new';
114
115my $title = loc("Query Builder");
116
117my %query;
118for( qw(Query Format OrderBy Order RowsPerPage) ) {
119 $query{$_} = $ARGS{$_};
120}
121
122my %saved_search;
123my @actions = $m->comp( 'Elements/EditSearches:Init', %ARGS, Query => \%query, SavedSearch => \%saved_search);
124
125if ( $NewQuery ) {
126
127 # Wipe all data-carrying variables clear if we want a new
128 # search, or we're deleting an old one..
129 %query = ();
130 %saved_search = ( Id => 'new' );
131
132 # ..then wipe the session out..
133 delete $session{'CurrentSearchHash'};
134
135 # ..and the search results.
136 $session{'tickets'}->CleanSlate if defined $session{'tickets'};
137}
138
139{ # Attempt to load what we can from the session and preferences, set defaults
140
141 my $current = $session{'CurrentSearchHash'};
142 my $prefs = $session{'CurrentUser'}->UserObj->Preferences("SearchDisplay") || {};
143 my $default = { Query => '', Format => '', OrderBy => 'id', Order => 'ASC', RowsPerPage => 50 };
144
145 for( qw(Query Format OrderBy Order RowsPerPage) ) {
146 $query{$_} = $current->{$_} unless defined $query{$_};
147 $query{$_} = $prefs->{$_} unless defined $query{$_};
148 $query{$_} = $default->{$_} unless defined $query{$_};
149 }
150
151 for( qw(Order OrderBy) ) {
152 if (ref $query{$_} eq "ARRAY") {
153 $query{$_} = join( '|', @{ $query{$_} } );
154 }
155 }
156 if ( $query{'Format'} ) {
157 # Clean unwanted junk from the format
158 $query{'Format'} = $m->comp( '/Elements/ScrubHTML', Content => $query{'Format'} );
159 }
160}
161
162my $ParseQuery = sub {
163 my ($string, $results) = @_;
164
165 my $tree = RT::Interface::Web::QueryBuilder::Tree->new('AND');
166 @$results = $tree->ParseSQL( Query => $string, CurrentUser => $session{'CurrentUser'} );
167
168 return $tree;
169};
170
171my @parse_results;
172my $tree = $ParseQuery->( $query{'Query'}, \@parse_results );
173
174# if parsing went poorly, send them to the edit page to fix it
175if ( @parse_results ) {
176 push @actions, @parse_results;
177 return $m->comp(
178 "Edit.html",
179 Query => $query{'Query'},
180 Format => $query{'Format'},
181 SavedSearchId => $saved_search{'Id'},
182 SavedChartSearchId => $ARGS{'SavedChartSearchId'},
183 actions => \@actions,
184 );
185}
186
187my @options = $tree->GetDisplayedNodes;
188my @current_values = grep defined, @options[@clauses];
189my @new_values = ();
190
af59614d
MKG
191my $cf_field_names =
192 join "|",
193 map quotemeta,
194 grep { $RT::Tickets::FIELD_METADATA{$_}->[0] eq 'CUSTOMFIELD' }
195 sort keys %RT::Tickets::FIELD_METADATA;
196
84fb5b46
MKG
197# Try to find if we're adding a clause
198foreach my $arg ( keys %ARGS ) {
af59614d 199 next unless $arg =~ m/^ValueOf(\w+|($cf_field_names).\{.*?\})$/
84fb5b46
MKG
200 && ( ref $ARGS{$arg} eq "ARRAY"
201 ? grep $_ ne '', @{ $ARGS{$arg} }
202 : $ARGS{$arg} ne '' );
203
204 # We're adding a $1 clause
205 my $field = $1;
206
207 my ($op, $value);
208
209 #figure out if it's a grouping
210 my $keyword = $ARGS{ $field . "Field" } || $field;
211
212 my ( @ops, @values );
213 if ( ref $ARGS{ 'ValueOf' . $field } eq "ARRAY" ) {
214 # we have many keys/values to iterate over, because there is
215 # more than one CF with the same name.
216 @ops = @{ $ARGS{ $field . 'Op' } };
217 @values = @{ $ARGS{ 'ValueOf' . $field } };
218 }
219 else {
220 @ops = ( $ARGS{ $field . 'Op' } );
221 @values = ( $ARGS{ 'ValueOf' . $field } );
222 }
223 $RT::Logger->error("Bad Parameters passed into Query Builder")
224 unless @ops == @values;
225
226 for ( my $i = 0; $i < @ops; $i++ ) {
227 my ( $op, $value ) = ( $ops[$i], $values[$i] );
228 next if !defined $value || $value eq '';
af59614d 229 my $rawvalue = $value;
84fb5b46 230
403d7b0b 231 if ( $value =~ /^NULL$/i && $op =~ /=/ ) {
84fb5b46
MKG
232 if ( $op eq '=' ) {
233 $op = "IS";
234 }
235 elsif ( $op eq '!=' ) {
236 $op = "IS NOT";
237 }
238 }
239 elsif ($value =~ /\D/) {
240 $value =~ s/(['\\])/\\$1/g;
241 $value = "'$value'";
242 }
243
320f0092 244 if ($keyword =~ s/(['\\])/\\$1/g or $keyword =~ /[^{}\w\.]/) {
af59614d 245 $keyword = "'$keyword'";
84fb5b46
MKG
246 }
247
248 my $clause = {
249 Key => $keyword,
250 Op => $op,
af59614d
MKG
251 Value => $value,
252 RawValue => $rawvalue,
84fb5b46
MKG
253 };
254
255 push @new_values, RT::Interface::Web::QueryBuilder::Tree->new($clause);
256 }
257}
258
259
260push @actions, $m->comp('Elements/EditQuery:Process',
261 %ARGS,
262 Tree => $tree,
263 Selected => \@current_values,
264 New => \@new_values,
265);
266
267# Rebuild $Query based on the additions / movements
268
269my $optionlist_arrayref;
270($query{'Query'}, $optionlist_arrayref) = $tree->GetQueryAndOptionList(\@current_values);
271
272my $optionlist = join "\n", map { qq(<option value="$_->{INDEX}" $_->{SELECTED}>)
273 . ("&nbsp;" x (5 * $_->{DEPTH}))
274 . $m->interp->apply_escapes($_->{TEXT}, 'h') . qq(</option>) } @$optionlist_arrayref;
275
276
277my $queues = $tree->GetReferencedQueues;
278
279# Deal with format changes
280my ( $AvailableColumns, $CurrentFormat );
281( $query{'Format'}, $AvailableColumns, $CurrentFormat ) = $m->comp(
282 'Elements/BuildFormatString',
283 %ARGS,
b5747ff2 284 queues => $queues,
84fb5b46
MKG
285 Format => $query{'Format'},
286);
287
288
289# if we're asked to save the current search, save it
290push @actions, $m->comp( 'Elements/EditSearches:Save', %ARGS, Query => \%query, SavedSearch => \%saved_search);
291
292# Populate the "query" context with saved search data
293
294if ($ARGS{SavedSearchSave}) {
295 $query{'SavedSearchId'} = $saved_search{'Id'};
296}
297
298# Push the updates into the session so we don't lose 'em
299
300$session{'CurrentSearchHash'} = {
301 %query,
302 SearchId => $saved_search{'Id'},
303 Object => $saved_search{'Object'},
304 Description => $saved_search{'Description'},
305};
306
307
308# Show the results, if we were asked.
309
310if ( $ARGS{'DoSearch'} ) {
311 my $redir_query_string = $m->comp(
312 '/Elements/QueryString',
313 %query,
314 SavedChartSearchId => $ARGS{'SavedChartSearchId'},
315 SavedSearchId => $saved_search{'Id'},
316 );
b5747ff2 317 RT::Interface::Web::Redirect(RT->Config->Get('WebURL') . 'Search/Results.html?' . $redir_query_string);
84fb5b46
MKG
318 $m->abort;
319}
320
321
322# Build a querystring for the tabs
323
324my %TabArgs = ();
325if ($NewQuery) {
326 $TabArgs{QueryString} = 'NewQuery=1';
327}
328elsif ( $query{'Query'} ) {
329 $TabArgs{QueryArgs} = \%query;
330}
331
332</%INIT>
333
334<%ARGS>
335$NewQuery => 0
336@clauses => ()
337</%ARGS>