Merge pull request #4711 from jestabro/interstitial-set

T7737: add vyconf-aware analogue of configfs

Author: dmbaturin

libvyosconfig/Makefile

@@ -42,8 +42,8 @@ all: sharedlib
 PHONY: depends
 depends:
 	sudo sh -c 'eval $$(opam env --root=/opt/opam --set-root) ;\
-		opam pin add vyos1x-config https://github.com/vyos/vyos1x-config.git#b53326dce7dd2dabad2677ad82de4fcd4ea85524 -y ; \
-		opam pin add vyconf https://github.com/vyos/vyconf.git#2da0981501a9bec8b69d29f1e52c10db90571aa4 -y'
+		opam pin add vyos1x-config https://github.com/vyos/vyos1x-config.git#ff247fe83f4b24b5ed977ac9b04fb5fe19b196f0 -y ; \
+		opam pin add vyconf https://github.com/vyos/vyconf.git#304e4d2a172fe1baf2c1df7f61b7a0a8e40f7d5d -y'
 
 sharedlib: depends $(BUILDDIR)/libvyosconfig$(EXTDLL)
 

python/vyos/configsession.py

@@ -181,7 +181,9 @@ def __init__(self, session_id, app=APP, shared=False):
         for k, v in env_list:
             session_env[k] = v
 
-        session_env['CONFIGSESSION_PID'] = str(session_id)
+        # replaces ambient instance of SESSION_PID,
+        # for use when running from a non-shared configsession
+        session_env['SESSION_PID'] = str(session_id)
 
         self.__session_env = session_env
         self.__session_env['COMMIT_VIA'] = app

python/vyos/configsource.py

@@ -326,10 +326,11 @@ def __init__(self, session_env=None):
         else:
             self.__session_env = None
 
-        if session_env and 'CONFIGSESSION_PID' in session_env:
-            self.pid = int(session_env['CONFIGSESSION_PID'])
+        if session_env and 'SESSION_PID' in session_env:
+            self.pid = int(session_env['SESSION_PID'])
         else:
-            self.pid = os.getppid()
+            pid = os.environ.get('SESSION_PID', '')
+            self.pid = int(pid) if pid else os.getppid()
 
         self._vyconf_session = VyconfSession(pid=self.pid)
         try:

python/vyos/proto/vycall_pb2.py

@@ -28,25 +28,27 @@ class Prompt:
 
 @dataclass
 class SetupSession:
-    ClientPid: int = 0
-    ClientApplication: str = None
-    OnBehalfOf: int = None
+    client_pid: int = 0
+    client_application: str = None
+    on_behalf_of: int = None
+    client_user: str = None
+    client_sudo_user: str = None
 
 @dataclass
 class SessionOfPid:
-    ClientPid: int = 0
+    client_pid: int = 0
 
 @dataclass
-class SessionUpdatePid:
-    ClientPid: int = 0
+class SessionExists:
+    dummy: int = None
 
 @dataclass
 class GetConfig:
     dummy: int = None
 
 @dataclass
 class Teardown:
-    OnBehalfOf: int = None
+    on_behalf_of: int = None
 
 @dataclass
 class Validate:
@@ -55,11 +57,23 @@ class Validate:
 
 @dataclass
 class Set:
-    Path: list[str] = field(default_factory=list)
+    path: list[str] = field(default_factory=list)
 
 @dataclass
 class Delete:
-    Path: list[str] = field(default_factory=list)
+    path: list[str] = field(default_factory=list)
+
+@dataclass
+class AuxSet:
+    path: list[str] = field(default_factory=list)
+    script_name: str = ""
+    tag_value: str = None
+
+@dataclass
+class AuxDelete:
+    path: list[str] = field(default_factory=list)
+    script_name: str = ""
+    tag_value: str = None
 
 @dataclass
 class Discard:
@@ -71,76 +85,76 @@ class SessionChanged:
 
 @dataclass
 class Rename:
-    EditLevel: list[str] = field(default_factory=list)
-    From: str = ""
-    To: str = ""
+    edit_level: list[str] = field(default_factory=list)
+    source: str = ""
+    destination: str = ""
 
 @dataclass
 class Copy:
-    EditLevel: list[str] = field(default_factory=list)
-    From: str = ""
-    To: str = ""
+    edit_level: list[str] = field(default_factory=list)
+    source: str = ""
+    destination: str = ""
 
 @dataclass
 class Comment:
-    Path: list[str] = field(default_factory=list)
-    Comment: str = ""
+    path: list[str] = field(default_factory=list)
+    comment: str = ""
 
 @dataclass
 class Commit:
