rt/share/html/Search/Results.html

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2017 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 <& /Elements/Header, Title => $title,
  49     Refresh => $refresh,
  50     LinkRel => \%link_rel &>
  51 <& /Elements/Tabs &>
  52
  53 % my $DisplayFormat;
  54 % $m->callback( ARGSRef => \%ARGS, Format => \$Format, DisplayFormat => \$DisplayFormat, CallbackName => 'BeforeResults' );
  55
  56 % unless ($ok) {
  57 %    $msg =~ s{ at .*? line .*}{}s;
  58 <&| /Widgets/TitleBox, title => loc("Error"), class => "error-titlebox" &>
  59 <&|/l_unsafe, "<i>".$m->interp->apply_escapes($msg, "h")."</i>" &>There was an error parsing your search query: [_1].  Your RT admin can find more information in the error logs.</&>
  60 </&>
  61 % } else {
  62
  63 <& /Elements/CollectionList,
  64     Query => $Query,
  65     TotalFound => $ticketcount,
  66     AllowSorting => 1,
  67     OrderBy => $OrderBy,
  68     Order => $Order,
  69     Rows => $Rows,
  70     Page => $Page,
  71     Format => $Format,
  72     DisplayFormat => $DisplayFormat, # in case we set it in callbacks
  73     Class => 'RT::Tickets',
  74     BaseURL => $BaseURL,
  75     SavedSearchId => $ARGS{'SavedSearchId'},
  76     SavedChartSearchId => $ARGS{'SavedChartSearchId'},
  77     PassArguments => [qw(Query Format Rows Page Order OrderBy SavedSearchId SavedChartSearchId)],
  78 &>
  79 % }
  80 % $m->callback( ARGSRef => \%ARGS, CallbackName => 'AfterResults' );
  81
  82 % my %hiddens = (Query => $Query, Format => $Format, Rows => $Rows, OrderBy => $OrderBy, Order => $Order, HideResults => $HideResults, Page => $Page, SavedChartSearchId => $SavedChartSearchId );
  83 <div align="right" class="refresh">
  84 <form method="get" action="<%RT->Config->Get('WebPath')%>/Search/Results.html">
  85 % foreach my $key (keys(%hiddens)) {
  86 <input type="hidden" class="hidden" name="<%$key%>" value="<% defined($hiddens{$key})?$hiddens{$key}:'' %>" />
  87 % }
  88 <& /Elements/Refresh, Name => 'TicketsRefreshInterval', Default => $session{'tickets_refresh_interval'}||RT->Config->Get('SearchResultsRefreshInterval', $session{'CurrentUser'}) &>
  89 <input type="submit" class="button" value="<&|/l&>Change</&>" />
  90 </form>
  91 </div>
  92 <%INIT>
  93 $m->callback( ARGSRef => \%ARGS, CallbackName => 'Initial' );
  94
  95 # Read from user preferences
  96 my $prefs = $session{'CurrentUser'}->UserObj->Preferences("SearchDisplay") || {};
  97
  98 # These variables are what define a search_hash; this is also
  99 # where we give sane defaults.
 100 $Format      ||= $prefs->{'Format'} || RT->Config->Get('DefaultSearchResultFormat');
 101 $Order       ||= $prefs->{'Order'} || RT->Config->Get('DefaultSearchResultOrder');
 102 $OrderBy     ||= $prefs->{'OrderBy'} || RT->Config->Get('DefaultSearchResultOrderBy');
 103
 104 # Some forms pass in "RowsPerPage" rather than "Rows"
 105 # We call it RowsPerPage everywhere else.
 106
 107 if ( !defined($Rows) ) {
 108     if (defined $ARGS{'RowsPerPage'} ) {
 109         $Rows = $ARGS{'RowsPerPage'};
 110     } elsif ( defined $prefs->{'RowsPerPage'} ) {
 111         $Rows = $prefs->{'RowsPerPage'};
 112     } else {
 113         $Rows = 50;
 114     }
 115 }
 116 $Page = 1 unless $Page && $Page > 0;
 117
 118 $session{'i'}++;
 119 $session{'tickets'} = RT::Tickets->new($session{'CurrentUser'}) ;
 120 my ($ok, $msg) = $Query ? $session{'tickets'}->FromSQL($Query) : (1, "Vacuously OK");
 121 # Provide an empty search if parsing failed
 122 $session{'tickets'}->FromSQL("id < 0") unless ($ok);
 123
 124 if ($OrderBy =~ /\|/) {
 125     # Multiple Sorts
 126     my @OrderBy = split /\|/,$OrderBy;
 127     my @Order = split /\|/,$Order;
 128     $session{'tickets'}->OrderByCols(
 129         map { { FIELD => $OrderBy[$_], ORDER => $Order[$_] } } ( 0
 130         .. $#OrderBy ) );;
 131 } else {
 132     $session{'tickets'}->OrderBy(FIELD => $OrderBy, ORDER => $Order);
 133 }
 134 $session{'tickets'}->RowsPerPage( $Rows ) if $Rows;
 135 $session{'tickets'}->GotoPage( $Page - 1 );
 136
 137 $session{'CurrentSearchHash'} = {
 138     Format      => $Format,
 139     Query       => $Query,
 140     Page       => $Page,
 141     Order       => $Order,
 142     OrderBy     => $OrderBy,
 143     RowsPerPage => $Rows
 144 };
 145
 146
 147 my ($title, $ticketcount) = (loc("Find tickets"), 0);
 148 if ( $session{'tickets'}->Query()) {
 149     $ticketcount = $session{tickets}->CountAll();
 150     $title = loc('Found [quant,_1,ticket,tickets]', $ticketcount);
 151 }
 152
 153 my $QueryString = "?".$m->comp('/Elements/QueryString',
 154                                Query => $Query,
 155                                Format => $Format,
 156                                Rows => $Rows,
 157                                OrderBy => $OrderBy,
 158                                Order => $Order,
 159                                Page => $Page);
 160 my $ShortQueryString = "?".$m->comp('/Elements/QueryString', Query => $Query);
 161
 162 if ($ARGS{'TicketsRefreshInterval'}) {
 163     $session{'tickets_refresh_interval'} = $ARGS{'TicketsRefreshInterval'};
 164 }
 165
 166 my $refresh = $session{'tickets_refresh_interval'}
 167     || RT->Config->Get('SearchResultsRefreshInterval', $session{'CurrentUser'} );
 168
 169 # Check $m->request_args, not $DECODED_ARGS, to avoid creating a new CSRF token on each refresh
 170 if (RT->Config->Get('RestrictReferrer') and $refresh and not $m->request_args->{CSRF_Token}) {
 171     my $token = RT::Interface::Web::StoreRequestToken( $session{'CurrentSearchHash'} );
 172     $m->notes->{RefreshURL} = RT->Config->Get('WebURL')
 173         . "Search/Results.html?CSRF_Token="
 174             . $token;
 175 }
 176
 177 my %link_rel;
 178 my $genpage = sub {
 179     return $m->comp(
 180         '/Elements/QueryString',
 181         Query   => $Query,
 182         Format  => $Format,
 183         Rows    => $Rows,
 184         OrderBy => $OrderBy,
 185         Order   => $Order,
 186         Page    => shift(@_),
 187     );
 188 };
 189
 190 if ( RT->Config->Get('SearchResultsAutoRedirect') && $ticketcount == 1 &&
 191     $session{tickets}->First ) {
 192 # $ticketcount is not always precise unless $UseSQLForACLChecks is set to true,
 193 # check $session{tickets}->First here is to make sure the ticket is there.
 194     RT::Interface::Web::Redirect( RT->Config->Get('WebURL')
 195             ."Ticket/Display.html?id=". $session{tickets}->First->id );
 196 }
 197
 198 my $BaseURL = RT->Config->Get('WebPath')."/Search/Results.html?";
 199 $link_rel{first} = $BaseURL . $genpage->(1)         if $Page > 1;
 200 $link_rel{prev}  = $BaseURL . $genpage->($Page - 1) if $Page > 1;
 201 $link_rel{next}  = $BaseURL . $genpage->($Page + 1) if ($Page * $Rows) < $ticketcount;
 202 $link_rel{last}  = $BaseURL . $genpage->(POSIX::ceil($ticketcount/$Rows)) if $Rows and ($Page * $Rows) < $ticketcount;
 203 </%INIT>
 204 <%CLEANUP>
 205 $session{'tickets'}->PrepForSerialization();
 206 </%CLEANUP>
 207 <%ARGS>
 208 $Query => undef
 209 $Format => undef
 210 $HideResults => 0
 211 $Rows => undef
 212 $Page => 1
 213 $OrderBy => undef
 214 $Order => undef
 215 $SavedSearchId => undef
 216 $SavedChartSearchId => undef
 217 </%ARGS>