9:59 a.m.
As part of an goal to eliminate Perl from libvirt build tools,
rewrite the genaclperms.pl tool in Python.
This was a straight conversion, manually going line-by-line to
change the syntax from Perl to Python. Thus the overall structure
of the file and approach is the same.
Signed-off-by: Daniel P. Berrangé <berrange(a)redhat.com>
---
docs/Makefile.am | 6 +--
docs/genaclperms.pl | 125 --------------------------------------------
docs/genaclperms.py | 123 +++++++++++++++++++++++++++++++++++++++++++
3 files changed, 126 insertions(+), 128 deletions(-)
delete mode 100755 docs/genaclperms.pl
create mode 100755 docs/genaclperms.py
diff --git a/docs/Makefile.am b/docs/Makefile.am
index b9d69db8c8..030f53db9a 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -163,7 +163,7 @@ schemadir = $(pkgdatadir)/schemas
schema_DATA = $(wildcard $(srcdir)/schemas/*.rng)
EXTRA_DIST= \
- apibuild.py genaclperms.pl \
+ apibuild.py genaclperms.py \
site.xsl subsite.xsl newapi.xsl page.xsl \
wrapstring.xsl \
$(dot_html) $(dot_html_in) $(gif) $(apihtml) $(apipng) \
@@ -178,8 +178,8 @@ EXTRA_DIST= \
acl_generated = aclperms.htmlinc
$(srcdir)/aclperms.htmlinc: $(top_srcdir)/src/access/viraccessperm.h \
- $(srcdir)/genaclperms.pl Makefile.am
- $(AM_V_GEN)$(PERL) $(srcdir)/genaclperms.pl $< > $@
+ $(srcdir)/genaclperms.py Makefile.am
+ $(AM_V_GEN)$(RUNUTF8) $(PYTHON) $(srcdir)/genaclperms.py $< > $@
MAINTAINERCLEANFILES = \
$(addprefix $(srcdir)/,$(dot_html)) \
diff --git a/docs/genaclperms.pl b/docs/genaclperms.pl
deleted file mode 100755
index e20b4c11c3..0000000000
--- a/docs/genaclperms.pl
+++ /dev/null
@@ -1,125 +0,0 @@
-#!/usr/bin/env perl
-#
-# Copyright (C) 2013 Red Hat, Inc.
-#
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License, or (at your option) any later version.
-#
-# This library 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
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library. If not, see
-# <http://www.gnu.org/licenses/>;.
-#
-
-use strict;
-use warnings;
-
-my @objects = (
- "CONNECT", "DOMAIN", "INTERFACE",
- "NETWORK_PORT", "NETWORK", "NODE_DEVICE",
- "NWFILTER_BINDING", "NWFILTER",
- "SECRET", "STORAGE_POOL", "STORAGE_VOL",
- );
-
-my %class;
-
-foreach my $object (@objects) {
- my $class = lc $object;
-
- $class =~ s/(^\w|_\w)/uc $1/eg;
- $class =~ s/_//g;
- $class =~ s/Nwfilter/NWFilter/;
- $class = "vir" . $class . "Ptr";
-
- $class{$object} = $class;
-}
-
-my $objects = join ("|", @objects);
-
-my %opts;
-my $in_opts = 0;
-
-my %perms;
-
-while (<>) {
- if ($in_opts) {
- if (m,\*/,) {
- $in_opts = 0;
- } elsif (/\*\s*\@(\w+):\s*(.*?)\s*$/) {
- $opts{$1} = $2;
- }
- } elsif (m,/\*\*,) {
- $in_opts = 1;
- } elsif (/VIR_ACCESS_PERM_($objects)_((?:\w|_)+),/) {
- my $object = $1;
- my $perm = lc $2;
- next if $perm eq "last";
-
- $perm =~ s/_/-/g;
-
- $perms{$object} = {} unless exists $perms{$object};
- $perms{$object}->{$perm} = {
- desc => $opts{desc},
- message => $opts{message},
- anonymous => $opts{anonymous}
- };
- %opts = ();
- }
-}
-
-print <<EOF;
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
- <body>
-EOF
-
-foreach my $object (sort { $a cmp $b } keys %perms) {
- my $class = $class{$object};
- my $olink = lc "object_" . $object;
- print <<EOF;
-<h3><a id="$olink">$class</a></h3>
-<table class="acl">
- <thead>
- <tr>
- <th>Permission</th>
- <th>Description</th>
- </tr>
- </thead>
- <tbody>
-EOF
-
- foreach my $perm (sort { $a cmp $b } keys %{$perms{$object}}) {
- my $description = $perms{$object}->{$perm}->{desc};
-
- die "missing description for $object.$perm" unless
- defined $description;
-
- my $plink = lc "perm_" . $object . "_" . $perm;
- $plink =~ s/-/_/g;
-
- print <<EOF;
- <tr>
- <td><a id="$plink">$perm</a></td>
- <td>$description</td>
- </tr>
-EOF
-
- }
-
- print <<EOF;
- </tbody>
-</table>
-EOF
-}
-
-print <<EOF;
- </body>
-</html>
-EOF
diff --git a/docs/genaclperms.py b/docs/genaclperms.py
new file mode 100755
index 0000000000..1d3188062f
--- /dev/null
+++ b/docs/genaclperms.py
@@ -0,0 +1,123 @@
+#!/usr/bin/env python
+#
+# Copyright (C) 2013-2019 Red Hat, Inc.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library. If not, see
+# <http://www.gnu.org/licenses/>;.
+#
+
+from __future__ import print_function
+
+import re
+import sys
+
+objects = [
+ "CONNECT", "DOMAIN", "INTERFACE",
+ "NETWORK_PORT", "NETWORK", "NODE_DEVICE",
+ "NWFILTER_BINDING", "NWFILTER",
+ "SECRET", "STORAGE_POOL", "STORAGE_VOL",
+]
+
+
+classes = {}
+
+for obj in objects:
+ klass = obj.lower()
+
+ klass = re.sub(r'''(^\w|_\w)''', lambda a:
a.group(1).upper(), klass)
+ klass = klass.replace("_", "")
+ klass = klass.replace("Nwfilter", "NWFilter")
+ klass = "vir" + klass + "Ptr"
+
+ classes[obj] = klass
+
+
+objectstr = "|".join(objects)
+
+opts = {}
+in_opts = {}
+
+perms = {}
+
+aclfile = sys.argv[1]
+with open(aclfile, "r") as fh:
+ for line in fh:
+ if in_opts:
+ if line.find("*/") != -1:
+ in_opts = False
+ else:
+ m = re.match(r'''.*\*\s*\@(\w+):\s*(.*?)\s*$''',
line)
+ if m is not None:
+ opts[m.group(1)] = m.group(2)
+ elif line.find("**") != -1:
+ in_opts = True
+ else:
+ m =
re.match(r'''.*VIR_ACCESS_PERM_(%s)_((?:\w|_)+),''' %
+ objectstr, line)
+ if m is not None:
+ obj = m.group(1)
+ perm = m.group(2).lower()
+ if perm == "last":
+ continue
+
+ perm = perm.replace("_", "-")
+
+ if obj not in perms:
+ perms[obj] = {}
+ perms[obj][perm] = {
+ "desc": opts.get("desc", None),
+ "message": opts.get("message", None),
+ "anonymous": opts.get("anonymous", None),
+ }
+ opts = {}
+
+print('<?xml version="1.0" encoding="UTF-8"?>')
+print('<!DOCTYPE html>')
+print('<html xmlns="http://www.w3.org/1999/xhtml">')
+print(' <body>')
+
+for obj in sorted(perms.keys()):
+ klass = classes[obj]
+
+ olink = "object_" + obj.lower()
+
+ print(' <h3><a id="%s">%s</a></h3>' %
(olink, klass))
+ print(' <table class="acl">')
+ print(' <thead>')
+ print(' <tr>')
+ print(' <th>Permission</th>')
+ print(' <th>Description</th>')
+ print(' </tr>')
+ print(' </thead>')
+ print(' <tbody>')
+
+ for perm in sorted(perms[obj].keys()):
+ description = perms[obj][perm]["desc"]
+
+ if description is None:
+ raise Exception("missing description for %s.%s" % (obj, perm))
+
+ plink = "perm_" + obj.lower() + "_" + perm.lower()
+ plink = plink.replace("-", "_")
+
+ print(' <tr>')
+ print(' <td><a
id="%s">%s</a></td>' % (plink, perm))
+ print(' <td>%s</td>' % description)
+ print(' </tr>')
+
+ print(' </tbody>')
+ print(' </table>')
+
+print(' </body>')
+print('</html>')
--
2.21.0