-    Confirm: bool = None
-    ConfirmTimeout: int = None
-    Comment: str = None
-    DryRun: bool = None
+    confirm: bool = None
+    confirm_timeout: int = None
+    comment: str = None
+    dry_run: bool = None
 
 @dataclass
 class Rollback:
-    Revision: int = 0
+    revision: int = 0
 
 @dataclass
 class Load:
-    Location: str = ""
+    location: str = ""
     cached: bool = False
     format: ConfigFormat = None
 
 @dataclass
 class Merge:
-    Location: str = ""
+    location: str = ""
     destructive: bool = False
     format: ConfigFormat = None
 
 @dataclass
 class Save:
-    Location: str = ""
+    location: str = ""
     format: ConfigFormat = None
 
 @dataclass
 class ShowConfig:
-    Path: list[str] = field(default_factory=list)
+    path: list[str] = field(default_factory=list)
     format: ConfigFormat = None
 
 @dataclass
 class Exists:
-    Path: list[str] = field(default_factory=list)
+    path: list[str] = field(default_factory=list)
 
 @dataclass
 class GetValue:
-    Path: list[str] = field(default_factory=list)
+    path: list[str] = field(default_factory=list)
     output_format: OutputFormat = None
 
 @dataclass
 class GetValues:
-    Path: list[str] = field(default_factory=list)
+    path: list[str] = field(default_factory=list)
     output_format: OutputFormat = None
 
 @dataclass
 class ListChildren:
-    Path: list[str] = field(default_factory=list)
+    path: list[str] = field(default_factory=list)
     output_format: OutputFormat = None
 
 @dataclass
 class RunOpMode:
-    Path: list[str] = field(default_factory=list)
+    path: list[str] = field(default_factory=list)
     output_format: OutputFormat = None
 
 @dataclass
@@ -149,16 +163,16 @@ class Confirm:
 
 @dataclass
 class EnterConfigurationMode:
-    Exclusive: bool = False
-    OverrideExclusive: bool = False
+    exclusive: bool = False
+    override_exclusive: bool = False
 
 @dataclass
 class ExitConfigurationMode:
     pass
 
 @dataclass
 class ReloadReftree:
-    OnBehalfOf: int = None
+    on_behalf_of: int = None
 
 @dataclass
 class Request:
@@ -189,8 +203,10 @@ class Request:
     discard: Discard = None
     session_changed: SessionChanged = None
     session_of_pid: SessionOfPid = None
-    session_update_pid: SessionUpdatePid = None
+    session_exists: SessionExists = None
     get_config: GetConfig = None
+    aux_set: AuxSet = None
+    aux_delete: AuxDelete = None
 
 @dataclass
 class RequestEnvelope:
@@ -210,8 +226,8 @@ def set_request_prompt(token: str = None):
     req_env = RequestEnvelope(token, req)
     return req_env
 
-def set_request_setup_session(token: str = None, client_pid: int = 0, client_application: str = None, on_behalf_of: int = None):
-    reqi = SetupSession (client_pid, client_application, on_behalf_of)
+def set_request_setup_session(token: str = None, client_pid: int = 0, client_application: str = None, on_behalf_of: int = None, client_user: str = None, client_sudo_user: str = None):
+    reqi = SetupSession (client_pid, client_application, on_behalf_of, client_user, client_sudo_user)
     req = Request(setup_session=reqi)
     req_env = RequestEnvelope(token, req)
     return req_env
@@ -222,9 +238,9 @@ def set_request_session_of_pid(token: str = None, client_pid: int = 0):
     req_env = RequestEnvelope(token, req)
     return req_env
 
-def set_request_session_update_pid(token: str = None, client_pid: int = 0):
-    reqi = SessionUpdatePid (client_pid)
-    req = Request(session_update_pid=reqi)
+def set_request_session_exists(token: str = None, dummy: int = None):
+    reqi = SessionExists (dummy)
+    req = Request(session_exists=reqi)
     req_env = RequestEnvelope(token, req)
     return req_env
 
@@ -258,6 +274,18 @@ def set_request_delete(token: str = None, path: list[str] = []):
     req_env = RequestEnvelope(token, req)
     return req_env
 
