Use group (minimal GUI) defaults similarly to the user template

[pyi2ncommon] / src / cnfvar / templates.py

# The software in this package is distributed under the GNU General
# Public License version 2 (with a special exception described below).
#
# A copy of GNU General Public License (GPL) is included in this distribution,
# in the file COPYING.GPL.
#
# As a special exception, if other files instantiate templates or use macros
# or inline functions from this file, or you compile this file and link it
# with other works to produce a work based on this file, this file
# does not by itself cause the resulting work to be covered
# by the GNU General Public License.
#
# However the source code for this file must still be made available
# in accordance with section (3) of the GNU General Public License.
#
# This exception does not invalidate any other reasons why a work based
# on this file might be covered by the GNU General Public License.
#
# Copyright (c) 2016-2018 Intra2net AG <info@intra2net.com>

"""

summary
------------------------------------------------------
Module for one-step dynamic cnfvar generation from default value templates.

.. codeauthor:: Intra2net


contents
-------------------------------------------------------
These templates contain the bare defaults the UI adds upon
creation of each major and frequently used cnfvar.


interface
------------------------------------------------------

"""

import time
import logging

# custom imports
from .model import Cnf, CnfList


log = logging.getLogger('pyi2ncommon.cnfvar.templates')


###############################################################################
# MAJOR CNF DEFAULTS
###############################################################################


#: UI defaults for a user instance
user_defaults = {
    "USER_DISABLED": "0",
    "USER_FULLNAME": "",
    "USER_GROUPWARE_FOLDER_CALENDAR": "INBOX/Calendar",
    "USER_GROUPWARE_FOLDER_CONTACTS": "INBOX/Contacts",
    "USER_GROUPWARE_FOLDER_DRAFTS": "INBOX/Drafts",
    "USER_GROUPWARE_FOLDER_NOTES": "INBOX/Notes",
    "USER_GROUPWARE_FOLDER_OUTBOX": "INBOX/Sent Items",
    "USER_GROUPWARE_FOLDER_TASKS": "INBOX/Tasks",
    "USER_GROUPWARE_FOLDER_TRASH": "INBOX/Deleted Items",
    # always a member of the 'Alle' group
    "USER_GROUP_MEMBER_REF": "2",
    "USER_LOCALE": "",
    "USER_PASSWORD": "test1234",
    "USER_TRASH_DELETEDAYS": "30",
    "USER_WEBMAIL_MESSAGES_PER_PAGE": "25",
    "USER_WEBMAIL_SIGNATURE": "",
}
#: UI defaults for a group instance
group_defaults = {
    "GROUP_COMMENT": "",
    "GROUP_ACCESS_GO_ONLINE_ALLOWED": "1",
    "GROUP_EMAILFILTER_BAN_FILTERLIST_REF": "-1",
    "GROUP_EMAIL_RELAY_RIGHTS": "RELAY_FROM_INTRANET",
    "GROUP_PROXY_PROFILE_REF": "1",
}



###############################################################################
# MINOR CONFIGURATION
###############################################################################


def template(name, value, instance=-1, defaults=None, **kwargs):
    """
    Generate a template cnf variable from provided defaults.

    :param str name: cnf variable name
    :param str value: cnf variable data value
    :param int instance: cnf variable instance number
    :param defaults: default child variables to populate the cnf variable with
    :type defaults: {str, str or {}} or None
    :returns: generated cnf variable
    :rtype: :py:class:`Cnf`

    All additional keyword arguments will be used to overwrite the defaults.
    """
    log.info(f"Generating a template {name} cnfvar")
    cnf = Cnf(name, value=value, instance=instance)
    defaults = {} if defaults is None else defaults
    cnf.add_children(*[(key, value) for key, value in defaults.items()])
    for key in kwargs.keys():
        cnf.children.single_with_name(f"{name}_{key}").value = kwargs[key]
    return cnf


