Upgrade to 4.2.8
[usit-rt.git] / share / html / Elements / ShowSearch
1 %# BEGIN BPS TAGGED BLOCK {{{
2 %#
3 %# COPYRIGHT:
4 %#
5 %# This software is Copyright (c) 1996-2014 Best Practical Solutions, LLC
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 <&|/Widgets/TitleBox,
49     title => loc(RT::SavedSearch->EscapeDescription($search->Description), $ProcessedSearchArg->{'Rows'}),
50     title_href => $query_link_url.$QueryString,
51     titleright => $customize ? loc('Edit') : '',
52     titleright_href => $customize,
53     hideable => $hideable &>
54 <& $query_display_component, hideable => $hideable, %$ProcessedSearchArg, ShowNavigation => 0, Class => 'RT::Tickets' &>
55 </&>
56 <%init>
57 my $search;
58 my $user = $session{'CurrentUser'}->UserObj;
59 my $SearchArg;
60 my $customize;
61 my $query_display_component = '/Elements/CollectionList';
62 my $query_link_url = RT->Config->Get('WebPath').'/Search/Results.html';
63
64 if ($SavedSearch) {
65     my ( $container_object, $search_id ) = _parse_saved_search($SavedSearch);
66     unless ( $container_object ) {
67         $m->out(loc("Either you have no rights to view saved search [_1] or identifier is incorrect", $m->interp->apply_escapes($SavedSearch, 'h')));
68         return;
69     }
70     $search = RT::Attribute->new( $session{'CurrentUser'} );
71     $search->Load($search_id);
72     unless ( $search->Id && ref( $SearchArg = $search->Content ) eq 'HASH' ) {
73         $m->out(loc("Saved search [_1] not found", $m->interp->apply_escapes($SavedSearch, 'h'))) unless $IgnoreMissing;
74         return;
75     }
76     $SearchArg->{'SavedSearchId'} ||= $SavedSearch;
77     $SearchArg->{'SearchType'} ||= 'Ticket';
78     if ( $SearchArg->{SearchType} ne 'Ticket' ) {
79
80         # XXX: dispatch to different handler here
81         $query_display_component
82             = '/Search/Elements/' . $SearchArg->{SearchType};
83         $query_link_url = RT->Config->Get('WebPath') . "/Search/$SearchArg->{SearchType}.html";
84     } elsif ($ShowCustomize) {
85         $customize = RT->Config->Get('WebPath') . '/Search/Build.html?'
86             . $m->comp( '/Elements/QueryString',
87             SavedSearchLoad => $SavedSearch );
88     }
89 } else {
90     ($search) = RT::System->new( $session{'CurrentUser'} ) ->Attributes->Named( 'Search - ' . $Name );
91     unless ( $search && $search->Id ) {
92         my (@custom_searches) = RT::System->new( $session{'CurrentUser'} )->Attributes->Named('SavedSearch');
93         foreach my $custom (@custom_searches) {
94             if ($custom->Description eq $Name) { $search = $custom; last }
95         }
96         unless ($search && $search->id) {
97             $m->out(loc("Predefined search [_1] not found", $m->interp->apply_escapes($Name, 'h')));
98             return;
99         }
100     }
101
102     $SearchArg = $user->Preferences( $search, $search->Content );
103     if ($ShowCustomize) {
104         $customize = RT->Config->Get('WebPath') . '/Prefs/Search.html?'
105             . $m->comp( '/Elements/QueryString',
106                 name => ref($search) . '-' . $search->Id );
107     }
108 }
109
110 # ProcessedSearchArg is a search with overridings, but for link we use
111 # orginal search's poperties
112 my $ProcessedSearchArg = $SearchArg;
113 $ProcessedSearchArg = { %$SearchArg, %Override } if keys %Override;
114
115 $m->callback(
116     %ARGS,
117     CallbackName  => 'ModifySearch',
118     OriginalSearch => $SearchArg,
119     Search         => $ProcessedSearchArg,
120 );
121
122 foreach ( $SearchArg, $ProcessedSearchArg ) {
123     $_->{'Format'} ||= '';
124     $_->{'Query'} ||= '';
125
126     # extract-message-catalog would "$1", so we avoid quotes for loc calls
127     $_->{'Format'} =~ s/__loc\(["']?(\w+)["']?\)__/my $f = "$1"; loc($f)/ge;
128     if ( $_->{'Query'} =~ /__Bookmarks__/ ) {
129         $_->{'Rows'} = 999;
130
131         # DEPRECATED: will be here for a while up to 4.4
132         RT->Deprecated(
133             Remove  => "4.4",
134             Instead => "id = '__Bookmarked__'",
135             Message => "The __Bookmarks__ query syntax is deprecated",
136             Object  => $search,
137         );
138
139         my @bookmarks = $session{'CurrentUser'}->UserObj->Bookmarks;
140         my $query = join(" OR ", map " id = '$_' ", @bookmarks ) || 'id=0';
141         $_->{'Query'} =~ s/__Bookmarks__/( $query )/g;
142     }
143 }
144
145 my $QueryString = '?' . $m->comp( '/Elements/QueryString', %$SearchArg );
146 </%init>
147 <%ARGS>
148 $Name           => undef
149 $SavedSearch    => undef
150 %Override       => ()
151 $IgnoreMissing  => undef
152 $hideable       => 1
153 $ShowCustomize => 1
154 </%ARGS>