1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
# BEGIN BPS TAGGED BLOCK {{{
#
# COPYRIGHT:
#
# This software is Copyright (c) 1996-2011 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 }}}
=head1 NAME
RT::SavedSearches - a pseudo-collection for SavedSearch objects.
=head1 SYNOPSIS
use RT::SavedSearch
=head1 DESCRIPTION
SavedSearches is an object consisting of a number of SavedSearch objects.
It works more or less like a DBIx::SearchBuilder collection, although it
is not.
=head1 METHODS
=cut
package RT::SavedSearches;
use RT::SavedSearch;
use strict;
use base 'RT::Base';
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = {};
bless ($self, $class);
$self->CurrentUser(@_);
$self->{'idx'} = 0;
$self->{'objects'} = [];
return $self;
}
=head2 LimitToPrivacy
Takes two argumets: a privacy string, of the format "<class>-<id>", as
produced by RT::SavedSearch::Privacy(); and a type string, as produced
by RT::SavedSearch::Type(). The SavedSearches object will load the
searches belonging to that user or group that are of the type
specified. If no type is specified, all the searches belonging to the
user/group will be loaded. Repeated calls to the same object should DTRT.
=cut
sub LimitToPrivacy {
my $self = shift;
my $privacy = shift;
my $type = shift;
my $object = $self->_GetObject($privacy);
if ($object) {
$self->{'objects'} = [];
my @search_atts = $object->Attributes->Named('SavedSearch');
foreach my $att (@search_atts) {
my $search = RT::SavedSearch->new($self->CurrentUser);
$search->Load($privacy, $att->Id);
next if $type && $search->Type ne $type;
push(@{$self->{'objects'}}, $search);
}
} else {
$RT::Logger->error("Could not load object $privacy");
}
}
### Accessor methods
=head2 Next
Returns the next object in the collection.
=cut
sub Next {
my $self = shift;
my $search = $self->{'objects'}->[$self->{'idx'}];
if ($search) {
$self->{'idx'}++;
} else {
# We have run out of objects; reset the counter.
$self->{'idx'} = 0;
}
return $search;
}
=head2 Count
Returns the number of search objects found.
=cut
sub Count {
my $self = shift;
return scalar @{$self->{'objects'}};
}
### Internal methods
# _GetObject: helper routine to load the correct object whose parameters
# have been passed.
sub _GetObject {
my $self = shift;
my $privacy = shift;
return RT::SavedSearch->new($self->CurrentUser)->_GetObject($privacy);
}
### Internal methods
# _PrivacyObjects: returns a list of objects that can be used to load saved searches from.
sub _PrivacyObjects {
my $self = shift;
my $CurrentUser = $self->CurrentUser;
my $groups = RT::Groups->new($CurrentUser);
$groups->LimitToUserDefinedGroups;
$groups->WithMember( PrincipalId => $CurrentUser->Id,
Recursively => 1 );
return ( $CurrentUser->UserObj, @{ $groups->ItemsArrayRef() } );
}
RT::Base->_ImportOverlays();
1;
|
