1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2017 Best Practical Solutions, LLC
6 # <sales@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
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
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.
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.
30 # CONTRIBUTION SUBMISSION POLICY:
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.)
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.
47 # END BPS TAGGED BLOCK }}}
49 package RT::Shredder::Plugin::Base;
52 use warnings FATAL => 'all';
56 RT::Shredder::Plugin::Base - base class for Shredder plugins.
63 my $self = bless( {}, ref $proto || $proto );
64 return $self->_Init( @_ );
70 $self->{'opt'} = { @_ };
78 If any argument is marked with keyword C<mask> then it means
79 that this argument support two special characters:
81 1) C<*> matches any non empty sequence of the characters.
82 For example C<*@example.com> will match any email address in
83 C<example.com> domain.
85 2) C<?> matches exactly one character.
86 For example C<????> will match any string four characters long.
90 =head2 for subclassing in plugins
92 =head3 Type - is not supported yet
94 See F<Todo> for more info.
98 sub Type { return '' }
103 Returns list of the supported plugin arguments.
105 Base class returns list of the arguments which all
106 classes B<must> support.
110 sub SupportArgs { return () }
112 =head3 HasSupportForArgs
114 Takes a list of argument names. Returns true if
115 all arguments are supported by plugin and returns
116 C<(0, $msg)> in other case.
120 sub HasSupportForArgs
124 my @unsupported = ();
125 foreach my $a( @args ) {
126 push @unsupported, $a unless grep $_ eq $a, $self->SupportArgs;
128 return( 0, "Plugin doesn't support argument(s): @unsupported" )
135 Takes hash with arguments and thier values and returns true
136 if all values pass testing otherwise returns C<(0, $msg)>.
138 Stores arguments hash in C<$self->{'opt'}>, you can access this hash
141 Method should be subclassed if plugin support non standard arguments.
149 if ( $self->{'opt'} ) {
150 $self->{'opt'} = { %{$self->{'opt'}}, %args };
152 $self->{'opt'} = \%args;
160 Executes plugin and return C<(1, @objs)> on success or
161 C<(0, $msg)> if error had happenned.
163 Method B<must> be subclassed, this class always returns error.
165 Method B<must> be called only after C<TestArgs> method in other
166 case values of the arguments are not available.
170 sub Run { return (0, "This is abstract plugin, you couldn't use it directly") }
174 =head3 ConvertMaskToSQL
176 Takes one argument - mask with C<*> and C<?> chars and
177 return mask SQL chars.
181 sub ConvertMaskToSQL {
183 my $mask = shift || '';