# Copyright 2012 VMware, Inc.  All rights reserved.

# Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.

import errno

from neutron.agent.common import config

from neutron.agent.solaris import ra

from neutron.common import utils as common_utils

class EVSL3NATAgent(l3_agent.L3NATAgentWithStateReport):

        ri = l3_agent.RouterInfo(router_id, None,

                                 self.conf.use_namespaces, router)

        if self.conf.enable_metadata_proxy:

            self._spawn_metadata_proxy(ri.router_id, ri.ns_name)

        ri = self.router_info.get(router_id)

        if ri is None:

            LOG.warn(_("Info for router %s were not found. "

                       "Skipping router removal"), router_id)

            return

        if self.conf.enable_metadata_proxy:

            self._destroy_metadata_proxy(ri.router_id, ri.ns_name)

    def _get_metadata_proxy_callback(self, router_id):

        """Need to override this since we need to pass the absolute

        path to neutron-ns-metadata-proxy binary.

        """

        def callback(pid_file):

            metadata_proxy_socket = cfg.CONF.metadata_proxy_socket

            proxy_cmd = ['/usr/lib/neutron/neutron-ns-metadata-proxy',

                         '--pid_file=%s' % pid_file,

                         '--metadata_proxy_socket=%s' % metadata_proxy_socket,

                         '--router_id=%s' % router_id,

                         '--state_path=%s' % self.conf.state_path,

                         '--metadata_port=%s' % self.conf.metadata_port]

            proxy_cmd.extend(config.get_log_args(

                cfg.CONF, 'neutron-ns-metadata-proxy-%s.log' %

                router_id))

            return proxy_cmd

        return callback

    def external_gateway_snat_rules(self, ex_gw_ip, internal_cidrs,

                                    interface_name):

        rules = []

        for cidr in internal_cidrs:

            rules.append('map %s %s -> %s/32' %

                         (interface_name, cidr, ex_gw_ip))

        return rules

    def _handle_router_snat_rules(self, ri, ex_gw_port, internal_cidrs,

                                  interface_name, action):

        assert not ri.router['distributed']

        # Remove all the old SNAT rules

        # This is safe because if use_namespaces is set as False

        # then the agent can only configure one router, otherwise

        # each router's SNAT rules will be in their own namespace

        # get only the SNAT rules

        old_snat_rules = [rule for rule in ri.ipfilters_manager.ipv4['nat']

                          if rule.startswith('map')]

        ri.ipfilters_manager.remove_nat_rules(old_snat_rules)

        # And add them back if the action is add_rules

        if action == 'add_rules' and ex_gw_port:

            # NAT rules are added only if ex_gw_port has an IPv4 address

            for ip_addr in ex_gw_port['fixed_ips']:

                ex_gw_ip = ip_addr['ip_address']

                if netaddr.IPAddress(ex_gw_ip).version == 4:

                    rules = self.external_gateway_snat_rules(ex_gw_ip,

                                                             internal_cidrs,

                                                             interface_name)

                    ri.ipfilters_manager.add_nat_rules(rules)

                    break

    @common_utils.exception_logger()

        # TODO(mrsmith) - we shouldn't need to check here

        if 'distributed' not in ri.router:

            ri.router['distributed'] = False

        new_ipv6_port = False

        old_ipv6_port = False

            self.internal_network_added(ri, p)

            if (not new_ipv6_port and

                    netaddr.IPNetwork(p['subnet']['cidr']).version == 6):

                new_ipv6_port = True

            self.internal_network_removed(ri, p)

            if (not old_ipv6_port and

                    netaddr.IPNetwork(p['subnet']['cidr']).version == 6):

                old_ipv6_port = True

        if new_ipv6_port or old_ipv6_port:

            # refresh ndpd daemon after filling in ndpd.conf

            # with the right entries

            ra.enable_ipv6_ra(ri.router_id,

                              internal_ports,

                              self.get_internal_device_name)

        # remove any internal stale router interfaces (i.e., l3i.. VNICs)

        existing_devices = net_lib.Datalink.show_vnic()

        current_internal_devs = set([n for n in existing_devices

                                     if n.startswith(INTERNAL_DEV_PREFIX)])

        current_port_devs = set([self.get_internal_device_name(id) for

                                 id in current_port_ids])

        stale_devs = current_internal_devs - current_port_devs

        for stale_dev in stale_devs:

            LOG.debug(_('Deleting stale internal router device: %s'),

                      stale_dev)

            self.driver.fini_l3(stale_dev)

            self.driver.unplug(stale_dev)

        if ex_gw_port:

            def _gateway_ports_equal(port1, port2):

                def _get_filtered_dict(d, ignore):

                    return dict((k, v) for k, v in d.iteritems()

                                if k not in ignore)

                keys_to_ignore = set(['binding:host_id'])

                port1_filtered = _get_filtered_dict(port1, keys_to_ignore)

                port2_filtered = _get_filtered_dict(port2, keys_to_ignore)

                return port1_filtered == port2_filtered

            if not ri.ex_gw_port:

                self.external_gateway_added(ri, ex_gw_port, interface_name)

            elif not _gateway_ports_equal(ex_gw_port, ri.ex_gw_port):

                self.external_gateway_updated(ri, ex_gw_port, interface_name)

            self.external_gateway_removed(ri, ri.ex_gw_port, interface_name)

        # Remove any external stale router interfaces (i.e., l3e.. VNICs)

        stale_devs = [dev for dev in existing_devices

                      if dev.startswith(EXTERNAL_DEV_PREFIX)

                      and dev != interface_name]

        for stale_dev in stale_devs:

            LOG.debug(_('Deleting stale external router device: %s'),

                      stale_dev)

            self.driver.fini_l3(stale_dev)

            self.driver.unplug(stale_dev)

        # Process static routes for router

        self.routes_updated(ri)

        # Process SNAT rules for external gateway

        if (not ri.router['distributed'] or

                ex_gw_port and self.get_gw_port_host(ri.router) == self.host):

            # Get IPv4 only internal CIDRs

            internal_cidrs = [p['ip_cidr'] for p in ri.internal_ports

                              if netaddr.IPNetwork(p['ip_cidr']).version == 4]

            ri.perform_snat_action(self._handle_router_snat_rules,

                                   internal_cidrs, interface_name)

        # Process SNAT/DNAT rules for floating IPs

        fip_statuses = {}

            existing_floating_ips = ri.floating_ips

            fip_statuses = self.process_router_floating_ips(ri, ex_gw_port)

            # Identify floating IPs which were disabled

            ri.floating_ips = set(fip_statuses.keys())

            for fip_id in existing_floating_ips - ri.floating_ips:

                fip_statuses[fip_id] = l3_constants.FLOATINGIP_STATUS_DOWN

            # Update floating IP status on the neutron server

            self.plugin_rpc.update_floatingip_statuses(

                self.context, ri.router_id, fip_statuses)

        # Update ex_gw_port and enable_snat on the router info cache

        existing_cidrs = set(ipaddr_list)

        fip_statuses = {}

                try:

                    ipintf.create_address(fip_cidr)

                    ri.ipfilters_manager.add_nat_rules([nat_rule])

                except Exception as err:

                    # TODO(gmoodalb): If we fail in add_nat_rules(), then

                    # we need to remove the fip_cidr address

                    # any exception occurred here should cause the floating IP

                    # to be set in error state

                    fip_statuses[fip['id']] = (

                        l3_constants.FLOATINGIP_STATUS_ERROR)

                    LOG.warn(_("Unable to configure IP address for "

                               "floating IP: %s: %s") % (fip['id'], err))

                    continue

            fip_statuses[fip['id']] = (

                l3_constants.FLOATINGIP_STATUS_ACTIVE)

        old_nat_rules = list(set(existing_nat_rules) - set(new_nat_rules))

        # Filter out 'bimap' NAT rules as we don't want to remove NAT rules

        # that were added for Metadata server

        old_nat_rules = [rule for rule in old_nat_rules if "bimap" in rule]

        ri.ipfilters_manager.remove_nat_rules(old_nat_rules)

        return fip_statuses

    def external_gateway_added(self, ri, ex_gw_port, external_dlname):

            # determine the network type of the external network

            cmd = ['/usr/sbin/evsadm', 'show-evs', '-co', 'l2type,vid',

                   '-f', 'evs=%s' % evsname]

                LOG.error(_("Failed to retrieve the network type for "

                            "the external network, and it is required "

                            "to create an external gateway port: %s") % err)

                return

            output = stdout.splitlines()[0].strip()

            l2type, vid = output.split(':')

            if l2type != 'flat' and l2type != 'vlan':

                LOG.error(_("External network should be either Flat or "

                            "VLAN based, and it is required to "

                            "create an external gateway port"))

            elif (l2type == 'vlan' and

                  self.conf.get("external_network_datalink", None)):

                LOG.warning(_("external_network_datalink is deprecated in "

                             "Juno and will be removed in the next release of "

                             "Solaris OpenStack. Please use the evsadm "

                             "set-controlprop subcommand to setup the "

                             "uplink-port for an external network"))

                # proceed with the old-style of doing things

                mac_address = ex_gw_port['mac_address']

                dl.create_vnic(self.conf.external_network_datalink,

                               mac_address=mac_address, vid=vid)

            else:

                # This is to handle HA by Solaris Cluster and is similar to

                # the code we already have for the DHCP Agent. So, when

                # the 1st L3 agent is down and the second L3 agent tries to

                # connect its VNIC to EVS, we will end up in "vport in use"

                # error. So, we need to reset the vport before we connect

                # the VNIC to EVS.

                cmd = ['/usr/sbin/evsadm', 'show-vport', '-f',

                       'vport=%s' % ex_gw_port['id'], '-co',

                       'evs,vport,status']

                stdout = utils.execute(cmd)

                evsname, vportname, status = stdout.strip().split(':')

                tenant_id = ex_gw_port['tenant_id']

                if status == 'used':

                    cmd = ['/usr/sbin/evsadm', 'reset-vport', '-T', tenant_id,

                           '%s/%s' % (evsname, vportname)]

                    utils.execute(cmd)

                # next remove protection setting on the VPort to allow

                # multiple floating IPs to be configured on the l3e*

                # interface

                evsvport = "%s/%s" % (ex_gw_port['network_id'],

                                      ex_gw_port['id'])

                cmd = ['/usr/sbin/evsadm', 'set-vportprop', '-T',

                       tenant_id, '-p', 'protection=none', evsvport]

                utils.execute(cmd)

                dl.connect_vnic(evsvport, tenant_id)

            stdout = utils.execute(cmd, extra_ok_codes=[errno.EEXIST])

            ri.remove_route = True

            if 'entry exists' in stdout:

                ri.remove_route = False

    def external_gateway_updated(self, ri, ex_gw_port, external_dlname):

        # There is nothing to do on Solaris

        pass

    def external_gateway_removed(self, ri, ex_gw_port, external_dlname):

            if ri.remove_route:

                cmd = ['/usr/bin/pfexec', '/usr/sbin/route', 'delete',

                       'default', gw_ip]

                utils.execute(cmd, check_exit_code=False)

        # remove the EVS VPort associated with external network

        cmd = ['/usr/sbin/evsadm', 'remove-vport',

               '-T', ex_gw_port['tenant_id'],

               '%s/%s' % (ex_gw_port['network_id'], ex_gw_port['id'])]

        try:

            utils.execute(cmd)

        except Exception as err:

            LOG.error(_("Failed to delete the EVS VPort associated with "

                        "external network: %s") % err)