/*
 * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */

package org.opendaylight.vpnservice.utils.hwvtep;

import java.util.List;

import org.opendaylight.controller.md.sal.binding.api.DataBroker;
import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
import org.opendaylight.vpnservice.mdsalutil.MDSALUtil;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepGlobalAugmentation;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepNodeName;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalLocatorAugmentation;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalPortAugmentation;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepPhysicalPortAugmentationBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LocalUcastMacs;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalSwitches;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteMcastMacs;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteMcastMacsKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteUcastMacs;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteUcastMacsKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical.port.attributes.VlanBindings;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;

import com.google.common.base.Optional;
import com.google.common.util.concurrent.ListenableFuture;

/**
 * Utility class to related to Hardware VTEP devices.
 */
public final class HwvtepUtils {

    // TODO: (eperefr) Move this to HwvtepSouthboundUtils when in place.
    public static InstanceIdentifier<LocalUcastMacs> getWildCardPathForLocalUcastMacs() {
        return InstanceIdentifier.create(NetworkTopology.class).child(Topology.class).child(Node.class)
                .augmentation(HwvtepGlobalAugmentation.class).child(LocalUcastMacs.class);
    }

    /**
     * Adds the logical switch into config DS.
     *
     * @param broker
     *            the broker
     * @param nodeId
     *            the node id
     * @param logicalSwitch
     *            the logical switch
     * @return the listenable future
     */
    public static ListenableFuture<Void> addLogicalSwitch(DataBroker broker, NodeId nodeId,
            LogicalSwitches logicalSwitch) {
        WriteTransaction transaction = broker.newWriteOnlyTransaction();
        putLogicalSwitch(transaction, nodeId, logicalSwitch);
        return transaction.submit();
    }

    /**
     * Put the logical switches in the transaction.
     *
     * @param transaction
     *            the transaction
     * @param nodeId
     *            the node id
     * @param lstSwitches
     *            the lst switches
     */
    public static void putLogicalSwitches(final WriteTransaction transaction, final NodeId nodeId,
            final List<LogicalSwitches> lstSwitches) {
        if (lstSwitches != null) {
            for (LogicalSwitches logicalSwitch : lstSwitches) {
                putLogicalSwitch(transaction, nodeId, logicalSwitch);
            }
        }
    }

    /**
     * Put logical switch in the transaction.
     *
     * @param transaction
     *            the transaction
     * @param nodeId
     *            the node id
     * @param logicalSwitch
     *            the logical switch
     */
    public static void putLogicalSwitch(final WriteTransaction transaction, final NodeId nodeId,
            final LogicalSwitches logicalSwitch) {
        InstanceIdentifier<LogicalSwitches> iid = HwvtepSouthboundUtils.createLogicalSwitchesInstanceIdentifier(nodeId,
                logicalSwitch.getHwvtepNodeName());
        transaction.put(LogicalDatastoreType.CONFIGURATION, iid, logicalSwitch, true);
    }

    /**
     * Delete logical switch from config DS.
     *
     * @param broker
     *            the broker
     * @param nodeId
     *            the node id
     * @param logicalSwitchName
     *            the logical switch name
     * @return the listenable future
     */
    public static ListenableFuture<Void> deleteLogicalSwitch(DataBroker broker, NodeId nodeId,
            String logicalSwitchName) {
        WriteTransaction transaction = broker.newWriteOnlyTransaction();
        deleteLogicalSwitch(transaction, nodeId, logicalSwitchName);
        return transaction.submit();
    }

    /**
     * Delete logical switch from the transaction.
     *
     * @param transaction
     *            the transaction
     * @param nodeId
     *            the node id
     * @param logicalSwitchName
     *            the logical switch name
     */
    public static void deleteLogicalSwitch(final WriteTransaction transaction, final NodeId nodeId,
            final String logicalSwitchName) {
        transaction.delete(LogicalDatastoreType.CONFIGURATION, HwvtepSouthboundUtils
                .createLogicalSwitchesInstanceIdentifier(nodeId, new HwvtepNodeName(logicalSwitchName)));
    }