+def set_request_aux_set(token: str = None, path: list[str] = [], script_name: str = "", tag_value: str = None):
+    reqi = AuxSet (path, script_name, tag_value)
+    req = Request(aux_set=reqi)
+    req_env = RequestEnvelope(token, req)
+    return req_env
+
+def set_request_aux_delete(token: str = None, path: list[str] = [], script_name: str = "", tag_value: str = None):
+    reqi = AuxDelete (path, script_name, tag_value)
+    req = Request(aux_delete=reqi)
+    req_env = RequestEnvelope(token, req)
+    return req_env
+
 def set_request_discard(token: str = None, dummy: int = None):
     reqi = Discard (dummy)
     req = Request(discard=reqi)
@@ -270,14 +298,14 @@ def set_request_session_changed(token: str = None, dummy: int = None):
     req_env = RequestEnvelope(token, req)
     return req_env
 
-def set_request_rename(token: str = None, edit_level: list[str] = [], from_: str = "", to: str = ""):
-    reqi = Rename (edit_level, from_, to)
+def set_request_rename(token: str = None, edit_level: list[str] = [], source: str = "", destination: str = ""):
+    reqi = Rename (edit_level, source, destination)
     req = Request(rename=reqi)
     req_env = RequestEnvelope(token, req)
     return req_env
 
-def set_request_copy(token: str = None, edit_level: list[str] = [], from_: str = "", to: str = ""):
-    reqi = Copy (edit_level, from_, to)
+def set_request_copy(token: str = None, edit_level: list[str] = [], source: str = "", destination: str = ""):
+    reqi = Copy (edit_level, source, destination)
     req = Request(copy=reqi)
     req_env = RequestEnvelope(token, req)
     return req_env

python/vyos/proto/vyconf_pb2.py

@@ -13,25 +13,57 @@
 # 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/>.
 
+# pylint: disable=import-outside-toplevel
+
 import os
 
+from vyos.utils.backend import vyconf_backend
+from vyos.utils.boot import boot_configuration_complete
+
+
 def delete_cli_node(cli_path: list):
-    from shutil import rmtree
-    for config_dir in ['VYATTA_TEMP_CONFIG_DIR', 'VYATTA_CHANGES_ONLY_DIR']:
-        tmp = os.path.join(os.environ[config_dir], '/'.join(cli_path))
-        # delete CLI node
-        if os.path.exists(tmp):
-            rmtree(tmp)
-
-def add_cli_node(cli_path: list, value: str=None):
-    from vyos.utils.auth import get_current_user
-    from vyos.utils.file import write_file
-
-    current_user = get_current_user()
-    for config_dir in ['VYATTA_TEMP_CONFIG_DIR', 'VYATTA_CHANGES_ONLY_DIR']:
-        # store new value
-        tmp = os.path.join(os.environ[config_dir], '/'.join(cli_path))
-        write_file(f'{tmp}/node.val', value, user=current_user, group='vyattacfg', mode=0o664)
-        # mark CLI node as modified
-        if config_dir == 'VYATTA_CHANGES_ONLY_DIR':
-            write_file(f'{tmp}/.modified', '', user=current_user, group='vyattacfg', mode=0o664)
+    if vyconf_backend() and boot_configuration_complete():
+        # pylint: disable=redefined-outer-name
+        from vyos.utils.session import delete_cli_node
+
+        delete_cli_node(cli_path)
+    else:
+        from shutil import rmtree
+
+        for config_dir in ['VYATTA_TEMP_CONFIG_DIR', 'VYATTA_CHANGES_ONLY_DIR']:
+            tmp = os.path.join(os.environ[config_dir], '/'.join(cli_path))
+            # delete CLI node
+            if os.path.exists(tmp):
+                rmtree(tmp)
+
+
+def add_cli_node(cli_path: list, value: str = None):
+    if vyconf_backend() and boot_configuration_complete():
+        # pylint: disable=redefined-outer-name
+        from vyos.utils.session import add_cli_node
+
+        add_cli_node(cli_path, value)
+    else:
+        from vyos.utils.auth import get_current_user
+        from vyos.utils.file import write_file
+
+        current_user = get_current_user()
+        for config_dir in ['VYATTA_TEMP_CONFIG_DIR', 'VYATTA_CHANGES_ONLY_DIR']:
+            # store new value
+            tmp = os.path.join(os.environ[config_dir], '/'.join(cli_path))
+            write_file(
+                f'{tmp}/node.val',
+                value,
+                user=current_user,
+                group='vyattacfg',
+                mode=0o664,
+            )
+            # mark CLI node as modified
+            if config_dir == 'VYATTA_CHANGES_ONLY_DIR':
+                write_file(
+                    f'{tmp}/.modified',
+                    '',
+                    user=current_user,
+                    group='vyattacfg',
+                    mode=0o664,
+                )