Koha/plugins/plugins-home.pl
Marcel de Rooy d8e04545b8
Bug 35536: Refine verbose handling in some Koha::Plugins calls
Three routines in Plugins got the verbose parameter on 35507.
We can refine this a bit further.
The idea here is report when you are installing plugins but not
report when just calling plugins (flooding logs).

[1] GetPlugins: Most callers do not expect (or check) results for
    failing plugins. This patch makes GetPlugins only return
    errors when passing the *errors* flag (in 2 cases).
    [a] The misc/devel script prints warnings now using verbose,
        so does not need the errors flag anymore.
    [b] plugins/plugins-home is the only case left. Tiny adjustment
        to keep current behavior. Fixed colspan in template.
        Does not need verbose in favor of 'errors' (passed to
        template).
    [c] For most calls we do not want verbose. New default is 0.

[2] InstallPlugins
    [a] Disabled verbose in plugin-upload. Not really needed.
        Added a FIXME; we need to improve individual install.
    [b] misc/devel: No warnings anymore when calling InstallPlugins
        after GetPlugins.

[3] get_enabled_plugins
    [a] Plugins->call does not need verbose.
    [b] Plugins->feature_enabled does not need it too.

Test plan:

[1] See previous plan. With TestMR data but without patch, run
misc script and go to plugins-home. Do you see load errors on
commandline or form?

[2] Run plugins/plugins-upload (uploading just some file is good
enough); verify that you do not see TestMR lines in logfile.

[3] Run t/db_dependent/Koha/Plugins/Plugins.t for the additional
test on verbose and errors flag.

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Katrin Fischer <katrin.fischer@bsz-bw.de>
2024-03-22 12:26:40 +01:00

141 lines
5.6 KiB
Perl
Executable file

#!/usr/bin/perl
# Copyright 2010 Kyle M Hall <kyle.m.hall@gmail.com>
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha 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 Koha; if not, see <http://www.gnu.org/licenses>.
use Modern::Perl;
use CGI qw ( -utf8 );
use JSON qw( from_json );
use LWP::Simple qw( get );
use Koha::Plugins;
use C4::Auth qw( get_template_and_user );
use C4::Output qw( output_html_with_http_headers );
use C4::Context;
my $plugins_enabled = C4::Context->config("enable_plugins");
my $input = CGI->new;
my $method = $input->param('method');
my $plugin_search = $input->param('plugin-search');
my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
{ template_name => ($plugins_enabled) ? "plugins/plugins-home.tt" : "plugins/plugins-disabled.tt",
query => $input,
type => "intranet",
flagsrequired => { plugins => '*' },
}
);
if ($plugins_enabled) {
$template->param(
koha_version => C4::Context->preference("Version"),
method => $method,
);
my ( $plugins, $failures ) = Koha::Plugins->new()->GetPlugins(
{
method => $method,
all => 1,
errors => 1
}
);
$template->param( plugins => [ @$plugins, @$failures ] );
$template->param( plugins_restricted => C4::Context->config('plugins_restricted') );
$template->param( can_search => C4::Context->config('plugin_repos') ? 1 : 0 );
my @results;
if ($plugin_search) {
my $repos = C4::Context->config('plugin_repos');
# Fix data structure if only one repo defined
if ( ref($repos->{repo}) eq 'HASH' ) {
$repos = { repo => [ $repos->{repo} ] };
}
foreach my $r ( @{ $repos->{repo} } ) {
if ( $r->{service} eq 'github' ) {
my $url = "https://api.github.com/search/repositories?q=$plugin_search+user:$r->{org_name}+in:name,description";
my $response = from_json( get($url) );
foreach my $result ( @{ $response->{items} } ) {
next unless $result->{name} =~ /^koha-plugin-/;
my $releases = $result->{url} . "/releases/latest";
my $release_info = get($releases);
next unless $release_info;
my $release = from_json( $release_info );
my $tag_name = $release->{tag_name};
for my $asset ( @{$release->{assets}} ) {
if ($asset->{browser_download_url} =~ m/\.kpz$/) {
$result->{install_name} = $asset->{name};
$result->{install_url} = $asset->{browser_download_url};
$result->{tag_name} = $tag_name;
}
}
push( @results, { repo => $r, result => $result } );
}
}
elsif ( $r->{service} eq 'gitlab' ) {
my $org_name = $r->{org_name};
my $url = "https://gitlab.com/api/v4/groups/$org_name/projects?with_issues_enabled=no\&with_merge_requests_enabled=no\&with_shared=no\&include_subgroups=yes\&search=koha-plugin+$plugin_search";
my $response = from_json( get($url) );
foreach my $result ( @{ $response } ) {
next unless $result->{name} =~ /^koha-plugin-/;
my $project_id = $result->{id};
my $description = $result->{description} // '';
my $web_url = $result->{web_url};
my $releases_url = "https://gitlab.com/api/v4/projects/$project_id/releases";
my $releases_info = get($releases_url);
next unless $releases_info;
my @releases = @{ from_json($releases_info) };
if ( scalar @releases > 0 ) {
# Pick the first one, the latest release
my $latest = $releases[0];
my $name = $latest->{name};
my $tag_name = $latest->{tag_name};
my @links = @{ $latest->{assets}->{links} };
my $url = $links[0]->{direct_asset_url};
my @parts = split( '/', $url );
my $filename = $parts[-1];
next unless $url =~ m/\.kpz$/;
my $result = {
description => $description,
install_name => $filename,
install_url => $url,
html_url => $web_url,
name => $name,
tag_name => $tag_name,
};
push @results, { repo => $r, result => $result };
}
}
}
}
$template->param(
search_results => \@results,
search_term => $plugin_search,
);
}
}
output_html_with_http_headers( $input, $cookie, $template->output );