View | Details | Raw Unified | Return to bug 34978
Collapse All | Expand All

(-)a/Koha/Plugins.pm (-1 / +29 lines)
Lines 260-271 sub InstallPlugins { Link Here
260
    my $verbose = $params->{verbose} // $self->_verbose;
260
    my $verbose = $params->{verbose} // $self->_verbose;
261
261
262
    my @plugin_classes = $self->plugins();
262
    my @plugin_classes = $self->plugins();
263
    my @plugins;
263
    my (@plugins, @classes_filters);
264
265
    my $has_filters = defined($params->{include}) || defined($params->{exclude});
266
267
    # Warn user if the specified classes doesn't exist and return nothing
268
    if ($has_filters) {
269
        @classes_filters = defined($params->{include}) ? @{$params->{include}} : @{$params->{exclude}};
270
271
        foreach my $classes_filter (@classes_filters) {
272
            my $is_found = 0;
273
274
            foreach my $plugin_class (@plugin_classes) {
275
                $is_found = 1 if $plugin_class =~ ":$classes_filter\$|^$classes_filter\$" || ($classes_filter =~ "^::" && $plugin_class =~ "$classes_filter\$");
276
            }
277
            unless ($is_found) {
278
                warn "$classes_filter have not been found, try a different name";
279
                return;
280
            }
281
        }
282
    }
264
283
265
    foreach my $plugin_class (@plugin_classes) {
284
    foreach my $plugin_class (@plugin_classes) {
266
        if ( can_load( modules => { $plugin_class => undef }, verbose => $verbose, nocache => 1 ) ) {
285
        if ( can_load( modules => { $plugin_class => undef }, verbose => $verbose, nocache => 1 ) ) {
267
            next unless $plugin_class->isa('Koha::Plugins::Base');
286
            next unless $plugin_class->isa('Koha::Plugins::Base');
268
287
288
            # Apply the filters
289
            if ($has_filters) {
290
                my $is_found = 0;
291
                foreach my $classes_filter (@classes_filters) {
292
                    $is_found = 1 if $plugin_class =~ ":$classes_filter\$|^$classes_filter\$" || ($classes_filter =~ "^::" && $plugin_class =~ "$classes_filter\$");
293
                }
294
                next if (defined($params->{include}) && !$is_found) || (defined($params->{exclude}) && $is_found);
295
            }
296
269
            my $plugin;
297
            my $plugin;
270
            my $failed_instantiation;
298
            my $failed_instantiation;
271
299
(-)a/misc/devel/install_plugins.pl (-3 / +25 lines)
Lines 26-36 use Koha::Script; Link Here
26
use C4::Context;
26
use C4::Context;
27
use Koha::Plugins;
27
use Koha::Plugins;
28
28
29
my ($help);
29
my ($help, @include, @exclude);
30
GetOptions( 'help|?' => \$help );
30
31
GetOptions(
32
    'help|?' => \$help,
33
    'include=s' => \@include,
34
    'exclude=s' => \@exclude,
35
) or die "Installation aborted\n";
31
36
32
pod2usage(1) if $help;
37
pod2usage(1) if $help;
33
38
39
die "Installation aborted : --include and --exclude can't be used simultaneously\n" if @include && @exclude;
40
34
unless ( C4::Context->config("enable_plugins") ) {
41
unless ( C4::Context->config("enable_plugins") ) {
35
    print
42
    print
36
"The plugin system must be enabled for one to be able to install plugins\n";
43
"The plugin system must be enabled for one to be able to install plugins\n";
Lines 51-57 for my $existing_plugin (@existing_plugins) { Link Here
51
    }
58
    }
52
}
59
}
53
60
54
my @installed_plugins = Koha::Plugins->new()->InstallPlugins();
61
my $params = {};
62
$params->{'include'} = \@include if @include;
63
$params->{'exclude'} = \@exclude if @exclude;
64
65
my @installed_plugins = Koha::Plugins->new()->InstallPlugins($params);
66
55
unless (@installed_plugins) {
67
unless (@installed_plugins) {
56
    my $plugins_dir = C4::Context->config("pluginsdir");
68
    my $plugins_dir = C4::Context->config("pluginsdir");
57
    if ( ref($plugins_dir) eq 'ARRAY' ) {
69
    if ( ref($plugins_dir) eq 'ARRAY' ) {
Lines 96-101 install_plugins.pl - install all plugins found in plugins_dir Link Here
96
108
97
Options:
109
Options:
98
  -?|--help        brief help message
110
  -?|--help        brief help message
111
  --include        install only the plugins of the specified classes
112
  --exclude        install all the plugins except the specified ones
99
113
100
=head1 OPTIONS
114
=head1 OPTIONS
101
115
Lines 105-110 Options: Link Here
105
119
106
Print a brief help message and exits
120
Print a brief help message and exits
107
121
122
=item B<--include>
123
124
Retrieve the list of plugin classes and install only those. It's possible to specify the package of a class to install a specific plugin (e.g. --include <package::pluginClass> --include <anotherPluginClass>).
125
126
=item B<--exclude>
127
128
Retrieve the list of plugin classes and install all plugins except those. It's possible to specify the package of a class to install a specific plugin (e.g. --exclude <package::pluginClass> --exclude <anotherPluginClass>).
129
108
=back
130
=back
109
131
110
=head1 DESCRIPTION
132
=head1 DESCRIPTION
(-)a/t/db_dependent/Koha/Plugins/Plugins.t (-2 / +55 lines)
Lines 24-30 use File::Temp qw( tempdir tempfile ); Link Here
24
use FindBin qw($Bin);
24
use FindBin qw($Bin);
25
use Module::Load::Conditional qw(can_load);
25
use Module::Load::Conditional qw(can_load);
26
use Test::MockModule;
26
use Test::MockModule;
27
use Test::More tests => 50;
27
use Test::More tests => 62;
28
use Test::Warn;
28
use Test::Warn;
29
29
30
use C4::Context;
30
use C4::Context;
Lines 186-191 subtest 'GetPlugins() tests' => sub { Link Here
186
    $schema->storage->txn_rollback;
186
    $schema->storage->txn_rollback;
187
};
187
};
188
188
189
subtest 'InstallPlugins() tests' => sub {
190
191
    plan tests => 4;
192
193
    $schema->storage->txn_begin;
194
195
    # Temporarily remove any installed plugins data
196
    Koha::Plugins::Methods->delete;
197
    $schema->resultset('PluginData')->delete;
198
199
    # Tests for the exclude paramater
200
    # Test the returned plugins of the InstallPlugins subroutine
201
    my $plugins = Koha::Plugins->new({ enable_plugins => 1 });
202
    my @installed_plugins = $plugins->InstallPlugins({ exclude => ["Test", "Koha::Plugin::MarcFieldValues"] });
203
    my $plugin_classes = join(" ", map{$_->{class}} @installed_plugins);
204
205
    my $result = grep { $plugin_classes !~ $_ } [":Test |:Test\$", ":MarcFieldValues |:MarcFieldValues\$"]
206
        && $plugin_classes =~ ":TestItemBarcodeTransform |:TestItemBarcodeTransform\$";
207
    ok($result, "Excluded plugins are not returned");
208
209
    # Test the plugins in the database
210
    my @plugins = $plugins->GetPlugins({ all => 1, error => 1 });
211
    $plugin_classes = join(" ", map{$_->{class}} @plugins);
212
213
    $result = grep { $plugin_classes !~ $_ } [":Test |:Test\$", ":MarcFieldValues |:MarcFieldValues\$"]
214
        && $plugin_classes =~ ":TestItemBarcodeTransform |:TestItemBarcodeTransform\$";
215
    ok($result, "Excluded plugins are not installed");
216
217
    # Remove installed plugins data
218
    Koha::Plugins::Methods->delete;
219
    $schema->resultset('PluginData')->delete;
220
221
    # Tests for the include parameter
222
    # Test the returned plugins of the InstallPlugins subroutine
223
    @installed_plugins = $plugins->InstallPlugins({ include => ["Test", "Koha::Plugin::MarcFieldValues"]});
224
225
    $result = 1;
226
    foreach my $plugin_class ( map{ $_->{class} } @installed_plugins ) {
227
        $result = 0 unless("$plugin_class" =~ ":Test\$" || "$plugin_class" =~ ":MarcFieldValues\$");
228
    }
229
    ok($result, "Only included plugins are returned");
230
231
    # Test the plugins in the database
232
    @plugins = $plugins->GetPlugins({ all => 1, error => 1});
233
234
    $result = 1;
235
    foreach my $plugin_class ( map{ $_->{class} } @plugins ) {
236
        $result = 0 unless("$plugin_class" =~ ":Test\$" || "$plugin_class" =~ ":MarcFieldValues\$");
237
    }
238
    ok($result, "Only included plugins are installed");
239
240
    $schema->storage->txn_rollback;
241
};
242
189
subtest 'Version upgrade tests' => sub {
243
subtest 'Version upgrade tests' => sub {
190
244
191
    plan tests => 1;
245
    plan tests => 1;
192
- 

Return to bug 34978