Upgrade to 4.0.13
[usit-rt.git] / share / html / Elements / CollectionList
1 %# BEGIN BPS TAGGED BLOCK {{{
2 %#
3 %# COPYRIGHT:
4 %#
5 %# This software is Copyright (c) 1996-2013 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 <%INIT>
49 if (!$Collection && $Class eq 'RT::Tickets') {
50     $Collection = RT::Tickets->new( $session{'CurrentUser'} );
51     $Collection->FromSQL($Query);
52 }
53
54 $TotalFound = $Collection->CountAll() unless defined $TotalFound;
55 return '' if !$TotalFound && !$ShowEmpty;
56
57 if ( $Rows ) {
58     if ( $TotalFound <= $Rows ) {
59         $Page = 1;
60     }
61     else {
62         my $MaxPage = int( $TotalFound / $Rows ) + ( $TotalFound % $Rows ? 1 : 0 );
63         $Page = $MaxPage if $Page > $MaxPage;
64     }
65 }
66
67 # XXX: ->{'order_by'} is hacky, but there is no way to check if
68 # collection is ordered or not
69 if ( @OrderBy && ($AllowSorting || !$Collection->{'order_by'}) ) {
70     if ( $OrderBy[0] =~ /\|/ ) {
71         @OrderBy = grep length($_), split /\|/, $OrderBy[0];
72         @Order = split /\|/,$Order[0];
73     }
74     $Collection->OrderByCols(
75         map { { FIELD => $OrderBy[$_], ORDER => $Order[$_] } }
76         ( 0 .. $#OrderBy )
77     );
78 }
79
80 $Collection->RowsPerPage( $Rows ) if $Rows;
81 $Page = 1 unless $Page && $Page > 0;    # workaround problems with $Page = '' or undef
82 $Collection->GotoPage( $Page - 1 ); # SB uses page 0 as the first page
83
84 # DisplayFormat lets us use a "temporary" format for display, while 
85 # still using our original format for next/prev page links.
86 # bulk update uses this feature to add checkboxes
87
88 $DisplayFormat ||= $Format;
89
90 # Scrub the html of the format string to remove any potential nasties.
91 $Format = $m->comp('/Elements/ScrubHTML', Content => $Format);
92 $DisplayFormat = $m->comp('/Elements/ScrubHTML', Content => $DisplayFormat);
93
94 my @Format = $m->comp('/Elements/CollectionAsTable/ParseFormat', Format => $DisplayFormat);
95
96 # Find the maximum number of items in any row, so we can pad the table.
97 my ($maxitems, $item) = (0, 0);
98 foreach my $col (@Format) {
99     $item++;
100     if ( $col->{title} && ($col->{title} eq 'NEWLINE') ) {
101         $item = 0;
102     }
103     else {
104         $maxitems = $item if $item > $maxitems;
105     }
106 }
107
108 $Class ||= $Collection->ColumnMapClassName;
109 if ($Class =~ /::/) { # older passed in value
110     $Class =~ s/s$//;
111     $Class =~ s/:/_/g;
112 }
113
114 $m->out('<table cellspacing="0" class="' .
115         ($Collection->isa('RT::Tickets') ? 'ticket-list' : 'collection') . ' collection-as-table">');
116
117 if ( $ShowHeader ) {
118   $m->comp('/Elements/CollectionAsTable/Header',
119            %ARGS,
120            Class        => $Class,
121            Format       => \@Format,
122            FormatString => $Format,
123            Order        => \@Order,
124            OrderBy      => \@OrderBy,
125            Rows         => $Rows,
126            Page         => $Page,
127            AllowSorting => $AllowSorting, 
128            BaseURL      => $BaseURL,
129            GenericQueryArgs => $GenericQueryArgs,
130            maxitems     => $maxitems,
131            );
132 }
133
134 my ($i, $column_map) = (0, {});
135 while ( my $record = $Collection->Next ) {
136     # Every ten rows, flush the buffer and put something on the page.
137     $m->flush_buffer unless ++$i % 10;
138
139     my $warning = 0;
140     my $Classes = '';
141
142     $m->callback(
143         CallbackName => 'EachRow',
144         Record       => $record,
145         Warning      => \$warning,
146         Classes      => \$Classes,
147         Format       => \@Format,
148     );
149
150     $m->comp('/Elements/CollectionAsTable/Row',
151         i         => $i,
152         Format    => \@Format,
153         record    => $record,
154         maxitems  => $maxitems,
155         ColumnMap => $column_map,
156         Class     => $Class,
157         Warning   => $warning,
158         Classes   => $Classes,
159     );
160 }
161
162 $m->out('</table>');
163 if ( $Rows && $ShowNavigation && $TotalFound > $Rows ) {
164   my $oddRows = ($TotalFound && $TotalFound % $Rows == 0 )? 0 : 1;
165   my $pages = int( $TotalFound / $Rows ) + $oddRows;
166   $pages = 1 if $pages < 1;
167
168
169   my %query_args = map { $_ => $ARGS{$_} } @PassArguments;
170   $m->comp(
171         '/Elements/CollectionListPaging',
172         BaseURL     => $BaseURL,
173         Rows        => $Rows,
174         TotalFound  => $TotalFound,
175         CurrentPage => $Page,
176         Pages       => $pages,
177         URLParams   => \%query_args
178     );
179
180 }
181
182 </%INIT>
183 <%ARGS>
184 $Class         => ''
185 $Collection    => undef
186 $TotalFound    => undef
187 $Format        => undef
188 $DisplayFormat => undef
189 @Order         => ()
190 @OrderBy       => ()
191 $GenericQueryArgs => undef
192 $Rows          => undef
193 $Page          => 1
194 $Title         => loc('Ticket Search')
195 $BaseURL       => RT->Config->Get('WebPath') . $m->request_comp->path .'?'
196 @PassArguments => qw( Query Format Rows Page Order OrderBy)
197
198 $AllowSorting   => 0
199 $ShowNavigation => 1
200 $ShowHeader     => 1
201 $ShowEmpty      => 0
202 $Query => 0
203 </%ARGS>