def user(name, password, instance=-1, **kwargs):
    """
    Generate a user cnf variable.

    :param str name: username for the user
    :param str password: password for the user
    :param int instance: instance number for the user
    :returns: generated cnf variable
    :rtype: :py:class:`Cnf`
    """
    log.info(f"Generating a user {name} cnfvar")
    user_cnf = template("user", name, instance=instance, defaults=user_defaults, **kwargs)
    user_cnf.children.single_with_name("user_fullname").value = name.capitalize()
    user_cnf.children.single_with_name("user_password").value = password
    return user_cnf


def group(name, instance=-1, **kwargs):
    """
    Generate a group cnf variable.

    :param str name: name for the group
    :param int instance: instance number for the group
    :returns: generated cnf variable
    :rtype: :py:class:`Cnf`
    """
    log.info(f"Generating a group {name} cnfvar")
    group_cnf = template("group", name, instance=instance, defaults=group_defaults, **kwargs)
    return group_cnf


def nic(instance=0, nictype="NATLAN",
        ip="1.2.3.4", netmask="255.255.0.0", mac="00:00:00:00:00:00",
        suffix="host"):
    """
    Generate and save a nic configuration file.

    :param int instance: instance number (for multiple nics, -1 for next available)
    :param str nictype: type of the nic
    :param str ip: IP address of the nic
    :param str netmask: network mask of the nic
    :param str mac: MAC address of the nic
    :param str suffix: optional suffix to use for config identification
    :returns: generated config filename
    :rtype: str
    """
    log.info("Create arnied nic configuration")
    nic_obj = batch_update_cnf(
        build_nic.BuildNIC(data="", instance=instance, line_no=1),
        [(Update, ("NIC_TYPE", 0, nictype)),
         (Update, ("NIC_LAN_IP", 0, ip)),
         (Update, ("NIC_LAN_NETMASK", 0, netmask)),
         (Update, ("NIC_MAC", 0, mac))])
    nic_cnf = "nic-%d-%s.cnf" % (time.time(), suffix)
    [nic_cnf] = aw.prep_config_paths([nic_cnf], aw.DUMP_CONFIG_DIR)
    logging.info("Saving nic configuration to %s", nic_cnf)
    nic_obj.save(nic_cnf)
    return nic_cnf


def intraclient(name="intraclient", instance=1,
                ip="1.2.3.4", mac="00:00:00:00:00:00",
                fwrules=5, suffix="host"):
    """
    Generate and save an intraclient configuration file.

    :param str name: name of the intraclient
    :param int instance: instance number (for multiple clients, -1 for next available)
    :param str ip: IP address of the intraclient
    :param str mac: MAC address of the intraclient
    :param int fwrules: instance of the firewall rules to use
    :param str suffix: optional suffix to use for config identification
    :returns: generated config filename
    :rtype: str
    """
    log.info("Create arnied intraclient configuration")
    intraclient_obj = batch_update_cnf(
        build_intraclient.BuildIntraclient(data=name, instance=instance),
        [(Update, ("INTRACLIENT_IP", 0, ip)),
         (Update, ("INTRACLIENT_MAC", 0, mac)),
         (Update, ("INTRACLIENT_FIREWALL_RULESET_REF", 0, fwrules))])

    intraclient_cnf = "intraclient-%d-%s.cnf" % (time.time(), suffix)
    [intraclient_cnf] = aw.prep_config_paths([intraclient_cnf], aw.DUMP_CONFIG_DIR)
    logging.info("Saving intraclient configuration to %s", intraclient_cnf)
    intraclient_obj.save(intraclient_cnf)
    return intraclient_cnf


