Upgrade to 4.2.8
[usit-rt.git] / lib / RT / Shredder / Plugin / Base / Search.pm
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
49 package RT::Shredder::Plugin::Base::Search;
50
51 use strict;
52 use warnings FATAL => 'all';
53
54 use base qw(RT::Shredder::Plugin::Base);
55
56 =head1 NAME
57
58 RT::Shredder::Plugin::Base - base class for Shredder plugins.
59
60 =cut
61
62 sub Type { return 'search' }
63
64 =head1 ARGUMENTS
65
66 Arguments which all plugins support.
67
68 =head2 limit - unsigned integer
69
70 Allow you to limit search results. B<< Default value is C<10> >>.
71
72 =head1 METHODS
73
74 =cut
75
76 sub SupportArgs
77 {
78     my %seen;
79     my @args = sort
80         grep $_ && !$seen{$_},
81             shift->SUPER::SupportArgs(@_),
82             qw(limit);
83     return @args;
84 }
85
86 sub TestArgs
87 {
88     my $self = shift;
89     my %args = @_;
90     if( defined $args{'limit'} && $args{'limit'} ne '' ) {
91         my $limit = $args{'limit'};
92         $limit =~ s/[^0-9]//g;
93         unless( $args{'limit'} eq $limit ) {
94             return( 0, "'limit' should be an unsigned integer");
95         }
96         $args{'limit'} = $limit;
97     } else {
98         $args{'limit'} = 10;
99     }
100     return $self->SUPER::TestArgs( %args );
101 }
102
103 sub SetResolvers { return 1 }
104
105
106 =head2 FetchNext $collection [, $init]
107
108 Returns next object in collection as method L<RT::SearchBuilder/Next>, but
109 doesn't stop on page boundaries.
110
111 When method is called with true C<$init> arg it enables pages on collection
112 and selects first page.
113
114 Main purpose of this method is to avoid loading of whole collection into
115 memory as RT does by default when pager is not used. This method init paging
116 on the collection, but doesn't stop when reach page end.
117
118 Example:
119
120     $plugin->FetchNext( $tickets, 'init' );
121     while( my $ticket = $plugin->FetchNext( $tickets ) ) {
122         ...
123     }
124
125 =cut
126
127 use constant PAGE_SIZE => 100;
128 sub FetchNext {
129     my ($self, $objs, $init) = @_;
130     if ( $init ) {
131         $objs->RowsPerPage( PAGE_SIZE );
132         $objs->FirstPage;
133         return;
134     }
135
136     my $obj = $objs->Next;
137     return $obj if $obj;
138     $objs->NextPage;
139     return $objs->Next;
140 }
141
142 1;
143