    /**
     * Gets the logical switch.
     *
     * @param nodeId
     *            the node id
     * @param logicalSwitchName
     *            the logical switch name
     * @return the logical switch
     */
    public static LogicalSwitches getLogicalSwitch(DataBroker broker, LogicalDatastoreType datastoreType, NodeId nodeId,
            String logicalSwitchName) {
        final InstanceIdentifier<LogicalSwitches> iid = HwvtepSouthboundUtils
                .createLogicalSwitchesInstanceIdentifier(nodeId, new HwvtepNodeName(logicalSwitchName));
        Optional<LogicalSwitches> optLogicalSwitch = MDSALUtil.read(broker, datastoreType, iid);
        if (optLogicalSwitch.isPresent()) {
            return optLogicalSwitch.get();
        }
        return null;
    }

    /**
     * Get LogicalSwitches for a given hwVtepNodeId.
     *
     * @param broker
     *            the broker
     * @param hwVtepNodeId
     *            Hardware VTEP Node Id
     * @param vni
     *            virtual network id
     * @return the logical switches
     */
    public static LogicalSwitches getLogicalSwitches(DataBroker broker, String hwVtepNodeId, String vni) {
        NodeId nodeId = new NodeId(hwVtepNodeId);
        InstanceIdentifier<LogicalSwitches> logicalSwitchesIdentifier = HwvtepSouthboundUtils
                .createLogicalSwitchesInstanceIdentifier(nodeId, new HwvtepNodeName(vni));

        Optional<LogicalSwitches> logicalSwitches = MDSALUtil.read(broker, LogicalDatastoreType.CONFIGURATION,
                logicalSwitchesIdentifier);
        if (!logicalSwitches.isPresent()) {
            return null;
        }

        return logicalSwitches.get();
    }

    /**
     * Put physical locators in the transaction.
     *
     * @param transaction
     *            the transaction
     * @param nodeId
     *            the node id
     * @param lstPhysicalLocator
     *            the lst physical locator
     */
    public static void putPhysicalLocators(WriteTransaction transaction, NodeId nodeId,
            List<HwvtepPhysicalLocatorAugmentation> lstPhysicalLocator) {
        if (lstPhysicalLocator != null) {
            for (HwvtepPhysicalLocatorAugmentation phyLocator : lstPhysicalLocator) {
                putPhysicalLocator(transaction, nodeId, phyLocator);
            }
        }
    }

    /**
     * Put physical locator in the transaction.
     *
     * @param transaction
     *            the transaction
     * @param nodeId
     *            the node id
     * @param phyLocator
     *            the phy locator
     */
    public static void putPhysicalLocator(final WriteTransaction transaction, final NodeId nodeId,
            final HwvtepPhysicalLocatorAugmentation phyLocator) {
        InstanceIdentifier<TerminationPoint> iid = HwvtepSouthboundUtils.createPhysicalLocatorInstanceIdentifier(nodeId,
                phyLocator);
        TerminationPoint terminationPoint = new TerminationPointBuilder()
                .setKey(HwvtepSouthboundUtils.getTerminationPointKey(phyLocator))
                .addAugmentation(HwvtepPhysicalLocatorAugmentation.class, phyLocator).build();

        transaction.put(LogicalDatastoreType.CONFIGURATION, iid, terminationPoint, true);
    }

    /**
     * Adds the remote ucast macs into config DS.
     *
     * @param broker
     *            the broker
     * @param nodeId
     *            the node id
     * @param lstRemoteUcastMacs
     *            the lst remote ucast macs
     * @return the listenable future
     */
    public static ListenableFuture<Void> addRemoteUcastMacs(DataBroker broker, NodeId nodeId,
            List<RemoteUcastMacs> lstRemoteUcastMacs) {
        WriteTransaction transaction = broker.newWriteOnlyTransaction();
        putRemoteUcastMacs(transaction, nodeId, lstRemoteUcastMacs);
        return transaction.submit();
    }

