1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2015 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;
52 use warnings FATAL => 'all';
57 RT::Shredder::Plugin - interface to access shredder plugins
61 use RT::Shredder::Plugin;
63 # get list of the plugins
64 my %plugins = RT::Shredder::Plugin->List;
67 my $plugin = RT::Shredder::Plugin->new;
68 my( $status, $msg ) = $plugin->LoadByName( 'Tickets' );
70 print STDERR "Couldn't load plugin 'Tickets': $msg\n";
74 # load plugin by preformatted string
75 my $plugin = RT::Shredder::Plugin->new;
76 my( $status, $msg ) = $plugin->LoadByString( 'Tickets=status,deleted' );
78 print STDERR "Couldn't load plugin: $msg\n";
86 Object constructor, returns new object. Takes optional hash
87 as arguments, it's not required and this class doesn't use it,
88 but plugins could define some arguments and can handle them
89 after your've load it.
96 my $self = bless( {}, ref $proto || $proto );
105 $self->{'opt'} = \%args;
110 Returns hash with names of the available plugins as keys and path to
111 library files as values. Method has no arguments. Can be used as class
114 Takes optional argument C<type> and leaves in the result hash only
115 plugins of that type.
125 foreach my $root( @INC ) {
126 my $mask = File::Spec->catfile( $root, qw(RT Shredder Plugin *.pm) );
127 push @files, glob $mask;
131 for my $f (reverse @files) {
132 $res{$1} = $f if $f =~ /([^\\\/]+)\.pm$/;
135 return %res unless $type;
138 foreach my $name( keys %res ) {
139 my $class = join '::', qw(RT Shredder Plugin), $name;
140 unless( eval "require $class" ) {
141 delete $res{ $name };
144 next if lc $class->Type eq lc $type;
145 delete $res{ $name };
153 Takes name of the plugin as first argument, loads plugin,
154 creates new plugin object and reblesses self into plugin
155 if all steps were successfuly finished, then you don't need to
156 create new object for the plugin.
158 Other arguments are sent to the constructor of the plugin
161 Returns C<$status> and C<$message>. On errors status
169 my $name = shift or return (0, "Name not specified");
170 $name =~ /^\w+(::\w+)*$/ or return (0, "Invalid plugin name");
173 my $plugin = "RT::Shredder::Plugin::$name";
174 eval "require $plugin" or return( 0, $@ );
175 return( 0, "Plugin '$plugin' has no method new") unless $plugin->can('new');
177 my $obj = eval { $plugin->new( @_ ) };
178 return( 0, $@ ) if $@;
179 return( 0, 'constructor returned empty object' ) unless $obj;
181 $self->Rebless( $obj );
182 return( 1, "successfuly load plugin" );
187 Takes formatted string as first argument and which is used to
188 load plugin. The format of the string is
190 <plugin name>[=<arg>,<val>[;<arg>,<val>]...]
192 exactly like in the L<rt-shredder> script. All other
193 arguments are sent to the plugins constructor.
195 Method does the same things as C<LoadByName>, but also
196 checks if the plugin supports arguments and values are correct,
197 so you can C<Run> specified plugin immediatly.
199 Returns list with C<$status> and C<$message>. On errors status
207 my ($plugin, $args) = split /=/, ( shift || '' ), 2;
209 my ($status, $msg) = $self->LoadByName( $plugin, @_ );
210 return( $status, $msg ) unless $status;
213 foreach( split /\s*;\s*/, ( $args || '' ) ) {
214 my( $k,$v ) = split /\s*,\s*/, ( $_ || '' ), 2;
215 unless( $args{$k} ) {
220 $args{$k} = [ $args{$k} ] unless UNIVERSAL::isa( $args{ $k }, 'ARRAY');
221 push @{ $args{$k} }, $v;
224 ($status, $msg) = $self->HasSupportForArgs( keys %args );
225 return( $status, $msg ) unless $status;
227 ($status, $msg) = $self->TestArgs( %args );
228 return( $status, $msg ) unless $status;
230 return( 1, "successfuly load plugin" );
235 Instance method that takes one object as argument and rebless
236 the current object into into class of the argument and copy data
237 of the former. Returns nothing.
239 Method is used by C<Load*> methods to automaticaly rebless
240 C<RT::Shredder::Plugin> object into class of the loaded
247 my( $self, $obj ) = @_;
248 bless( $self, ref $obj );