# Copyright 2023-2024 VyOS maintainers and contributors <maintainers@vyos.io>
#
# 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/>.

# T5834: Rename 'enable-default-log' to 'default-log'
# From
    # set firewall ... filter enable-default-log
    # set firewall ... name <name> enable-default-log
# To
    # set firewall ... filter default-log
    # set firewall ... name <name> default-log

from vyos.configtree import ConfigTree

base = ['firewall']

def migrate(config: ConfigTree) -> None:
    if not config.exists(base):
        # Nothing to do
        return

    for family in ['ipv4', 'ipv6', 'bridge']:
        if config.exists(base + [family]):
            for hook in ['forward', 'input', 'output', 'name']:
                if config.exists(base + [family, hook]):
                    for priority in config.list_nodes(base + [family, hook]):
                        if config.exists(base + [family, hook, priority, 'enable-default-log']):
                            config.rename(base + [family, hook, priority, 'enable-default-log'], 'default-log')