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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
# BEGIN BPS TAGGED BLOCK {{{
#
# COPYRIGHT:
#
# This software is Copyright (c) 1996-2017 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::SavedSearch - an API for saving and retrieving search form values.
=head1 SYNOPSIS
use RT::SavedSearch
=head1 DESCRIPTION
SavedSearch is an object based on L<RT::SharedSetting> that can belong
to either an L<RT::User> or an L<RT::Group>. It consists of an ID,
a description, and a number of search parameters.
=cut
package RT::SavedSearch;
use strict;
use warnings;
use base qw/RT::SharedSetting/;
=head1 METHODS
=head2 ObjectName
An object of this class is called "search"
=cut
sub ObjectName { "search" } # loc
sub PostLoad {
my $self = shift;
$self->{'Type'} = $self->{'Attribute'}->SubValue('SearchType');
}
sub SaveAttribute {
my $self = shift;
my $object = shift;
my $args = shift;
my $params = $args->{'SearchParams'};
$params->{'SearchType'} = $args->{'Type'} || 'Ticket';
return $object->AddAttribute(
'Name' => 'SavedSearch',
'Description' => $args->{'Name'},
'Content' => $params,
);
}
sub UpdateAttribute {
my $self = shift;
my $args = shift;
my $params = $args->{'SearchParams'} || {};
my ($status, $msg) = $self->{'Attribute'}->SetSubValues(%$params);
if ($status && $args->{'Name'}) {
($status, $msg) = $self->{'Attribute'}->SetDescription($args->{'Name'});
}
return ($status, $msg);
}
=head2 RT::SavedSearch->EscapeDescription STRING
This is a class method because system-level saved searches aren't true
C<RT::SavedSearch> objects but direct C<RT::Attribute> objects.
Returns C<STRING> with all square brackets except those in C<[_1]> escaped,
ready for passing as the first argument to C<loc()>.
=cut
sub EscapeDescription {
my $self = shift;
my $desc = shift;
if ($desc) {
# We only use [_1] in saved search descriptions, so let's escape other "["
# and "]" unless they are escaped already.
$desc =~ s/(?<!~)\[(?!_1\])/~[/g;
$desc =~ s/(?<!~)(?<!\[_1)\]/~]/g;
}
return $desc;
}
=head2 Type
Returns the type of this search, e.g. 'Ticket'. Useful for denoting the
saved searches that are relevant to a particular search page.
=cut
sub Type {
my $self = shift;
return $self->{'Type'};
}
### Internal methods
# _PrivacyObjects: returns a list of objects that can be used to load, create,
# etc. saved searches from. You probably want to use the wrapper methods like
# ObjectsForLoading, ObjectsForCreating, etc.
sub _PrivacyObjects {
my $self = shift;
my ($has_attr) = @_;
my $CurrentUser = $self->CurrentUser;
my $groups = RT::Groups->new($CurrentUser);
$groups->LimitToUserDefinedGroups;
$groups->WithCurrentUser;
if ($has_attr) {
my $attrs = $groups->Join(
ALIAS1 => 'main',
FIELD1 => 'id',
TABLE2 => 'Attributes',
FIELD2 => 'ObjectId',
);
$groups->Limit(
ALIAS => $attrs,
FIELD => 'ObjectType',
VALUE => 'RT::Group',
);
$groups->Limit(
ALIAS => $attrs,
FIELD => 'Name',
VALUE => $has_attr,
);
}
return ( $CurrentUser->UserObj, @{ $groups->ItemsArrayRef() } );
}
sub ObjectsForLoading {
my $self = shift;
return grep { $self->CurrentUserCanSee($_) } $self->_PrivacyObjects( "SavedSearch" );
}
RT::Base->_ImportOverlays();
1;
|