def provider(name="provider", instance=1, mode="ROUTER", ip="1.2.3.4", localip=None,
             netmask="255.255.0.0", dnsmode="IP", dns="1.2.3.4", fwrules=5,
             dialretry=None, timeout="", mtumode="AUTO",
             vlanid=None, mtusize=None, login=None, password=None,
             modemip=None, providerid=None, localdhcp=None,
             suffix="host"):
    """
    Generate and save a provider configuration file.

    :param str name: name of the provider
    :param int instance: instance number (for multiple clients, -1 for next available)
    :param str mode: provider mode
    :param str ip: IP address of the provider
    :param localip: IP address of the configured machine (valid for some configurations)
    :type localip: str or None
    :param str netmask: netmask of the provider
    :param str dnsmode: dnsmode of the provider
    :param str dns: IP address of the DNS server
    :param int fwrules: instance of the firewall rules to use
    :param any args: lots of detailed configuration
    :param str suffix: optional suffix to use for config identification
    :returns: generated config filename
    :rtype: str
    """
    log.info("Create arnied provider configuration")

    def add_or_del(var, field):
        if var is not None:
            return Add, (field, 0, str(var))
        return Delete, field
    provider_obj = batch_update_cnf(
        build_provider.BuildProvider(data=name, instance=instance),
        [(Update, ("PROVIDER_MODE", 0, mode)),
         ip and (Update, ("PROVIDER_IP", 0, ip))
             or (Delete, "PROVIDER_IP"),
         localip
         and (Update, ("PROVIDER_LOCALIP", 0, localip))
         or (Delete, "PROVIDER_LOCALIP"),
         netmask and (Update, ("PROVIDER_NETMASK", 0,
                               netmask))
                  or (Delete, "PROVIDER_NETMASK"),
         (Update, ("PROVIDER_TIMEOUT", 0, timeout)),
         (Update, ("PROVIDER_DNS_MODE", 0, dnsmode)),
         (Update, ("PROVIDER_DNS", 0,
                   dns if dnsmode == "IP" else "")),
         (Update, ("PROVIDER_MTU_MODE", 0, mtumode)),
         (Update, ("PROVIDER_MTU_SIZE", 0,
                   mtusize if mtumode != "AUTO" else "")),
         (Update, ("PROVIDER_FIREWALL_RULESET_REF", 0, str(fwrules))),
         add_or_del(vlanid, "PROVIDER_VLAN_ID"),
         add_or_del(dialretry, "PROVIDER_DIAL_RETRY"),
         add_or_del(login, "PROVIDER_LOGIN"),
         add_or_del(password, "PROVIDER_PASSWORD"),
         add_or_del(modemip, "PROVIDER_MODEM_IP"),
         add_or_del(providerid, "PROVIDER_PROVIDERID"),
         add_or_del(localdhcp, "PROVIDER_LOCAL_DHCP")])
    provider_cnf = "provider-%d-%s.cnf" % (time.time(), suffix)
    [provider_cnf] = aw.prep_config_paths([provider_cnf], aw.DUMP_CONFIG_DIR)
    logging.info("Saving provider configuration to %s", provider_cnf)
    provider_obj.save(provider_cnf)
    return provider_cnf


def provider_proxy(mode="ROUTER", ip="1.2.3.4", localip=None, proxy_port=3128, fwrules=7, suffix="host"):
    """
    Generate and save a provider configuration file for proxy.

    :param str mode: provider mode
    :param str ip: IP address of the provider (and DNS server)
    :param localip: IP address of the configured machine (valid for some configurations)
    :type localip: str or None
    :param int proxy_port: port for the provider proxy
    :param int fwrules: instance of the firewall rules to use
    :param str suffix: optional suffix to use for config identification
    :returns: generated config filename
    :rtype: str
    """
    log.info("Create arnied provider configuration.")
    provider_obj = batch_update_cnf(
        build_provider.BuildProvider(),
        [(Update, ("PROVIDER_MODE", 0, mode)),
         (Update, ("PROVIDER_DNS", 0, ip)),
         (Update, ("PROVIDER_DYNDNS_ENABLE", 0, "0")),
         (Update, ("PROVIDER_IP", 0, ip)),
         (Update, ("PROVIDER_PROXY_SERVER", 0, ip)),
         (Update, ("PROVIDER_PROXY_PORT", 0, str(proxy_port))),
         localip
         and (Update, ("PROVIDER_LOCALIP", 0, localip))
         or (Delete, "PROVIDER_LOCALIP"),
         (Update, ("PROVIDER_DNS_MODE", 0, "IP")),
         (Update, ("PROVIDER_FIREWALL_RULESET_REF", 0, str(fwrules)))])
    provider_cnf = "provider-%d-%s.cnf" % (time.time(), suffix)
    [provider_cnf] = aw.prep_config_paths([provider_cnf], aw.DUMP_CONFIG_DIR)
    logging.info("Saving provider configuration to %s", provider_cnf)
    provider_obj.save(provider_cnf)
    return provider_cnf