    /**
     * Put remote ucast macs in the transaction.
     *
     * @param transaction
     *            the transaction
     * @param nodeId
     *            the node id
     * @param lstRemoteUcastMacs
     *            the lst remote ucast macs
     */
    public static void putRemoteUcastMacs(final WriteTransaction transaction, final NodeId nodeId,
            final List<RemoteUcastMacs> lstRemoteUcastMacs) {
        if (lstRemoteUcastMacs != null && !lstRemoteUcastMacs.isEmpty()) {
            for (RemoteUcastMacs remoteUcastMac : lstRemoteUcastMacs) {
                putRemoteUcastMac(transaction, nodeId, remoteUcastMac);
            }
        }
    }

    /**
     * Put remote ucast mac in the transaction.
     *
     * @param transaction
     *            the transaction
     * @param nodeId
     *            the node id
     * @param remoteUcastMac
     *            the remote ucast mac
     */
    public static void putRemoteUcastMac(final WriteTransaction transaction, final NodeId nodeId,
            RemoteUcastMacs remoteUcastMac) {
        InstanceIdentifier<RemoteUcastMacs> iid = HwvtepSouthboundUtils.createInstanceIdentifier(nodeId).augmentation(HwvtepGlobalAugmentation.class)
        .child(RemoteUcastMacs.class, new RemoteUcastMacsKey(remoteUcastMac.getLogicalSwitchRef(), remoteUcastMac.getMacEntryKey()));
        transaction.put(LogicalDatastoreType.CONFIGURATION, iid, remoteUcastMac, true);
    }

    /**
     * Delete remote ucast mac from the config DS.
     *
     * @param broker
     *            the broker
     * @param nodeId
     *            the node id
     * @param mac
     *            the mac
     * @return the listenable future
     */
    public static ListenableFuture<Void> deleteRemoteUcastMac(DataBroker broker, NodeId nodeId,
            String logicalSwitchName, MacAddress mac) {
        WriteTransaction transaction = broker.newWriteOnlyTransaction();
        deleteRemoteUcastMac(transaction, nodeId, logicalSwitchName, mac);
        return transaction.submit();
    }

    /**
     * Delete remote ucast macs from the config DS.
     *
     * @param broker
     *            the broker
     * @param nodeId
     *            the node id
     * @param lstMac
     *            the lst mac
     * @return the listenable future
     */
    public static ListenableFuture<Void> deleteRemoteUcastMacs(DataBroker broker, NodeId nodeId,
            String logicalSwitchName, List<MacAddress> lstMac) {
        WriteTransaction transaction = broker.newWriteOnlyTransaction();
        deleteRemoteUcastMacs(transaction, nodeId, logicalSwitchName, lstMac);
        return transaction.submit();
    }

    /**
     * Delete remote ucast macs from the transaction.
     *
     * @param transaction
     *            the transaction
     * @param nodeId
     *            the node id
     * @param lstMac
     *            the lst mac
     */
    public static void deleteRemoteUcastMacs(final WriteTransaction transaction, final NodeId nodeId,
            String logicalSwitchName, final List<MacAddress> lstMac) {
        if (lstMac != null && !lstMac.isEmpty()) {
            for (MacAddress mac : lstMac) {
                deleteRemoteUcastMac(transaction, nodeId, logicalSwitchName, mac);
            }
        }
    }

    /**
     * Delete remote ucast mac from the transaction.
     *
     * @param transaction
     *            the transaction
     * @param nodeId
     *            the node id
     * @param mac
     *            the mac
     */
    public static void deleteRemoteUcastMac(final WriteTransaction transaction, final NodeId nodeId,
            String logialSwitchName,
            final MacAddress mac) {
        transaction.delete(LogicalDatastoreType.CONFIGURATION,
                HwvtepSouthboundUtils.createRemoteUcastMacsInstanceIdentifier(nodeId, logialSwitchName, mac));
    }

    /**
     * Adds the remote mcast macs into config DS.
     *
     * @param broker
     *            the broker
     * @param nodeId
     *            the node id
     * @param lstRemoteMcastMacs
     *            the lst remote mcast macs
     * @return the listenable future
     */
    public static ListenableFuture<Void> addRemoteMcastMacs(DataBroker broker, NodeId nodeId,
            List<RemoteMcastMacs> lstRemoteMcastMacs) {
        WriteTransaction transaction = broker.newWriteOnlyTransaction();
        putRemoteMcastMacs(transaction, nodeId, lstRemoteMcastMacs);
        return transaction.submit();
    }

    /**
     * Put remote mcast macs in the transaction.
     *
     * @param transaction
     *            the transaction
     * @param nodeId
     *            the node id
     * @param lstRemoteMcastMacs
     *            the lst remote mcast macs
     */
    public static void putRemoteMcastMacs(final WriteTransaction transaction, final NodeId nodeId,
            final List<RemoteMcastMacs> lstRemoteMcastMacs) {
        if (lstRemoteMcastMacs != null && !lstRemoteMcastMacs.isEmpty()) {
            for (RemoteMcastMacs remoteMcastMac : lstRemoteMcastMacs) {
                putRemoteMcastMac(transaction, nodeId, remoteMcastMac);
            }
        }
    }

    /**
     * Put remote mcast mac in the transaction.
     *
     * @param transaction
     *            the transaction
     * @param nodeId
     *            the node id
     * @param remoteMcastMac
     *            the remote mcast mac
     */
    public static void putRemoteMcastMac(final WriteTransaction transaction, final NodeId nodeId,
            RemoteMcastMacs remoteMcastMac) {
        InstanceIdentifier<RemoteMcastMacs> iid = HwvtepSouthboundUtils.createRemoteMcastMacsInstanceIdentifier(nodeId,
                remoteMcastMac.getKey());
        transaction.put(LogicalDatastoreType.CONFIGURATION, iid, remoteMcastMac, true);
    }

    /**
     * Delete remote mcast mac from config DS.
     *
     * @param broker
     *            the broker
     * @param nodeId
     *            the node id
     * @param remoteMcastMacsKey
     *            the remote mcast macs key
     * @return the listenable future
     */
    public static ListenableFuture<Void> deleteRemoteMcastMac(DataBroker broker, NodeId nodeId,
            RemoteMcastMacsKey remoteMcastMacsKey) {
        WriteTransaction transaction = broker.newWriteOnlyTransaction();
        deleteRemoteMcastMac(transaction, nodeId, remoteMcastMacsKey);
        return transaction.submit();
    }

    /**
     * Delete remote mcast macs from config DS.
     *
     * @param broker
     *            the broker
     * @param nodeId
     *            the node id
     * @param lstRemoteMcastMacsKey
     *            the lst remote mcast macs key
     * @return the listenable future
     */
    public static ListenableFuture<Void> deleteRemoteMcastMacs(DataBroker broker, NodeId nodeId,
            List<RemoteMcastMacsKey> lstRemoteMcastMacsKey) {
        WriteTransaction transaction = broker.newWriteOnlyTransaction();
        deleteRemoteMcastMacs(transaction, nodeId, lstRemoteMcastMacsKey);
        return transaction.submit();
    }

    /**
     * Delete remote mcast macs from the transaction.
     *
     * @param transaction
     *            the transaction
     * @param nodeId
     *            the node id
     * @param lstRemoteMcastMacsKey
     *            the lst remote mcast macs key
     */
    public static void deleteRemoteMcastMacs(final WriteTransaction transaction, final NodeId nodeId,
            final List<RemoteMcastMacsKey> lstRemoteMcastMacsKey) {
        if (lstRemoteMcastMacsKey != null && !lstRemoteMcastMacsKey.isEmpty()) {
            for (RemoteMcastMacsKey mac : lstRemoteMcastMacsKey) {
                deleteRemoteMcastMac(transaction, nodeId, mac);
            }
        }
    }

    /**
     * Delete remote mcast mac from the transaction.
     *
     * @param transaction
     *            the transaction
     * @param nodeId
     *            the node id
     * @param remoteMcastMacsKey
     *            the remote mcast macs key
     */
    public static void deleteRemoteMcastMac(final WriteTransaction transaction, final NodeId nodeId,
            final RemoteMcastMacsKey remoteMcastMacsKey) {
        transaction.delete(LogicalDatastoreType.CONFIGURATION,
                HwvtepSouthboundUtils.createRemoteMcastMacsInstanceIdentifier(nodeId, remoteMcastMacsKey));
    }

    /**
     * Merge vlan bindings in the transaction.
     *
     * @param transaction
     *            the transaction
     * @param nodeId
     *            the node id
     * @param phySwitchName
     *            the phy switch name
     * @param phyPortName
     *            the phy port name
     * @param vlanBindings
     *            the vlan bindings
     */
    public static void mergeVlanBindings(final WriteTransaction transaction, final NodeId nodeId,
            final String phySwitchName, final String phyPortName, final List<VlanBindings> vlanBindings) {
        NodeId physicalSwitchNodeId = HwvtepSouthboundUtils.createManagedNodeId(nodeId, phySwitchName);
        mergeVlanBindings(transaction, physicalSwitchNodeId, phyPortName, vlanBindings);
    }

    /**
     * Merge vlan bindings in the transaction.
     *
     * @param transaction
     *            the transaction
     * @param physicalSwitchNodeId
     *            the physical switch node id
     * @param phyPortName
     *            the phy port name
     * @param vlanBindings
     *            the vlan bindings
     */
    public static void mergeVlanBindings(final WriteTransaction transaction, final NodeId physicalSwitchNodeId,
            final String phyPortName, final List<VlanBindings> vlanBindings) {
        HwvtepPhysicalPortAugmentation phyPortAug = new HwvtepPhysicalPortAugmentationBuilder()
                .setHwvtepNodeName(new HwvtepNodeName(phyPortName)).setVlanBindings(vlanBindings).build();

        final InstanceIdentifier<HwvtepPhysicalPortAugmentation> iid = HwvtepSouthboundUtils
                .createPhysicalPortInstanceIdentifier(physicalSwitchNodeId, phyPortName);
        transaction.merge(LogicalDatastoreType.CONFIGURATION, iid, phyPortAug, true);
    }

    /**
     * Delete vlan binding from transaction.
     *
     * @param transaction
     *            the transaction
     * @param physicalSwitchNodeId
     *            the physical switch node id
     * @param phyPortName
     *            the phy port name
     * @param vlanId
     *            the vlan id
     */
    public static void deleteVlanBinding(WriteTransaction transaction, NodeId physicalSwitchNodeId, String phyPortName,
            Integer vlanId) {
        InstanceIdentifier<VlanBindings> iid = HwvtepSouthboundUtils
                .createVlanBindingInstanceIdentifier(physicalSwitchNodeId, phyPortName, vlanId);
        transaction.delete(LogicalDatastoreType.CONFIGURATION, iid);
    }

    /**
     * Gets the hw vtep node.
     *
     * @param dataBroker
     *            the data broker
     * @param datastoreType
     *            the datastore type
     * @param nodeId
     *            the node id
     * @return the hw vtep node
     */
    public static Node getHwVtepNode(DataBroker dataBroker, LogicalDatastoreType datastoreType, NodeId nodeId) {
        Optional<Node> optNode = MDSALUtil.read(dataBroker, datastoreType,
                HwvtepSouthboundUtils.createInstanceIdentifier(nodeId));
        if (optNode.isPresent()) {
            return optNode.get();
        }
        return null;
    }
}