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;
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;
111 Returns hash with names of the available plugins as keys and path to
112 library files as values. Method has no arguments. Can be used as class
115 Takes optional argument C<type> and leaves in the result hash only
116 plugins of that type.
126 foreach my $root( @INC ) {
127 my $mask = File::Spec->catfile( $root, qw(RT Shredder Plugin *.pm) );
128 push @files, glob $mask;
132 for my $f (reverse @files) {
133 $res{$1} = $f if $f =~ /([^\\\/]+)\.pm$/;
136 return %res unless $type;
139 foreach my $name( keys %res ) {
140 my $class = join '::', qw(RT Shredder Plugin), $name;
141 unless( $class->require ) {
142 delete $res{ $name };
145 next if lc $class->Type eq lc $type;
146 delete $res{ $name };
154 Takes name of the plugin as first argument, loads plugin,
155 creates new plugin object and reblesses self into plugin
156 if all steps were successfuly finished, then you don't need to
157 create new object for the plugin.
159 Other arguments are sent to the constructor of the plugin
162 Returns C<$status> and C<$message>. On errors status
165 In scalar context, returns $status only.
172 my $name = shift or return (0, "Name not specified");
173 $name =~ /^\w+(::\w+)*$/ or return (0, "Invalid plugin name");
175 my $plugin = "RT::Shredder::Plugin::$name";
176 $plugin->require or return( 0, "Failed to load $plugin" );
177 return wantarray ? ( 0, "Plugin '$plugin' has no method new") : 0 unless $plugin->can('new');
179 my $obj = eval { $plugin->new( @_ ) };
180 return wantarray ? ( 0, $@ ) : 0 if $@;
181 return wantarray ? ( 0, 'constructor returned empty object' ) : 0 unless $obj;
183 $self->Rebless( $obj );
184 return wantarray ? ( 1, "successfuly load plugin" ) : 1;
189 Takes formatted string as first argument and which is used to
190 load plugin. The format of the string is
192 <plugin name>[=<arg>,<val>[;<arg>,<val>]...]
194 exactly like in the L<rt-shredder> script. All other
195 arguments are sent to the plugins constructor.
197 Method does the same things as C<LoadByName>, but also
198 checks if the plugin supports arguments and values are correct,
199 so you can C<Run> specified plugin immediatly.
201 Returns list with C<$status> and C<$message>. On errors status
209 my ($plugin, $args) = split /=/, ( shift || '' ), 2;
211 my ($status, $msg) = $self->LoadByName( $plugin, @_ );
212 return( $status, $msg ) unless $status;
215 foreach( split /\s*;\s*/, ( $args || '' ) ) {
216 my( $k,$v ) = split /\s*,\s*/, ( $_ || '' ), 2;
217 unless( $args{$k} ) {
222 $args{$k} = [ $args{$k} ] unless UNIVERSAL::isa( $args{ $k }, 'ARRAY');
223 push @{ $args{$k} }, $v;
226 ($status, $msg) = $self->HasSupportForArgs( keys %args );
227 return( $status, $msg ) unless $status;
229 ($status, $msg) = $self->TestArgs( %args );
230 return( $status, $msg ) unless $status;
232 return( 1, "successfuly load plugin" );
237 Instance method that takes one object as argument and rebless
238 the current object into into class of the argument and copy data
239 of the former. Returns nothing.
241 Method is used by C<Load*> methods to automaticaly rebless
242 C<RT::Shredder::Plugin> object into class of the loaded
249 my( $self, $obj ) = @_;
250 bless( $self, ref $obj );