[PATCH v2 0/3] po: handle translation of polkit policy file strings
There was a proposal https://gitlab.com/libvirt/libvirt/-/merge_requests/387 to add translations for the polkit files. In reviewing this we came to the conclusion the approach was undesirable. After getting misled by a Debian/Ubuntu specific downstream only patch to polkit which auto-translated polkit files at runtime, this implements the manual approach of merging translations into the polkit files at build time. Changed in v2: - Fix introduction of 'polkitactionsdir' - Also introduce 'polkitrulesdir' - Fix syntax check rules for POFILES with generated polkit - Remove incorrect 'install: true' rule for policy.in file Daniel P. Berrangé (3): po: add its rules for translating polkit file strings meson: remove duplication of polkit dirs construction remote: apply translations to polkit files build-aux/syntax-check.mk | 5 +++-- meson.build | 6 ++++++ po/POTFILES | 2 ++ po/its/polkit.its | 8 ++++++++ po/its/polkit.loc | 6 ++++++ po/meson.build | 5 ++--- src/access/meson.build | 20 +++++++++++++++---- .../{libvirtd.policy => libvirtd.policy.in} | 0 src/remote/meson.build | 15 ++++++++------ 9 files changed, 52 insertions(+), 15 deletions(-) create mode 100644 po/its/polkit.its create mode 100644 po/its/polkit.loc rename src/remote/{libvirtd.policy => libvirtd.policy.in} (100%) -- 2.47.1
xgettext / msgfmt have generic support for extracting / merging strings in XML files, however, they need to be told something about the schema to know which fields are translatable. This is done by providing 'its' rules. Usually the 'its' rules would be shipped in a -devel package of the app which owns the schema definition, but polkit does not do this. Thus libvirt (and other apps) must ship their own local 'its' rules for polkit. Reviewed-by: Ján Tomko <jtomko@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- po/its/polkit.its | 8 ++++++++ po/its/polkit.loc | 6 ++++++ po/meson.build | 1 + 3 files changed, 15 insertions(+) create mode 100644 po/its/polkit.its create mode 100644 po/its/polkit.loc diff --git a/po/its/polkit.its b/po/its/polkit.its new file mode 100644 index 0000000000..1c37e6bee7 --- /dev/null +++ b/po/its/polkit.its @@ -0,0 +1,8 @@ +<?xml version="1.0"?> +<its:rules xmlns:its="http://www.w3.org/2005/11/its" + version="2.0"> + <its:translateRule selector="//*" translate="no"/> + <its:translateRule selector="//action/description | + //action/message" + translate="yes"/> +</its:rules> diff --git a/po/its/polkit.loc b/po/its/polkit.loc new file mode 100644 index 0000000000..c7427ec672 --- /dev/null +++ b/po/its/polkit.loc @@ -0,0 +1,6 @@ +<?xml version="1.0"?> +<locatingRules> + <locatingRule name="polkit policy" pattern="*.policy"> + <documentRule localName="policyconfig" target="polkit.its"/> + </locatingRule> +</locatingRules> diff --git a/po/meson.build b/po/meson.build index 592b254447..126eeabe17 100644 --- a/po/meson.build +++ b/po/meson.build @@ -14,6 +14,7 @@ i18n.gettext( '--package-version=@0@'.format(meson.project_version()), '--sort-output', ], + data_dirs: meson.current_source_dir() ) potfiles_dep = [ -- 2.47.1
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- meson.build | 2 ++ src/access/meson.build | 2 +- src/remote/meson.build | 5 ++--- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/meson.build b/meson.build index ca1b915737..409a44b69c 100644 --- a/meson.build +++ b/meson.build @@ -114,6 +114,8 @@ localedir = prefix / get_option('localedir') mandir = prefix / get_option('mandir') sbindir = prefix / get_option('sbindir') sharedstatedir = prefix / get_option('sharedstatedir') +polkitactionsdir = datadir / 'polkit-1' / 'actions' +polkitrulesdir = datadir / 'polkit-1' / 'rules.d' docdir = get_option('docdir') if docdir == '' diff --git a/src/access/meson.build b/src/access/meson.build index fc5ba5b342..c006ca5934 100644 --- a/src/access/meson.build +++ b/src/access/meson.build @@ -73,7 +73,7 @@ if conf.has('WITH_POLKIT') command: [ meson_python_prog, python3_prog, genpolkit_prog, '@INPUT@' ], capture: true, install: true, - install_dir: datadir / 'polkit-1' / 'actions', + install_dir: polkitactionsdir, ) endif endif diff --git a/src/remote/meson.build b/src/remote/meson.build index 831acaaa01..9a0288f928 100644 --- a/src/remote/meson.build +++ b/src/remote/meson.build @@ -294,15 +294,14 @@ if conf.has('WITH_REMOTE') endif if conf.has('WITH_POLKIT') - polkitdir = datadir / 'polkit-1' install_data( 'libvirtd.policy', - install_dir: polkitdir / 'actions', + install_dir: polkitactionsdir, rename: [ 'org.libvirt.unix.policy' ], ) install_data( 'libvirtd.rules', - install_dir: polkitdir / 'rules.d', + install_dir: polkitrulesdir, rename: [ '50-libvirt.rules' ], ) endif -- 2.47.1
The 'description' and 'message' fields in polkit policy files should be translated into the user's chosen language. xgettext is told to search in both and source and build dirs by meson. Unfortunately a bug in xgettext means that when it searches for built files in XML format, it'll trigger a warning message due to failure to load the generated file from the source dir: xgettext: cannot read ..snip../libvirt/src/access/org.libvirt.api.policy: failed to load external entity "..snip../libvirt/src/access/org.libvirt.api.policy" This is harmless since it then goes on to try the build dir and succeeds, but will pollute the output of 'ninja libvirt-pot' Related: https://gitlab.com/libvirt/libvirt/-/merge_requests/387 Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- build-aux/syntax-check.mk | 5 +++-- meson.build | 4 ++++ po/POTFILES | 2 ++ po/meson.build | 4 +--- src/access/meson.build | 18 +++++++++++++++--- .../{libvirtd.policy => libvirtd.policy.in} | 0 src/remote/meson.build | 10 +++++++--- 7 files changed, 32 insertions(+), 11 deletions(-) rename src/remote/{libvirtd.policy => libvirtd.policy.in} (100%) diff --git a/build-aux/syntax-check.mk b/build-aux/syntax-check.mk index 2c9593c28f..e6afb879be 100644 --- a/build-aux/syntax-check.mk +++ b/build-aux/syntax-check.mk @@ -1273,9 +1273,10 @@ po_file ?= $(top_srcdir)/po/POTFILES # This is all generated files for RPC code. generated_files = \ $(top_builddir)/src/*.[ch] \ - $(top_builddir)/src/*/*.[ch] + $(top_builddir)/src/*/*.[ch] \ + $(top_builddir)/src/*/*.policy.in -_gl_translatable_string_re ?= \b(N?_|gettext *)\([^)"]*("|$$) +_gl_translatable_string_re ?= (^<policyconfig>|\b(N?_|gettext *)\([^)"]*("|$$)) # sc_po_check can fail if generated files are not built first sc_po_check: diff --git a/meson.build b/meson.build index 409a44b69c..65010dd6a8 100644 --- a/meson.build +++ b/meson.build @@ -15,6 +15,10 @@ if meson.version().version_compare('>=0.64.0') fs = import('fs') endif +i18n = import('i18n') + +po_dir = meson.source_root() / 'po' + # figure out if we are building from git git = run_command('test', '-e', '.git', check: false).returncode() == 0 diff --git a/po/POTFILES b/po/POTFILES index 6100341330..484b34c3df 100644 --- a/po/POTFILES +++ b/po/POTFILES @@ -1,6 +1,7 @@ src/access/viraccessapicheck.c src/access/viraccessapichecklxc.c src/access/viraccessapicheckqemu.c +src/access/org.libvirt.api.policy.in src/admin/admin_client.h src/admin/admin_server_dispatch_stubs.h src/remote/remote_client_bodies.h @@ -201,6 +202,7 @@ src/qemu/qemu_validate.c src/qemu/qemu_vhost_user.c src/qemu/qemu_vhost_user_gpu.c src/qemu/qemu_virtiofs.c +src/remote/libvirtd.policy.in src/remote/remote_daemon.c src/remote/remote_daemon_config.c src/remote/remote_daemon_dispatch.c diff --git a/po/meson.build b/po/meson.build index 126eeabe17..0f00b4830e 100644 --- a/po/meson.build +++ b/po/meson.build @@ -1,5 +1,3 @@ -i18n = import('i18n') - i18n.gettext( meson.project_name(), args: [ @@ -18,7 +16,7 @@ i18n.gettext( ) potfiles_dep = [ - access_gen_sources, + access_generated, admin_client_generated, admin_driver_generated, remote_protocol_generated, diff --git a/src/access/meson.build b/src/access/meson.build index c006ca5934..0cc9cf2b79 100644 --- a/src/access/meson.build +++ b/src/access/meson.build @@ -17,6 +17,7 @@ access_gen_headers = [] access_gen_sources = [] access_gen_sym = [] access_gen_xml = [] +access_generated = [] foreach name : [ 'remote', 'qemu', 'lxc' ] if name == 'remote' @@ -66,18 +67,29 @@ if conf.has('WITH_POLKIT') access_sources += access_polkit_sources if conf.has('WITH_LIBVIRTD') - custom_target( - 'org.libvirt.api.policy', + polgen = custom_target( + 'org.libvirt.api.policy.in', input: access_perm_h, - output: 'org.libvirt.api.policy', + output: 'org.libvirt.api.policy.in', command: [ meson_python_prog, python3_prog, genpolkit_prog, '@INPUT@' ], capture: true, + build_by_default: true, + ) + access_generated += polgen + + i18n.merge_file( + input: polgen, + output: 'org.libvirt.api.policy', + po_dir: po_dir, + data_dirs: [po_dir], install: true, install_dir: polkitactionsdir, ) endif endif +access_generated += access_gen_sources + virt_access_lib = static_library( 'virt_access', [ diff --git a/src/remote/libvirtd.policy b/src/remote/libvirtd.policy.in similarity index 100% rename from src/remote/libvirtd.policy rename to src/remote/libvirtd.policy.in diff --git a/src/remote/meson.build b/src/remote/meson.build index 9a0288f928..ea063ed6cc 100644 --- a/src/remote/meson.build +++ b/src/remote/meson.build @@ -294,11 +294,15 @@ if conf.has('WITH_REMOTE') endif if conf.has('WITH_POLKIT') - install_data( - 'libvirtd.policy', + i18n.merge_file( + input: 'libvirtd.policy.in', + output: 'org.libvirt.unix.policy', + po_dir: po_dir, + data_dirs: [po_dir], + install: true, install_dir: polkitactionsdir, - rename: [ 'org.libvirt.unix.policy' ], ) + install_data( 'libvirtd.rules', install_dir: polkitrulesdir, -- 2.47.1
On a Friday in 2025, Daniel P. Berrangé wrote:
There was a proposal
https://gitlab.com/libvirt/libvirt/-/merge_requests/387
to add translations for the polkit files. In reviewing this we came to the conclusion the approach was undesirable. After getting misled by a Debian/Ubuntu specific downstream only patch to polkit which auto-translated polkit files at runtime, this implements the manual approach of merging translations into the polkit files at build time.
Changed in v2:
- Fix introduction of 'polkitactionsdir' - Also introduce 'polkitrulesdir' - Fix syntax check rules for POFILES with generated polkit - Remove incorrect 'install: true' rule for policy.in file
Daniel P. Berrangé (3): po: add its rules for translating polkit file strings meson: remove duplication of polkit dirs construction remote: apply translations to polkit files
build-aux/syntax-check.mk | 5 +++-- meson.build | 6 ++++++ po/POTFILES | 2 ++ po/its/polkit.its | 8 ++++++++ po/its/polkit.loc | 6 ++++++ po/meson.build | 5 ++--- src/access/meson.build | 20 +++++++++++++++---- .../{libvirtd.policy => libvirtd.policy.in} | 0 src/remote/meson.build | 15 ++++++++------ 9 files changed, 52 insertions(+), 15 deletions(-) create mode 100644 po/its/polkit.its create mode 100644 po/its/polkit.loc rename src/remote/{libvirtd.policy => libvirtd.policy.in} (100%)
Reviewed-by: Ján Tomko <jtomko@redhat.com> Jano
participants (2)
-
Daniel P. Berrangé -
Ján Tomko