/*
 * 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.netconf.persist.impl;

import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import io.netty.channel.EventLoopGroup;
import org.opendaylight.controller.config.api.ConflictingVersionException;
import org.opendaylight.controller.config.persist.api.ConfigSnapshotHolder;
import org.opendaylight.controller.netconf.api.NetconfMessage;
import org.opendaylight.controller.netconf.client.NetconfClient;
import org.opendaylight.controller.netconf.client.NetconfClientDispatcher;
import org.opendaylight.controller.netconf.util.NetconfUtil;
import org.opendaylight.controller.netconf.util.messages.NetconfMessageAdditionalHeader;
import org.opendaylight.controller.netconf.util.xml.XmlElement;
import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants;
import org.opendaylight.controller.netconf.util.xml.XmlUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.xml.sax.SAXException;

import javax.annotation.concurrent.Immutable;
import java.io.IOException;
import java.io.InputStream;
import java.net.InetSocketAddress;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.concurrent.TimeUnit;

@Immutable
public class ConfigPusher {
    private static final Logger logger = LoggerFactory.getLogger(ConfigPersisterNotificationHandler.class);
    private static final int NETCONF_SEND_ATTEMPT_MS_DELAY = 1000;
    private static final int NETCONF_SEND_ATTEMPTS = 20;

    private final InetSocketAddress address;
    private final EventLoopGroup nettyThreadgroup;

    // Default timeout for netconf becoming stable
    public static final long DEFAULT_TIMEOUT = TimeUnit.MINUTES.toNanos(2);
    private final int delayMillis = 5000;
    private final long timeoutNanos;

    public ConfigPusher(InetSocketAddress address, EventLoopGroup nettyThreadgroup) {
        this(address, nettyThreadgroup, DEFAULT_TIMEOUT);
    }

    @Deprecated
    public ConfigPusher(InetSocketAddress address, long timeoutMillis, EventLoopGroup nettyThreadgroup) {
        this(address, nettyThreadgroup, TimeUnit.MILLISECONDS.toNanos(timeoutMillis));
    }

    public ConfigPusher(InetSocketAddress address, EventLoopGroup nettyThreadgroup, long timeoutNanos) {
        this.address = address;
        this.nettyThreadgroup = nettyThreadgroup;
        this.timeoutNanos = timeoutNanos;
    }

    public synchronized NetconfClient init(List<ConfigSnapshotHolder> configs) throws InterruptedException {
        logger.debug("Last config snapshots to be pushed to netconf: {}", configs);
        return pushAllConfigs(configs);
    }

    private synchronized NetconfClient pushAllConfigs(List<ConfigSnapshotHolder> configs) throws InterruptedException {
        // first just make sure we can connect to netconf, even if nothing is being pushed
        NetconfClient netconfClient = makeNetconfConnection(Collections.<String>emptySet(), Optional.<NetconfClient>absent());
        // start pushing snapshots:
        for (ConfigSnapshotHolder configSnapshotHolder: configs){
            netconfClient = pushSnapshotWithRetries(configSnapshotHolder, Optional.of(netconfClient));
            logger.debug("Config snapshot pushed successfully: {}", configSnapshotHolder);
        }

        logger.debug("All configuration snapshots have been pushed successfully.");
        return netconfClient;
    }

    private synchronized NetconfClient pushSnapshotWithRetries(ConfigSnapshotHolder configSnapshotHolder,
                                                               Optional<NetconfClient> oldClientForPossibleReuse)
            throws InterruptedException {

        Exception lastException = null;
        int maxAttempts = 30;
        for(int i = 0 ; i < maxAttempts; i++) {
            NetconfClient netconfClient = makeNetconfConnection(configSnapshotHolder.getCapabilities(), oldClientForPossibleReuse);
            logger.trace("Pushing following xml to netconf {}", configSnapshotHolder);
            try {
                pushLastConfig(configSnapshotHolder, netconfClient);
                return netconfClient;
            } catch (ConflictingVersionException | IOException e) {
                Util.closeClientAndDispatcher(netconfClient);
                lastException = e;
                Thread.sleep(1000);
            } catch (SAXException e) {
                throw new IllegalStateException("Unable to load last config", e);
            }
        }
        throw new IllegalStateException("Failed to push configuration, maximum attempt count has been reached: "
                + maxAttempts, lastException);
    }

    /**
     * @param expectedCaps capabilities that server hello must contain. Will retry until all are found or throws RuntimeException.
     *                     If empty set is provided, will only make sure netconf client successfuly connected to the server.
     * @param maybeOldClient if present, close it.
     * @return NetconfClient that has all required capabilities from server.
     */
    private synchronized NetconfClient makeNetconfConnection(Set<String> expectedCaps,
                                                             Optional<NetconfClient> maybeOldClient)
            throws InterruptedException {

        if (maybeOldClient.isPresent()) {
            NetconfClient oldClient = maybeOldClient.get();
            Util.closeClientAndDispatcher(oldClient);
        }

        // TODO think about moving capability subset check to netconf client
        // could be utilized by integration tests

        final long pollingStart = System.nanoTime();
        final long deadline = pollingStart + timeoutNanos;
        int attempt = 0;

        String additionalHeader = NetconfMessageAdditionalHeader.toString("unknown", address.getAddress().getHostAddress(),
                Integer.toString(address.getPort()), "tcp", Optional.of("persister"));

        Set<String> latestCapabilities = new HashSet<>();
        while (System.nanoTime() < deadline) {
            attempt++;
            NetconfClientDispatcher netconfClientDispatcher = new NetconfClientDispatcher(nettyThreadgroup,
                    nettyThreadgroup, additionalHeader);
            NetconfClient netconfClient;
            try {
                netconfClient = new NetconfClient(this.toString(), address, delayMillis, netconfClientDispatcher);
            } catch (IllegalStateException e) {
                logger.debug("Netconf {} was not initialized or is not stable, attempt {}", address, attempt, e);
                netconfClientDispatcher.close();
                Thread.sleep(delayMillis);
                continue;
            }
            latestCapabilities = netconfClient.getCapabilities();
            if (Util.isSubset(netconfClient, expectedCaps)) {
                logger.debug("Hello from netconf stable with {} capabilities", latestCapabilities);
                logger.trace("Session id received from netconf server: {}", netconfClient.getClientSession());
                return netconfClient;
            }
            logger.debug("Polling hello from netconf, attempt {}, capabilities {}", attempt, latestCapabilities);
            Util.closeClientAndDispatcher(netconfClient);
            Thread.sleep(delayMillis);
        }
        Set<String> allNotFound = new HashSet<>(expectedCaps);
        allNotFound.removeAll(latestCapabilities);
        logger.error("Netconf server did not provide required capabilities. Expected but not found: {}, all expected {}, current {}",
                allNotFound, expectedCaps, latestCapabilities);
        throw new RuntimeException("Netconf server did not provide required capabilities. Expected but not found:" + allNotFound);
    }


    private synchronized void pushLastConfig(ConfigSnapshotHolder configSnapshotHolder, NetconfClient netconfClient)
            throws ConflictingVersionException, IOException, SAXException {

        Element xmlToBePersisted = XmlUtil.readXmlToElement(configSnapshotHolder.getConfigSnapshot());
        logger.trace("Pushing last configuration to netconf: {}", configSnapshotHolder);
        StringBuilder response = new StringBuilder("editConfig response = {");

        NetconfMessage message = createEditConfigMessage(xmlToBePersisted, "/netconfOp/editConfig.xml");

        // sending message to netconf
        NetconfMessage responseMessage = getResponse(message, netconfClient);

        NetconfUtil.checkIsMessageOk(responseMessage);
        response.append(XmlUtil.toString(responseMessage.getDocument()));
        response.append("}");
        responseMessage = getResponse(getNetconfMessageFromResource("/netconfOp/commit.xml"), netconfClient);



        NetconfUtil.checkIsMessageOk(responseMessage);
        response.append("commit response = {");
        response.append(XmlUtil.toString(responseMessage.getDocument()));
        response.append("}");
        logger.trace("Last configuration loaded successfully");
        logger.trace("Detailed message {}", response);
    }

    private static NetconfMessage getResponse(NetconfMessage request, NetconfClient netconfClient) throws IOException {
        try {
            return netconfClient.sendMessage(request, NETCONF_SEND_ATTEMPTS, NETCONF_SEND_ATTEMPT_MS_DELAY);
        } catch (RuntimeException e) {
            logger.debug("Error while executing netconf transaction {} to {}", request, netconfClient, e);
            throw new IOException("Failed to execute netconf transaction", e);
        }
    }

    private static NetconfMessage createEditConfigMessage(Element dataElement, String editConfigResourcename) throws IOException, SAXException {
        try (InputStream stream = ConfigPersisterNotificationHandler.class.getResourceAsStream(editConfigResourcename)) {
            Preconditions.checkNotNull(stream, "Unable to load resource " + editConfigResourcename);

            Document doc = XmlUtil.readXmlToDocument(stream);

            doc.getDocumentElement();
            XmlElement editConfigElement = XmlElement.fromDomDocument(doc).getOnlyChildElement();
            XmlElement configWrapper = editConfigElement.getOnlyChildElement(XmlNetconfConstants.CONFIG_KEY);
            editConfigElement.getDomElement().removeChild(configWrapper.getDomElement());
            for (XmlElement el : XmlElement.fromDomElement(dataElement).getChildElements()) {
                configWrapper.appendChild((Element) doc.importNode(el.getDomElement(), true));
            }
            editConfigElement.appendChild(configWrapper.getDomElement());
            return new NetconfMessage(doc);
        } catch (IOException | SAXException e) {
            logger.debug("Failed to create edit-config message for resource {}", editConfigResourcename, e);
            throw e;
        }
    }

    private static NetconfMessage getNetconfMessageFromResource(String resource) throws IOException, SAXException {
        try (InputStream stream = ConfigPusher.class.getResourceAsStream(resource)) {
            Preconditions.checkNotNull(stream, "Unable to load resource " + resource);
            return new NetconfMessage(XmlUtil.readXmlToDocument(stream));
        } catch (SAXException | IOException e) {
            logger.debug("Failed to parse netconf message for resource {}", resource, e);
            throw e;
        }
    }
}