def port_forwarding(src_port="1234", src_port_end="",
                    dst_port="1234", dst_port_end="",
                    dst_ip_ref="1", protocol_type="TCP",
                    suffix="host"):
    """
    Generate and save a port forwarding configuration file.

    :param str src_port: forwarded source port
    :param str src_port_end: forwarded source port end for a port range
    :param str dst_port: forwarded destination port
    :param str dst_port_end: forwarded destination port end for a port range
    :param str dst_ip_ref: destination nic instance for a port range
    :param str protocol_type: port forwarding protocol type
    :param str suffix: optional suffix to use for config identification
    :returns: generated config filename
    :rtype: str
    """
    log.info("Create port forwarding configuration")
    value_id = "test"
    portforward_client_cnf = "portforward-%d-%s.cnf" % (time.time(), suffix)
    return build_cnf("PORT_FORWARDING",
                     data=value_id,
                     filename=portforward_client_cnf,
                     vals=[(Child, ("PORT_FORWARDING_DST_IP_REF", 0, dst_ip_ref)),
                           (Child, ("PORT_FORWARDING_DST_PORT", 0, dst_port)),
                           (Child, ("PORT_FORWARDING_DST_PORT_END", 0, dst_port_end)),
                           (Child, ("PORT_FORWARDING_PROTOCOL_TYPE", 0, protocol_type)),
                           (Child, ("PORT_FORWARDING_SRC_PORT", 0, src_port)),
                           (Child, ("PORT_FORWARDING_SRC_PORT_END", 0, src_port_end))])


def firewall_ruleset_simple(suffix="host"):
    """
    Generate and save a simple firewall ruleset configuration file.

    :param str suffix: optional suffix to use for config identification
    :returns: generated config filename
    :rtype: str
    """
    log.info("Create firewall ruleset")
    fw_cnf = "fw-%d-%s.cnf" % (time.time(), suffix)
    return build_cnf("FIREWALL_RULESET",
                     instance=101,
                     data="Port Forwarding libfirewall test",
                     filename=fw_cnf,
                     vals=[(Update, ("FIREWALL_RULESET_PROFILE_TYPE", 0, "SIMPLE_PROVIDER")),
                           (Update, ("FIREWALL_RULESET_PROVIDER_HTTPS_OPEN", 0, "0")),
                           (Update, ("FIREWALL_RULESET_PROVIDER_POP3SIMAPS_OPEN", 0, "0")),
                           (Update, ("FIREWALL_RULESET_PROVIDER_PORT_FORWARDING_ENABLE", 0, "1")),
                           (Update, ("FIREWALL_RULESET_PROVIDER_SMTP_OPEN", 0, "0")),
                           (Update, ("FIREWALL_RULESET_PROVIDER_HTTP_OPEN", 0, "0")),
                           (Update, ("FIREWALL_RULESET_PROVIDER_VPN_OPEN", 0, "0"))])


