[pve-devel] [RFC PATCH guest-common 1/1] add profiles section config plugin

[Dominik Csapak <d.csapak@proxmox.com>]

this is intended to house custom profiles which can be used
on guest creation instead of manually needing to specify every option.

we do special things here:
* we always set 'allow_unknown' to 1, because when using the guest
  specific parts in the cli, we cannot depend on the other one, else
  we'd get a cyclic dependency, and without that we need to ignore
  unknown sections

* we'll prefix the options with the type, so that there is not a
  conflict, (e.g. net0 on ct vs net0 on vm has a different format)
  but we resolve that transparently on parse and write, so that
  the consumer doesn't have to do it themselves

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---
 src/Makefile               |  2 ++
 src/PVE/Profiles/Plugin.pm | 72 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 74 insertions(+)
 create mode 100644 src/PVE/Profiles/Plugin.pm

diff --git a/src/Makefile b/src/Makefile
index cbc40c1..d99645c 100644
--- a/src/Makefile
+++ b/src/Makefile
@@ -17,6 +17,8 @@ install: PVE
 	install -d ${PERL5DIR}/PVE/Mapping
 	install -m 0644 PVE/Mapping/PCI.pm ${PERL5DIR}/PVE/Mapping/
 	install -m 0644 PVE/Mapping/USB.pm ${PERL5DIR}/PVE/Mapping/
+	install -d ${PERL5DIR}/PVE/Profiles
+	install -m 0644 PVE/Profiles/Plugin.pm ${PERL5DIR}/PVE/Profiles/
 	install -d ${PERL5DIR}/PVE/VZDump
 	install -m 0644 PVE/VZDump/Plugin.pm ${PERL5DIR}/PVE/VZDump/
 	install -m 0644 PVE/VZDump/Common.pm ${PERL5DIR}/PVE/VZDump/
diff --git a/src/PVE/Profiles/Plugin.pm b/src/PVE/Profiles/Plugin.pm
new file mode 100644
index 0000000..8ec5054
--- /dev/null
+++ b/src/PVE/Profiles/Plugin.pm
@@ -0,0 +1,72 @@
+package PVE::Profiles::Plugin;
+
+use strict;
+use warnings;
+
+use PVE::Cluster qw(cfs_register_file);
+use PVE::SectionConfig;
+
+use base qw(PVE::SectionConfig);
+
+cfs_register_file ('virtual-guest/profiles.cfg',
+		   sub { __PACKAGE__->parse_config(@_); },
+		   sub { __PACKAGE__->write_config(@_); });
+
+my $defaultData = {
+    propertyList => {
+	type => { description => 'Profile type.' },
+	id => {
+	    type => 'string',
+	    description => "The ID of the profile.",
+	    format => 'pve-configid',
+	},
+    },
+};
+
+sub private {
+    return $defaultData;
+}
+
+
+# on parse/write we map the configs from {type}_{prop} to {prop}
+# so that the consumers can simply use it but we can
+# have e.g. a ct_net0 and vm_net0
+sub parse_config {
+    my ($class, $filename, $raw, $allow_unknown) = @_;
+
+    # always allow unknown, so that qemu-server/pct-container
+    # can parse the file without loading the other plugin type
+    my $cfg = $class->SUPER::parse_config($filename, $raw, 1);
+    for my $id (keys $cfg->{ids}->%*) {
+	my $entry = $cfg->{ids}->{$id};
+	my $type = $entry->{type};
+	for my $opt (keys $entry->%*) {
+	    next if $opt eq 'type';
+	    if ($opt =~ m/^${type}_(.*)$/) {
+		my $newopt = $1;
+		$entry->{$newopt} = delete $entry->{$opt};
+	    }
+	}
+    }
+
+    return $cfg;
+}
+
+sub write_config {
+    my ($class, $filename, $cfg, $allow_unknown) = @_;
+
+    for my $id (keys $cfg->{ids}->%*) {
+	my $entry = $cfg->{ids}->{$id};
+	my $type = $entry->{type};
+	for my $opt (keys $entry->%*) {
+	    next if $opt eq 'type';
+	    next if $opt =~ m/^${type}_/; # skip already prefixed options
+	    my $newopt = "${type}_${opt}";
+	    $entry->{$newopt} = delete $entry->{$opt};
+	}
+    }
+
+    return $class->SUPER::write_config($filename, $cfg, $allow_unknown);
+}
+
+1;
-- 
2.30.2