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
|
# 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 }}}
package RT::Shredder::Plugin::Base;
use strict;
use warnings FATAL => 'all';
=head1 NAME
RT::Shredder::Plugin::Base - base class for Shredder plugins.
=cut
sub new
{
my $proto = shift;
my $self = bless( {}, ref $proto || $proto );
return $self->_Init( @_ );
}
sub _Init
{
my $self = shift;
$self->{'opt'} = { @_ };
return $self;
}
=head1 USAGE
=head2 masks
If any argument is marked with keyword C<mask> then it means
that this argument support two special characters:
1) C<*> matches any non empty sequence of the characters.
For example C<*@example.com> will match any email address in
C<example.com> domain.
2) C<?> matches exactly one character.
For example C<????> will match any string four characters long.
=head1 METHODS
=head2 for subclassing in plugins
=head3 Type - is not supported yet
See F<Todo> for more info.
=cut
sub Type { return '' }
=head3 SupportArgs
Takes nothing.
Returns list of the supported plugin arguments.
Base class returns list of the arguments which all
classes B<must> support.
=cut
sub SupportArgs { return () }
=head3 HasSupportForArgs
Takes a list of argument names. Returns true if
all arguments are supported by plugin and returns
C<(0, $msg)> in other case.
=cut
sub HasSupportForArgs
{
my $self = shift;
my @args = @_;
my @unsupported = ();
foreach my $a( @args ) {
push @unsupported, $a unless grep $_ eq $a, $self->SupportArgs;
}
return( 0, "Plugin doesn't support argument(s): @unsupported" )
if @unsupported;
return( 1 );
}
=head3 TestArgs
Takes hash with arguments and thier values and returns true
if all values pass testing otherwise returns C<(0, $msg)>.
Stores arguments hash in C<$self->{'opt'}>, you can access this hash
from C<Run> method.
Method should be subclassed if plugin support non standard arguments.
=cut
sub TestArgs
{
my $self = shift;
my %args = @_;
if ( $self->{'opt'} ) {
$self->{'opt'} = { %{$self->{'opt'}}, %args };
} else {
$self->{'opt'} = \%args;
}
return 1;
}
=head3 Run
Takes no arguments.
Executes plugin and return C<(1, @objs)> on success or
C<(0, $msg)> if error had happenned.
Method B<must> be subclassed, this class always returns error.
Method B<must> be called only after C<TestArgs> method in other
case values of the arguments are not available.
=cut
sub Run { return (0, "This is abstract plugin, you couldn't use it directly") }
=head2 utils
=head3 ConvertMaskToSQL
Takes one argument - mask with C<*> and C<?> chars and
return mask SQL chars.
=cut
sub ConvertMaskToSQL {
my $self = shift;
my $mask = shift || '';
$mask =~ s/\*/%/g;
$mask =~ s/\?/_/g;
return $mask;
}
1;
|
