%# BEGIN BPS TAGGED BLOCK {{{ %# %# COPYRIGHT: %# %# This software is Copyright (c) 1996-2024 Best Practical Solutions, LLC %# <sales@bestpractical.com> %# %# (Except where explicitly superseded by other copyright notices) %# %# %# LICENSE: %# %# This work is made available to you under the terms of Version 2 of %# the GNU General Public License. A copy of that license should have %# been provided with this software, but in any event can be snarfed %# from www.gnu.org. %# %# This work is distributed in the hope that it will be useful, but %# WITHOUT ANY WARRANTY; without even the implied warranty of %# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU %# General Public License for more details. %# %# You should have received a copy of the GNU General Public License %# along with this program; if not, write to the Free Software %# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA %# 02110-1301 or visit their web page on the internet at %# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html. %# %# %# CONTRIBUTION SUBMISSION POLICY: %# %# (The following paragraph is not intended to limit the rights granted %# to you to modify and distribute this software under the terms of %# the GNU General Public License and is only of importance to you if %# you choose to contribute your changes and enhancements to the %# community by submitting them to Best Practical Solutions, LLC.) %# %# By intentionally submitting any modifications, corrections or %# derivatives to this work, or any other work intended for use with %# Request Tracker, to Best Practical Solutions, LLC, you confirm that %# you are the copyright holder for those contributions and you grant %# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable, %# royalty-free, perpetual, license to use, copy, create derivative %# works based on those contributions, and sublicense and distribute %# those contributions and any derivatives thereof. %# %# END BPS TAGGED BLOCK }}} %# %# Data flow here: %# The page receives a Query from the previous page, and maybe arguments %# corresponding to actions. (If it doesn't get a Query argument, it pulls %# one out of the session hash. Also, it could be getting just a raw query from %# Build/Edit.html (Advanced).) %# %# After doing some stuff with default arguments and saved searches, the ParseQuery %# function (which is similar to, but not the same as, _parser in lib/RT/Tickets.pm) %# converts the Query into a RT::Interface::Web::QueryBuilder::Tree. This mason file %# then adds stuff to or modifies the tree based on the actions that had been requested %# by clicking buttons. It then calls GetQueryAndOptionList on the tree to generate %# the SQL query (which is saved as a hidden input) and the option list for the Clauses %# box in the top right corner. %# %# Worthwhile refactoring: the tree manipulation code for the actions could use some cleaning %# up. The node-adding code is different in the "add" actions from in ParseQuery, which leads %# to things like ParseQuery correctly not quoting numbers in numerical fields, while the "add" %# action does quote it (this breaks SQLite). %# <& /Elements/Header, Title => $title &> <& /Elements/Tabs, %TabArgs &> <& /Elements/ListActions &> % if ( $ResultPage ) { % } % if ( $query{ExtraQueryParams} ) { % for my $input ( ref $query{ExtraQueryParams} eq 'ARRAY' ? @{$query{ExtraQueryParams}} : $query{ExtraQueryParams} ) { % if ( defined $query{$input} ) { % } % } % }
<& Elements/PickCriteria, query => $query{'Query'}, queues => $queues, catalogs => $catalogs, %ARGS &>
<& /Elements/Submit, Label => loc('Add these terms'), SubmitId => 'AddClause', Name => 'AddClause'&> <& /Elements/Submit, Label => loc('Add these terms and Search'), SubmitId => 'DoSearch', Name => 'DoSearch'&>
<& Elements/EditQuery, %ARGS, actions => \@actions, optionlist => $optionlist, Description => $saved_search{'Description'}, &>
<& Elements/EditSearches, %ARGS, %saved_search, CurrentSearch => \%query, Title => loc('Saved searches') &>
<& Elements/DisplayOptions, %ARGS, %query, AvailableColumns => $AvailableColumns, CurrentFormat => $CurrentFormat, &>
<& /Elements/Submit, Label => loc('Update format and Search'), Name => 'DoSearch', id=>"formatbuttons"&>
<%INIT> use RT::Interface::Web::QueryBuilder; use RT::Interface::Web::QueryBuilder::Tree; $ARGS{SavedChartSearchId} ||= 'new'; my $title; my @cf_field_names; if ( $Class eq 'RT::Transactions' ) { $title = loc('Transaction Query Builder'); @cf_field_names = grep { $RT::Transactions::FIELD_METADATA{$_}->[0] eq 'CUSTOMFIELD' } sort keys %RT::Transactions::FIELD_METADATA; } elsif ( $Class eq 'RT::Assets' ) { $title = loc('Asset Query Builder'); @cf_field_names = grep { $RT::Assets::FIELD_METADATA{$_}->[0] eq 'CUSTOMFIELD' } sort keys %RT::Assets::FIELD_METADATA; } else { $title = loc("Query Builder"); @cf_field_names = grep { $RT::Tickets::FIELD_METADATA{$_}->[0] eq 'CUSTOMFIELD' } sort keys %RT::Tickets::FIELD_METADATA; } my %query; for( qw(Query Format OrderBy Order RowsPerPage Class ObjectType ExtraQueryParams), @ExtraQueryParams ) { $query{$_} = $ARGS{$_} if defined $ARGS{$_}; } my %saved_search; my @actions = $m->comp( 'Elements/EditSearches:Init', %ARGS, Query => \%query, SavedSearch => \%saved_search ); my $hash_name = join '-', 'CurrentSearchHash', $Class, $ObjectType || (); my $session_name = join '-', 'collection', $Class, $ObjectType || (); if ( $NewQuery ) { # Wipe all data-carrying variables clear if we want a new # search, or we're deleting an old one.. %query = map { $_ => $ARGS{$_} } grep { defined $ARGS{$_} } 'ExtraQueryParams', @ExtraQueryParams; %saved_search = ( Id => 'new' ); # ..then wipe the session out.. delete $session{$hash_name}; # ..and the search results. $session{$session_name}->CleanSlate if defined $session{$session_name}; } { # Attempt to load what we can from the session and preferences, set defaults my $current = $session{$hash_name}; my $prefs; if ( $Class eq 'RT::Tickets' ) { # User-level search preferences currently apply only to tickets $prefs = $session{'CurrentUser'}->UserObj->Preferences("SearchDisplay") || {}; } my %orderby = ( 'RT::Tickets' => RT->Config->Get('DefaultSearchResultOrderBy'), 'RT::Transactions' => RT->Config->Get('TransactionDefaultSearchResultOrderBy')->{$ObjectType}, 'RT::Assets' => RT->Config->Get('AssetDefaultSearchResultOrderBy'), ); my %order = ( 'RT::Tickets' => RT->Config->Get('DefaultSearchResultOrder'), 'RT::Transactions' => RT->Config->Get('TransactionDefaultSearchResultOrder')->{$ObjectType}, 'RT::Assets' => RT->Config->Get('AssetDefaultSearchResultOrder'), ); my $default = { Query => '', Format => '', OrderBy => $orderby{$Class}, Order => $order{$Class}, ObjectType => $ObjectType, RowsPerPage => RT->Config->Get('DefaultSearchResultRowsPerPage') // 50 }; for( qw(Query Format OrderBy Order RowsPerPage ObjectType) ) { $query{$_} = $current->{$_} unless defined $query{$_}; if ( $prefs ) { $query{$_} = $prefs->{$_} unless defined $query{$_}; } $query{$_} = $default->{$_} unless defined $query{$_}; } for( qw(Order OrderBy) ) { if (ref $query{$_} eq "ARRAY") { $query{$_} = join( '|', @{ $query{$_} } ); } } if ( $query{'Format'} ) { # Clean unwanted junk from the format $query{'Format'} = $m->comp( '/Elements/ScrubHTML', Content => $query{'Format'}, Restrictive => 1 ); } if ( !$ARGS{SavedSearchLoad} and ( my $extra_params = $current->{ExtraQueryParams} ) ) { $query{ExtraQueryParams} //= $extra_params; for my $param ( ref $extra_params eq 'ARRAY' ? @$extra_params : $extra_params ) { $query{$param} //= $current->{$param}; } } } my $ParseQuery = sub { my ($string, $results) = @_; my $tree = RT::Interface::Web::QueryBuilder::Tree->new('AND'); @$results = $tree->ParseSQL( Query => $string, CurrentUser => $session{'CurrentUser'}, Class => $Class ); return $tree; }; my @parse_results; my $tree = $ParseQuery->( $query{'Query'}, \@parse_results ); # if parsing went poorly, send them to the edit page to fix it if ( @parse_results ) { push @actions, @parse_results; return $m->comp( "Edit.html", Query => $query{'Query'}, Format => $query{'Format'}, SavedSearchId => $saved_search{'Id'}, SavedChartSearchId => $ARGS{'SavedChartSearchId'}, actions => \@actions, Class => $Class, ObjectType => $ObjectType, ); } my @options = $tree->GetDisplayedNodes; my @current_values = grep defined, @options[@clauses]; my @new_values = (); my $cf_field_names = join "|", map quotemeta, @cf_field_names; # Try to find if we're adding a clause foreach my $arg ( keys %ARGS ) { next unless $arg =~ m/^ValueOf(\w+|($cf_field_names).\{.*?\}|CustomRole.\{.*?\})$/ && ( ref $ARGS{$arg} eq "ARRAY" ? grep $_ ne '', @{ $ARGS{$arg} } : $ARGS{$arg} ne '' ); # We're adding a $1 clause my $field = $1; my ($op, $value); #figure out if it's a grouping my $keyword = $ARGS{ $field . "Field" } || $field; $keyword .= '.' . $ARGS{ $field . "FieldSubType" } if $ARGS{ $field . "FieldSubType" }; my ( @ops, @values ); if ( ref $ARGS{ 'ValueOf' . $field } eq "ARRAY" ) { # we have many keys/values to iterate over, because there is # more than one CF with the same name. @ops = @{ $ARGS{ $field . 'Op' } }; @values = @{ $ARGS{ 'ValueOf' . $field } }; } else { @ops = ( $ARGS{ $field . 'Op' } ); @values = ( $ARGS{ 'ValueOf' . $field } ); } $RT::Logger->error("Bad Parameters passed into Query Builder") unless @ops == @values; for ( my $i = 0; $i < @ops; $i++ ) { my ( $op, $value ) = ( $ops[$i], $values[$i] ); next if !defined $value || $value eq ''; my $clause = { Key => $keyword, Op => $op, Value => $value, QuoteValue => $value =~ /^[+-]?[0-9]+$/ ? 0 : 1, }; push @new_values, RT::Interface::Web::QueryBuilder::Tree->new($clause); } } push @actions, $m->comp('Elements/EditQuery:Process', %ARGS, Tree => $tree, Selected => \@current_values, New => \@new_values, ); # Rebuild $Query based on the additions / movements my $optionlist_arrayref; ($query{'Query'}, $optionlist_arrayref) = $tree->GetQueryAndOptionList(\@current_values); my $optionlist = join "\n", map { qq({SELECTED}>) . (" " x (5 * $_->{DEPTH})) . $m->interp->apply_escapes($_->{TEXT}, 'h') . qq() } @$optionlist_arrayref; my $queues = $Class ne 'RT::Assets' ? $tree->GetReferencedQueues : {}; my $catalogs = $Class eq 'RT::Assets' ? $tree->GetReferencedCatalogs : {}; # Deal with format changes my ( $AvailableColumns, $CurrentFormat ); ( $query{'Format'}, $AvailableColumns, $CurrentFormat ) = $m->comp( 'Elements/BuildFormatString', %ARGS, queues => $queues, catalogs => $catalogs, Format => $query{'Format'}, ); # if we're asked to save the current search, save it push @actions, $m->comp( 'Elements/EditSearches:Save', %ARGS, Query => \%query, SavedSearch => \%saved_search); # Populate the "query" context with saved search data if ($ARGS{SavedSearchSave}) { $query{'SavedSearchId'} = $saved_search{'Id'}; } # Push the updates into the session so we don't lose 'em $session{$hash_name} = { %query, SearchId => $saved_search{'Id'}, Object => $saved_search{'Object'}, Description => $saved_search{'Description'}, }; # Show the results, if we were asked. if ( $ARGS{'DoSearch'} ) { my $redir_query_string = QueryString( ShortenSearchQuery( %query, SavedChartSearchId => $ARGS{'SavedChartSearchId'}, SavedSearchId => $saved_search{'Id'}, ) ); RT::Interface::Web::Redirect("$ResultPage?$redir_query_string"); $m->abort; } # Build a querystring for the tabs my %TabArgs = (); if ($NewQuery) { $TabArgs{QueryString} = $m->comp( '/Elements/QueryString', NewQuery => 1, $Class ne 'RT::Tickets' ? ( Class => $Class, ObjectType => $ObjectType ) : () ); } elsif ( $query{'Query'} ) { $TabArgs{QueryArgs} = \%query; } $m->callback( ARGSRef => \%ARGS, Query => \%query, CallbackName => 'BeforeDisplay' ); <%ARGS> $NewQuery => 0 @clauses => () $Class => 'RT::Tickets' $ObjectType => $Class eq 'RT::Transactions' ? 'RT::Ticket' : '' @ExtraQueryParams => () $ResultPage => RT->Config->Get('WebPath') . '/Search/Results.html'