Attachment 169562 Details for Bug 37472 – Bug 37472: Allow plugin po files to be installed

[patch] Bug 37472: Allow plugin po files to be installed

Bug-37472-Allow-plugin-po-files-to-be-installed.patch (text/plain), 6.82 KB, created by Matt Blenkinsop on 2024-07-25 14:31:58 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Matt Blenkinsop

Created: 2024-07-25 14:31:58 UTC

Size: 6.82 KB

patch

obsolete

>From 457b2f52fecd9cc670d0d2715a3bfca9ff05d202 Mon Sep 17 00:00:00 2001
>From: Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com>
>Date: Thu, 18 Jul 2024 15:51:03 +0000
>Subject: [PATCH] Bug 37472: Allow plugin po files to be installed
>
>This patch allows the koha-translate command to identify plugins with translation files and install them alongside the core translation files
>---
> C4/Templates.pm                  |  3 ++
> Koha/Plugins.pm                  |  9 ++++
> misc/translator/LangInstaller.pm | 72 ++++++++++++++++++++++++++++++--
> misc/translator/translate        |  8 +++-
> 4 files changed, 88 insertions(+), 4 deletions(-)
>
>diff --git a/C4/Templates.pm b/C4/Templates.pm
>index fb7d3e5cb56..84a8735b8bc 100644
>--- a/C4/Templates.pm
>+++ b/C4/Templates.pm
>@@ -179,6 +179,9 @@ sub _get_template_file {
>     $tmplbase = "$htdocs/$theme/$lang/modules/$tmplbase" if $tmplbase !~ /^\//;
>         # do not prefix an absolute path
> 
>+    if ( $tmplbase =~ /plugin/ && $tmplbase =~ /^\// ) {
>+        $tmplbase =~ s/\/en\//\/$lang\//;
>+    }
>     return ( $htdocs, $theme, $lang, $tmplbase );
> }
> 
>diff --git a/Koha/Plugins.pm b/Koha/Plugins.pm
>index 2b4c07956e6..e2cffee473a 100644
>--- a/Koha/Plugins.pm
>+++ b/Koha/Plugins.pm
>@@ -278,6 +278,7 @@ sub InstallPlugins {
> 
>     my @plugin_classes = $self->plugins();
>     my @plugins;
>+    my @plugins_to_translate;
> 
>     foreach my $plugin_class (@plugin_classes) {
>         if ( can_load( modules => { $plugin_class => undef }, verbose => $verbose, nocache => 1 ) ) {
>@@ -308,9 +309,17 @@ sub InstallPlugins {
>             }
> 
>             push @plugins, $plugin;
>+
>+            my @path_params = split( /\//, $plugin->{_bundle_path} );
>+            my $translation_data = {
>+                bundle_path => $plugin->{_bundle_path},
>+                name => $path_params[-1],
>+            };
>         }
>     }
> 
>+    # Add translator stuff here
>+
>     Koha::Cache::Memory::Lite->clear_from_cache(ENABLED_PLUGINS_CACHE_KEY);
> 
>     $self->_restart_after_change();
>diff --git a/misc/translator/LangInstaller.pm b/misc/translator/LangInstaller.pm
>index fcf78bba98b..a9b1e123205 100644
>--- a/misc/translator/LangInstaller.pm
>+++ b/misc/translator/LangInstaller.pm
>@@ -29,6 +29,9 @@ use FindBin qw( $Bin );
> use File::Path qw( make_path );
> use File::Copy;
> use File::Slurp qw( read_file );
>+use JSON qw( decode_json encode_json );
>+
>+use Koha::Plugins;
> 
> sub set_lang {
>     my ($self, $lang) = @_;
>@@ -38,8 +41,37 @@ sub set_lang {
>                             "/prog/$lang/modules/admin/preferences";
> }
> 
>+sub _identify_translatable_plugins {
>+    my ($args) = @_;
>+
>+    my @plugins = Koha::Plugins::GetPlugins(
>+        {
>+            metadata => { has_translations => 1 },
>+        }
>+    );
>+
>+    return () if scalar( @plugins == 0 );
>+
>+    my @plugin_dirs;
>+    foreach my $plugin (@plugins) {
>+        my @path_params = split( /\//,$plugin->{_bundle_path});
>+        my $translation_data = {
>+            bundle_path => $plugin->{_bundle_path},
>+            name        => $path_params[-1],
>+        };
>+
>+        push @plugin_dirs, $translation_data;
>+    }
>+    return \@plugin_dirs;
>+}
>+
> sub new {
>-    my ($class, $lang, $pref_only, $verbose) = @_;
>+    my ($class, $args) = @_;
>+
>+    my $lang        = $args->{lang};
>+    my $pref_only   = $args->{pref_only};
>+    my $verbose     = $args->{verbose};
>+    my $plugin_dirs = $args->{plugin_dirs} || _identify_translatable_plugins();
> 
>     my $self                 = { };
> 
>@@ -56,6 +88,7 @@ sub new {
>     $self->{po2json}         = "yarn run po2json";
>     $self->{gzip}            = `which gzip`;
>     $self->{gunzip}          = `which gunzip`;
>+    $self->{plugin_dirs}     = $plugin_dirs;
>     chomp $self->{msgfmt};
>     chomp $self->{gzip};
>     chomp $self->{gunzip};
>@@ -132,6 +165,7 @@ sub new {
>         suffix => "-installer-UNIMARC.po",
>     };
> 
>+
>     bless $self, $class;
> }
> 
>@@ -317,6 +351,21 @@ sub install_tmpl {
>                 ( @nomarc  ? ' -n ' . join ' -n ', @nomarc : '');
>         }
>     }
>+
>+    for my $plugin ( @{$self->{plugin_dirs}} ) {
>+        print
>+            "  Install templates from plugin: '$plugin->{name}'\n",
>+            if $self->{verbose};
>+        
>+        my $trans_dir = $plugin->{bundle_path} . "/views/en/";
>+        my $lang_dir = $plugin->{bundle_path} . "/views/$self->{lang}";
>+        mkdir $lang_dir unless -d $lang_dir;
>+
>+        system "$self->{process} install "
>+            . "-i $trans_dir "
>+            . "-o $lang_dir  "
>+            . "-s $plugin->{bundle_path}/translator/po/$self->{lang}-$plugin->{name}-template.po -r "
>+    }
> }
> 
> sub translate_yaml {
>@@ -460,7 +509,24 @@ sub install_messages {
>     `$po2json_cmd`;
>     my $json = read_file($tmp_po);
> 
>-    my $js_locale_data = sprintf 'var json_locale_data = {"Koha":%s};', $json;
>+    # Add plugin javascript to the same file to avoid needing multiple imports in doc-head template files
>+    my $js_po_data = decode_json($json);
>+    foreach my $plugin ( @{$self->{plugin_dirs}} ) {
>+        my $tmp_pluginpo = sprintf '/tmp/%s-%s.po', $plugin->{name}, $self->{lang};
>+        my $plugin_po2json_cmd = sprintf '%s %s %s', $self->{po2json}, $plugin->{bundle_path} . '/translator/po/' . $self->{lang} . '-' . $plugin->{name} . '-js.po', $tmp_pluginpo;
>+        `$plugin_po2json_cmd`;
>+        my $plugin_json = read_file($tmp_pluginpo);
>+
>+        my $plugin_js_po_data = decode_json($plugin_json);
>+        delete $plugin_js_po_data->{''};
>+
>+        foreach my $key (keys %$plugin_js_po_data) {
>+            $js_po_data->{$key} = $plugin_js_po_data->{$key} unless exists $js_po_data->{$key};
>+        }
>+    }
>+    my $combined_json = encode_json($js_po_data);
>+
>+    my $js_locale_data = sprintf 'var json_locale_data = {"Koha":%s};', $combined_json;
>     my $progdir = C4::Context->config('intrahtdocs') . '/prog';
>     mkdir "$progdir/$self->{lang}/js";
>     open my $fh, '>', "$progdir/$self->{lang}/js/locale_data.js";
>@@ -538,7 +604,7 @@ LangInstaller.pm - Handle templates and preferences translation
> 
> =head1 SYNOPSYS
> 
>-  my $installer = LangInstaller->new( 'fr-FR' );
>+  my $installer = LangInstaller->new( { lang => 'fr-FR' } );
>   $installer->create();
>   $installer->update();
>   $installer->install();
>diff --git a/misc/translator/translate b/misc/translator/translate
>index 3c186d3ea2d..979ff0d2dd5 100755
>--- a/misc/translator/translate
>+++ b/misc/translator/translate
>@@ -55,7 +55,13 @@ usage() if $#ARGV != 1 && $#ARGV != 0;
> my ($cmd, $lang) = @ARGV;
> $cmd = lc $cmd;
> if ( $cmd =~ /^(install|compress|uncompress)$/ ) {
>-    my $installer = LangInstaller->new( $lang, $pref, $verbose );
>+    my $installer = LangInstaller->new(
>+        {
>+            lang      => $lang,
>+            pref_only => $pref,
>+            verbose   => $verbose
>+        }
>+    );
>     if ( $lang and not grep( {$_ eq $lang} @{ $installer->{langs} } ) ) {
>         print "Unsupported language: $lang\n";
>         exit;
>-- 
>2.39.3 (Apple Git-146)

Actions: View | Diff | Splinter Review

Attachments on bug 37472: 169561 | 169562 | 169563 | 169564