def firewall_ruleset_port(suffix="host"):
    """
    Generate and save a firewall ruleset configuration file for port forwarding.

    :param str suffix: optional suffix to use for config identification
    :returns: generated config filename
    :rtype: str
    """
    log.info("Create firewall ruleset")
    fw_portforward_cnf = "fw-portforward-%d-%s.cnf" % (time.time(), suffix)
    return build_cnf("FIREWALL_RULESET",
                     instance=100,
                     data="Port forwarding only",
                     filename=fw_portforward_cnf,
                     vals=[(Update, ("FIREWALL_RULESET_AUTOMATIC_ANSWER_RULE", 0, "1")),
                           (Update, ("FIREWALL_RULESET_PROFILE_TYPE", 0, "FULL")),
                           (Add, ("FIREWALL_RULESET_RULE", 1, "")),
                           (Child, ("FIREWALL_RULESET_RULE_ACTION", 0, "ACCEPT")),
                           (Child, ("FIREWALL_RULESET_RULE_CHECK_CONNECTION_STATUS", 0, "PORTFORWARDING")),
                           (Child, ("FIREWALL_RULESET_RULE_CHECK_TCP_FLAGS", 0, "DISABLED")),
                           (Child, ("FIREWALL_RULESET_RULE_LIMIT_FOR_ACTION_ENABLE", 0, "0")),
                           (Child, ("FIREWALL_RULESET_RULE_LIMIT_FOR_LOG_ENABLE", 0, "0")),
                           (Child, ("FIREWALL_RULESET_RULE_LIMIT_PACKETS_AVERAGE_COUNT", 0, "")),
                           (Child, ("FIREWALL_RULESET_RULE_LIMIT_PACKETS_AVERAGE_PERIOD", 0, "SEC")),
                           (Child, ("FIREWALL_RULESET_RULE_LIMIT_PACKETS_PEAK_COUNT", 0, "")),
                           (Child, ("FIREWALL_RULESET_RULE_LOG_ENABLE", 0, "0")),
                           (Child, ("FIREWALL_RULESET_RULE_LOG_MESSAGE", 0, "")),
                           (Child, ("FIREWALL_RULESET_RULE_TIME_INCLUDE_TIME_REF", 0, "-1")),
                           (Update, ("FIREWALL_RULESET_USAGE", 0, "PROVIDER"))])


def firewall_ruleset_dmz(suffix="host"):
    """
    Generate and save a firewall ruleset configuration file for DMZ.

    :param str suffix: optional suffix to use for config identification
    :returns: generated config filename
    :rtype: str
    """
    log.info("Create firewall ruleset")
    fw_dmz_cnf = "fw-dmz-%d-%s.cnf" % (time.time(), suffix)
    return build_cnf("FIREWALL_RULESET",
                     instance=100,
                     data="DMZ firewall rules",
                     filename=fw_dmz_cnf,
                     vals=[(Update, ("FIREWALL_RULESET_AUTOMATIC_ANSWER_RULE", 0, "1")),
                           (Update, ("FIREWALL_RULESET_PROFILE_TYPE", 0, "FULL")),
                           (Add, ("FIREWALL_RULESET_RULE", 1, "")),
                           (Child, ("FIREWALL_RULESET_RULE_ACTION", 0, "ACCEPT")),
                           (Child, ("FIREWALL_RULESET_RULE_LIMIT_FOR_ACTION_ENABLE", 0, "0")),
                           (Child, ("FIREWALL_RULESET_RULE_LIMIT_FOR_LOG_ENABLE", 0, "0")),
                           (Child, ("FIREWALL_RULESET_RULE_LIMIT_PACKETS_AVERAGE_COUNT", 0, "")),
                           (Child, ("FIREWALL_RULESET_RULE_LIMIT_PACKETS_PEAK_COUNT", 0, "")),
                           (Child, ("FIREWALL_RULESET_RULE_LOG_ENABLE", 0, "0")),
                           (Child, ("FIREWALL_RULESET_RULE_LOG_MESSAGE", 0, "")),
                           (Child, ("FIREWALL_RULESET_RULE_SERVICE_INCLUDE_SERVICEGROUP_REF", 0, "6")),
                           (Child, ("FIREWALL_RULESET_RULE_DST_INCLUDE_CLIENT_REF", 0, "2")),
                           (Update, ("FIREWALL_RULESET_USAGE", 0, "LANVPN"))])