all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Fiona Ebner <f.ebner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [RFC cluster 2/2] cluster files: support registering UTF-8 configuration file
Date: Tue, 18 Feb 2025 13:30:06 +0100	[thread overview]
Message-ID: <20250218123006.61691-3-f.ebner@proxmox.com> (raw)
In-Reply-To: <20250218123006.61691-1-f.ebner@proxmox.com>

A configuration file registered as UTF-8 will be automatically decoded
from UTF-8 to Perl's internal string format after reading and encoded
in the other direction before writing.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
---

Tested a bit with the virtiofs directory mapping config opting into
this, which could be an initial user of this feature.

 src/PVE/Cluster.pm | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/src/PVE/Cluster.pm b/src/PVE/Cluster.pm
index b9311c7..fe1601e 100644
--- a/src/PVE/Cluster.pm
+++ b/src/PVE/Cluster.pm
@@ -519,7 +519,7 @@ sub verify_token {
 my $file_info = {};
 
 sub cfs_register_file {
-    my ($filename, $parser, $writer) = @_;
+    my ($filename, $parser, $writer, $utf8) = @_;
 
     $observed->{$filename} || die "unknown file '$filename'";
 
@@ -528,11 +528,12 @@ sub cfs_register_file {
     $file_info->{$filename} = {
 	parser => $parser,
 	writer => $writer,
+	utf8 => $utf8,
     };
 }
 
 my $ccache_read = sub {
-    my ($filename, $parser, $version) = @_;
+    my ($filename, $parser, $version, $utf8) = @_;
 
     $ccache->{$filename} = {} if !$ccache->{$filename};
 
@@ -542,6 +543,7 @@ my $ccache_read = sub {
 	# we always call the parser, even when the file does not exist
 	# (in that case $data is undef)
 	my $data = get_config($filename);
+	$data = decode('utf8', $data) if $utf8;
 	$ci->{data} = &$parser("/etc/pve/$filename", $data);
 	$ci->{version} = $version;
     }
@@ -579,7 +581,7 @@ sub cfs_read_file {
     my ($version, $info) = cfs_file_version($filename);
     my $parser = $info->{parser};
 
-    return &$ccache_read($filename, $parser, $version);
+    return &$ccache_read($filename, $parser, $version, $info->{utf8});
 }
 
 sub cfs_write_file {
@@ -597,6 +599,8 @@ sub cfs_write_file {
 	$ci->{version} = undef;
     }
 
+    $force_utf8 = 1 if $info->{utf8};
+
     PVE::Tools::file_set_contents($fsname, $raw, undef, $force_utf8);
 }
 
-- 
2.39.5



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel


      parent reply	other threads:[~2025-02-18 12:30 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-02-18 12:30 [pve-devel] [RFC common/cluster] " Fiona Ebner
2025-02-18 12:30 ` [pve-devel] [RFC common 1/2] section config: prepare for supporting UTF-8 encoded configurations Fiona Ebner
2025-02-18 12:30 ` Fiona Ebner [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250218123006.61691-3-f.ebner@proxmox.com \
    --to=f.ebner@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal