/*
 * Copyright (c) 2013 Cisco Systems, Inc. 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.controller.switchmanager;

import java.io.Serializable;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;

import org.opendaylight.controller.sal.core.NodeConnector;
import org.opendaylight.controller.sal.packet.BitBufferHelper;
import org.opendaylight.controller.sal.utils.GUIField;
import org.opendaylight.controller.sal.utils.NetUtils;
import org.opendaylight.controller.sal.utils.Status;
import org.opendaylight.controller.sal.utils.StatusCode;

/**
 * The class represents a subnet configuration.
 */
@XmlRootElement
@XmlAccessorType(XmlAccessType.NONE)
public class SubnetConfig implements Cloneable, Serializable {
    private static final long serialVersionUID = 1L;
    private static final String prettyFields[] = { GUIField.NAME.toString(),
            GUIField.GATEWAYIP.toString(), GUIField.NODEPORTS.toString() };

    /**
     * Name of the subnet
     */
    @XmlElement
    private String name;
    /**
     * A.B.C.D/MM  Where A.B.C.D is the Default
     * Gateway IP (L3) or ARP Querier IP (L2)
     */
    @XmlElement
    private String subnet;
    /**
     * Set of node connectors in the format:
     * Port Type|Port Id@Node Type|Node Id
     */
    @XmlElement
    private List<String> nodeConnectors;

    public SubnetConfig() {
    }

    public SubnetConfig(String name, String subnet, List<String> nodeConnectors) {
        this.name = name;
        this.subnet = subnet;
        this.nodeConnectors = nodeConnectors;
    }

    public SubnetConfig(SubnetConfig subnetConfig) {
        name = subnetConfig.name;
        subnet = subnetConfig.subnet;
        nodeConnectors = (subnetConfig.nodeConnectors == null) ? null : new ArrayList<String>(subnetConfig.nodeConnectors);
    }

    public String getName() {
        return name;
    }

    public List<String> getNodePorts() {
        return (nodeConnectors == null) ? new ArrayList<String>(0) : new ArrayList<String>(nodeConnectors);
    }

    public String getSubnet() {
        return subnet;
    }

    public InetAddress getIPAddress() {
        InetAddress ip = null;
        try {
            ip = InetAddress.getByName(subnet.split("/")[0]);
        } catch (UnknownHostException e1) {
            return null;
        }
        return ip;
    }

    public Short getIPMaskLen() {
        Short maskLen = 0;
        String[] s = subnet.split("/");
        maskLen = (s.length == 2) ? Short.valueOf(s[1]) : 32;
        return maskLen;
    }

    private Status validateSubnetAddress() {
        if (!NetUtils.isIPAddressValid(subnet)) {
            return new Status(StatusCode.BADREQUEST, String.format("Invalid Subnet configuration: Invalid address: %s", subnet));
        }
        byte[] bytePrefix = NetUtils.getSubnetPrefix(this.getIPAddress(), this.getIPMaskLen()).getAddress();
        long prefix = BitBufferHelper.getLong(bytePrefix);
        if (prefix == 0) {
            return new Status(StatusCode.BADREQUEST, "Invalid network source address: subnet zero");
        }
        return new Status(StatusCode.SUCCESS);
    }

    public static Status validatePorts(List<String> nodeConnectors) {
        if (nodeConnectors != null) {
            for (String port : nodeConnectors) {
                if (null == NodeConnector.fromString(port)) {
                    return new Status(StatusCode.BADREQUEST,
                            "Invalid Subnet configuration: Not parsable node connector: " + port);
                }
            }
        }
        return new Status(StatusCode.SUCCESS);
    }

    public Status validate() {
        Status status = validateSubnetAddress();
        if (status.isSuccess()) {
            status = validatePorts(this.nodeConnectors);
        }
        return status;
    }

    public static List<String> getGuiFieldsNames() {
        List<String> fieldList = new ArrayList<String>();
        for (String str : prettyFields) {
            fieldList.add(str);
        }
        return fieldList;
    }

    public Set<NodeConnector> getNodeConnectors() {
        return NodeConnector.fromString(this.nodeConnectors);
    }

    public boolean isGlobal() {
        // If no ports are specified to be part of the domain, then it's a global domain IP
        return (nodeConnectors == null || nodeConnectors.isEmpty());
    }

    public void addNodeConnectors(List<String> nc) {
        if (nc != null) {
            if (nodeConnectors == null) {
                nodeConnectors = new ArrayList<String>(nc);
            } else {
                nodeConnectors.addAll(nc);
            }
        }
    }

    public void removeNodeConnectors(List<String> nc) {
        if (nc != null && nodeConnectors != null) {
            nodeConnectors.removeAll(nc);
        }
    }

    @Override
    public String toString() {
        return ("SubnetConfig [Name=" + name + ", Subnet=" + subnet
                + ", NodeConnectors=" + nodeConnectors + "]");
    }

    /**
     * Implement clonable interface
     */
    @Override
    public SubnetConfig clone() {
        return new SubnetConfig(this);
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((name == null) ? 0 : name.hashCode());
        result = prime * result + ((nodeConnectors == null) ? 0 : nodeConnectors.hashCode());
        result = prime * result + ((subnet == null) ? 0 : subnet.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        SubnetConfig other = (SubnetConfig) obj;
        if (name == null) {
            if (other.name != null) {
                return false;
            }
        } else if (!name.equals(other.name)) {
            return false;
        }
        if (nodeConnectors == null) {
            if (other.nodeConnectors != null) {
                return false;
            }
        } else if (!nodeConnectors.equals(other.nodeConnectors)) {
            return false;
        }
        if (subnet == null) {
            if (other.subnet != null) {
                return false;
            }
        } else if (!subnet.equals(other.subnet)) {
            return false;
        }
        return true;
    }
}