/*
 * 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.bgpcep.pcep.topology.provider;

import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import io.netty.util.concurrent.FutureListener;
import java.net.InetAddress;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import javax.annotation.concurrent.GuardedBy;
import org.opendaylight.controller.config.yang.pcep.topology.provider.ListenerStateRuntimeMXBean;
import org.opendaylight.controller.config.yang.pcep.topology.provider.ListenerStateRuntimeRegistration;
import org.opendaylight.controller.config.yang.pcep.topology.provider.PeerCapabilities;
import org.opendaylight.controller.config.yang.pcep.topology.provider.ReplyTime;
import org.opendaylight.controller.config.yang.pcep.topology.provider.SessionState;
import org.opendaylight.controller.config.yang.pcep.topology.provider.StatefulMessages;
import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
import org.opendaylight.protocol.pcep.PCEPSession;
import org.opendaylight.protocol.pcep.PCEPSessionListener;
import org.opendaylight.protocol.pcep.PCEPTerminationReason;
import org.opendaylight.protocol.pcep.TerminationReason;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddressBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.MessageHeader;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.ProtocolVersion;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.LspId;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.Node1;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.Node1Builder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.OperationResult;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.PccSyncState;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.lsp.metadata.Metadata;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.PathComputationClient;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.PathComputationClientBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.ReportedLsp;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.ReportedLspBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.ReportedLspKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.pcep.client.attributes.path.computation.client.reported.lsp.Path;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
import org.opendaylight.yangtools.yang.binding.DataContainer;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Base class for PCEP topology providers. It handles the common tasks involved in managing a PCEP server (PCE)
 * endpoint, and exposing a network topology based on it. It needs to be subclassed to form a fully functional block,
 * where the subclass provides handling of incoming messages.
 *
 * @param <S> identifier type of requests
 * @param <L> identifier type for LSPs
 */
public abstract class AbstractTopologySessionListener<S, L> implements PCEPSessionListener, TopologySessionListener, ListenerStateRuntimeMXBean {
    protected static final class MessageContext {
        private final Collection<PCEPRequest> requests = new ArrayList<>();
        private final WriteTransaction trans;

        private MessageContext(final WriteTransaction trans) {
            this.trans = Preconditions.checkNotNull(trans);
        }

        void resolveRequest(final PCEPRequest req) {
            this.requests.add(req);
        }

        private void notifyRequests() {
            for (final PCEPRequest r : this.requests) {
                r.done(OperationResults.SUCCESS);
            }
        }
    }

    protected static final MessageHeader MESSAGE_HEADER = new MessageHeader() {
        private final ProtocolVersion version = new ProtocolVersion((short) 1);

        @Override
        public Class<? extends DataContainer> getImplementedInterface() {
            return MessageHeader.class;
        }

        @Override
        public ProtocolVersion getVersion() {
            return this.version;
        }
    };

    private static final Logger LOG = LoggerFactory.getLogger(AbstractTopologySessionListener.class);

    protected static final String MISSING_XML_TAG = "Mandatory XML tags are missing.";

    @GuardedBy("this")
    private final Map<S, PCEPRequest> requests = new HashMap<>();

    @GuardedBy("this")
    private final Map<String, ReportedLsp> lspData = new HashMap<>();

    @GuardedBy("this")
    private final Map<L, String> lsps = new HashMap<>();

    private final ServerSessionManager serverSessionManager;
    private InstanceIdentifier<PathComputationClient> pccIdentifier;
    private TopologyNodeState nodeState;
    private boolean synced = false;
    private PCEPSession session;
    private SyncOptimization syncOptimization;

    private ListenerStateRuntimeRegistration registration;
    private final SessionListenerState listenerState;

    protected AbstractTopologySessionListener(final ServerSessionManager serverSessionManager) {
        this.serverSessionManager = Preconditions.checkNotNull(serverSessionManager);
        this.listenerState = new SessionListenerState();
    }

    @Override
    public final synchronized void onSessionUp(final PCEPSession session) {
        /*
         * The session went up. Look up the router in Inventory model,
         * create it if it is not there (marking that fact for later
         * deletion), and mark it as synchronizing. Also create it in
         * the topology model, with empty LSP list.
         */
        final InetAddress peerAddress = session.getRemoteAddress();

        syncOptimization  = new SyncOptimization(session);

        final TopologyNodeState state = this.serverSessionManager.takeNodeState(peerAddress, this, isLspDbRetreived());

        this.session = session;
        this.nodeState = state;

        LOG.trace("Peer {} resolved to topology node {}", peerAddress, state.getNodeId());

        // Our augmentation in the topology node
        final PathComputationClientBuilder pccBuilder = new PathComputationClientBuilder();

        onSessionUp(session, pccBuilder);
        this.synced = isSynchronized();

        pccBuilder.setIpAddress(IpAddressBuilder.getDefaultInstance(peerAddress.getHostAddress()));
        final InstanceIdentifier<Node1> topologyAugment = state.getNodeId().augmentation(Node1.class);
        this.pccIdentifier = topologyAugment.child(PathComputationClient.class);
        final Node initialNodeState = state.getInitialNodeState();
        final boolean isNodePresent = isLspDbRetreived() && initialNodeState != null;
        if (isNodePresent) {
            loadLspData(initialNodeState, lspData, lsps, isIncrementalSynchro());
            pccBuilder.setReportedLsp(initialNodeState.getAugmentation(Node1.class).getPathComputationClient().getReportedLsp());
        }
        writeNode(pccBuilder, state, topologyAugment);
        this.listenerState.init(session);
        if (this.serverSessionManager.getRuntimeRootRegistration().isPresent()) {
            this.registration = this.serverSessionManager.getRuntimeRootRegistration().get().register(this);
        }
        LOG.info("Session with {} attached to topology node {}", session.getRemoteAddress(), state.getNodeId());
    }

    private void writeNode(final PathComputationClientBuilder pccBuilder, final TopologyNodeState state,
            final InstanceIdentifier<Node1> topologyAugment) {
        final Node1 ta = new Node1Builder().setPathComputationClient(pccBuilder.build()).build();

        final ReadWriteTransaction trans = state.rwTransaction();
        trans.put(LogicalDatastoreType.OPERATIONAL, topologyAugment, ta);
        LOG.trace("Peer data {} set to {}", topologyAugment, ta);

        // All set, commit the modifications
        Futures.addCallback(trans.submit(), new FutureCallback<Void>() {
            @Override
            public void onSuccess(final Void result) {
                LOG.trace("Internal state for session {} updated successfully", session);
            }

            @Override
            public void onFailure(final Throwable t) {
                LOG.error("Failed to update internal state for session {}, terminating it", session, t);
                session.close(TerminationReason.UNKNOWN);
            }
        });
    }

    @GuardedBy("this")
    private void tearDown(final PCEPSession session) {
        this.serverSessionManager.releaseNodeState(this.nodeState, session, isLspDbPersisted());
        this.nodeState = null;
        this.session = null;
        this.syncOptimization = null;
        unregister();

        // Clear all requests we know about
        for (final Entry<S, PCEPRequest> e : this.requests.entrySet()) {
            final PCEPRequest r = e.getValue();
            switch (r.getState()) {
            case DONE:
                // Done is done, nothing to do
                break;
            case UNACKED:
                // Peer has not acked: results in failure
                LOG.info("Request {} was incomplete when session went down, failing the instruction", e.getKey());
                r.done(OperationResults.NOACK);
                break;
            case UNSENT:
                // Peer has not been sent to the peer: results in cancellation
                LOG.debug("Request {} was not sent when session went down, cancelling the instruction", e.getKey());
                r.done(OperationResults.UNSENT);
                break;
            default:
                break;
            }
        }
        this.requests.clear();
    }

    @Override
    public final synchronized void onSessionDown(final PCEPSession session, final Exception e) {
        LOG.warn("Session {} went down unexpectedly", session, e);
        tearDown(session);
    }

    @Override
    public final synchronized void onSessionTerminated(final PCEPSession session, final PCEPTerminationReason reason) {
        LOG.info("Session {} terminated by peer with reason {}", session, reason);
        tearDown(session);
    }

    @Override
    public final synchronized void onMessage(final PCEPSession session, final Message message) {
        final MessageContext ctx = new MessageContext(this.nodeState.beginTransaction());

        if (onMessage(ctx, message)) {
            LOG.info("Unhandled message {} on session {}", message, session);
            return;
        }

        Futures.addCallback(ctx.trans.submit(), new FutureCallback<Void>() {
            @Override
            public void onSuccess(final Void result) {
                LOG.trace("Internal state for session {} updated successfully", session);
                ctx.notifyRequests();
            }

            @Override
            public void onFailure(final Throwable t) {
                LOG.error("Failed to update internal state for session {}, closing it", session, t);
                ctx.notifyRequests();
                session.close(TerminationReason.UNKNOWN);
            }
        });
    }

    @Override
    public void close() {
        unregister();
        if (this.session != null) {
            this.session.close(TerminationReason.UNKNOWN);
        }
    }

    private synchronized void unregister() {
        if (this.registration != null) {
            this.registration.close();
            this.registration = null;
        }
    }

    protected final synchronized PCEPRequest removeRequest(final S id) {
        final PCEPRequest ret = this.requests.remove(id);
        if (ret != null) {
            this.listenerState.processRequestStats(ret.getElapsedMillis());
        }
        LOG.trace("Removed request {} object {}", id, ret);
        return ret;
    }

    protected final synchronized ListenableFuture<OperationResult> sendMessage(final Message message, final S requestId,
        final Metadata metadata) {
        final io.netty.util.concurrent.Future<Void> f = this.session.sendMessage(message);
        this.listenerState.updateStatefulSentMsg(message);
        final PCEPRequest req = new PCEPRequest(metadata);
        this.requests.put(requestId, req);

        f.addListener(new FutureListener<Void>() {
            @Override
            public void operationComplete(final io.netty.util.concurrent.Future<Void> future) {
                if (!future.isSuccess()) {
                    synchronized (AbstractTopologySessionListener.this) {
                        AbstractTopologySessionListener.this.requests.remove(requestId);
                    }
                    req.done(OperationResults.UNSENT);
                    LOG.info("Failed to send request {}, instruction cancelled", requestId, future.cause());
                } else {
                    req.sent();
                    LOG.trace("Request {} sent to peer (object {})", requestId, req);
                }
            }
        });

        return req.getFuture();
    }

    /**
     * Update an LSP in the data store
     *
     * @param ctx Message context
     * @param id Revision-specific LSP identifier
     * @param lspName LSP name
     * @param rlb Reported LSP builder
     * @param solicited True if the update was solicited
     * @param remove True if this is an LSP path removal
     */
    protected final synchronized void updateLsp(final MessageContext ctx, final L id, final String lspName,
        final ReportedLspBuilder rlb, final boolean solicited, final boolean remove) {

        final String name;
        if (lspName == null) {
            name = this.lsps.get(id);
            if (name == null) {
                LOG.error("PLSPID {} seen for the first time, not reporting the LSP", id);
                return;
            }
        } else {
            name = lspName;
        }

        LOG.debug("Saved LSP {} with name {}", id, name);
        this.lsps.put(id, name);


        final ReportedLsp previous = this.lspData.get(name);
        // if no previous report about the lsp exist, just proceed
        if (previous != null) {
            final List<Path> updatedPaths = makeBeforeBreak(rlb, previous, name, remove);
            // if all paths or the last path were deleted, delete whole tunnel
            if (updatedPaths == null || updatedPaths.isEmpty()) {
                LOG.debug("All paths were removed, removing LSP with {}.", id);
                removeLsp(ctx, id);
                return;
            }
            rlb.setPath(updatedPaths);
        }
        rlb.setKey(new ReportedLspKey(name));
        rlb.setName(name);

        // If this is an unsolicited update. We need to make sure we retain the metadata already present
        if (solicited) {
            this.nodeState.setLspMetadata(name, rlb.getMetadata());
        } else {
            rlb.setMetadata(this.nodeState.getLspMetadata(name));
        }

        final ReportedLsp rl = rlb.build();
        ctx.trans.put(LogicalDatastoreType.OPERATIONAL, this.pccIdentifier.child(ReportedLsp.class, rlb.getKey()), rl);
        LOG.debug("LSP {} updated to MD-SAL", name);

        this.lspData.put(name, rl);
    }

    private List<Path> makeBeforeBreak(final ReportedLspBuilder rlb, final ReportedLsp previous, final String name, final boolean remove) {
        // just one path should be reported
        Preconditions.checkState(rlb.getPath().size() == 1);
        final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.LspId reportedLspId = rlb.getPath().get(0).getLspId();
        // check previous report for existing paths
        final List<Path> updatedPaths = new ArrayList<>(previous.getPath());
        LOG.debug("Found previous paths {} to this lsp name {}", updatedPaths, name);
        for (final Path path : previous.getPath()) {
            //we found reported path in previous reports
            if (path.getLspId().getValue() == 0 || path.getLspId().equals(reportedLspId)) {
                LOG.debug("Match on lsp-id {}", path.getLspId().getValue() );
                // path that was reported previously and does have the same lsp-id, path will be updated
                final boolean r = updatedPaths.remove(path);
                LOG.trace("Request removed? {}", r);
            }
        }
        // if the path does not exist in previous report, add it to path list, it's a new ERO
        // only one path will be added
        //lspId is 0 means confirmation message that shouldn't be added (because we have no means of deleting it later)
        LOG.trace("Adding new path {} to {}", rlb.getPath(), updatedPaths);
        updatedPaths.addAll(rlb.getPath());
        if (remove) {
            if (reportedLspId.getValue() == 0) {
                // if lsp-id also 0, remove all paths
                LOG.debug("Removing all paths.");
                updatedPaths.clear();
            } else {
                // path is marked to be removed
                LOG.debug("Removing path {} from {}", rlb.getPath(), updatedPaths);
                final boolean r = updatedPaths.removeAll(rlb.getPath());
                LOG.trace("Request removed? {}", r);
            }
        }
        LOG.debug("Setting new paths {} to lsp {}", updatedPaths, name);
        return updatedPaths;
    }

    /**
     * Indicate that the peer has completed state synchronization.
     *
     * @param ctx Message context
     */
    protected final synchronized void stateSynchronizationAchieved(final MessageContext ctx) {
        if (this.synced) {
            LOG.debug("State synchronization achieved while synchronized, not updating state");
            return;
        }

        // Update synchronization flag
        this.synced = true;
        updatePccNode(ctx, new PathComputationClientBuilder().setStateSync(PccSyncState.Synchronized).build());

        // The node has completed synchronization, cleanup metadata no longer reported back
        this.nodeState.cleanupExcept(this.lsps.values());
        LOG.debug("Session {} achieved synchronized state", this.session);
    }

    protected final synchronized void updatePccNode(final MessageContext ctx, final PathComputationClient pcc) {
        ctx.trans.merge(LogicalDatastoreType.OPERATIONAL, this.pccIdentifier, pcc);
    }

    protected final InstanceIdentifier<ReportedLsp> lspIdentifier(final String name) {
        return this.pccIdentifier.child(ReportedLsp.class, new ReportedLspKey(name));
    }

    protected final InstanceIdentifier<PathComputationClient> getPccIdentifier() {
        return this.pccIdentifier;
    }

    /**
     * Remove LSP from the database.
     *
     * @param ctx Message Context
     * @param id Revision-specific LSP identifier
     */
    protected final synchronized void removeLsp(final MessageContext ctx, final L id) {
        final String name = this.lsps.remove(id);
        LOG.debug("LSP {} removed", name);
        ctx.trans.delete(LogicalDatastoreType.OPERATIONAL, lspIdentifier(name));
        this.lspData.remove(name);
    }

    protected abstract void onSessionUp(PCEPSession session, PathComputationClientBuilder pccBuilder);

    /**
     * Perform revision-specific message processing when a message arrives.
     *
     * @param ctx Message processing context
     * @param message Protocol message
     * @return True if the message type is not handle.
     */
    protected abstract boolean onMessage(MessageContext ctx, Message message);

    protected final String lookupLspName(final L id) {
        Preconditions.checkNotNull(id, "ID parameter null.");
        return this.lsps.get(id);
    }

    /**
     * Reads operational data on this node. Doesn't attempt to read the data,
     * if the node does not exist. In this case returns null.
     *
     * @param id InstanceIdentifier of the node
     * @return null if the node does not exists, or operational data
     */
    protected final synchronized <T extends DataObject> ListenableFuture<Optional<T>> readOperationalData(final InstanceIdentifier<T> id) {
        if (this.nodeState == null) {
            return null;
        }
        return this.nodeState.readOperationalData(id);
    }

    protected abstract Object validateReportedLsp(final Optional<ReportedLsp> rep, final LspId input);

    protected abstract void loadLspData(final Node node, final Map<String, ReportedLsp> lspData, final Map<L, String> lsps, final boolean incrementalSynchro);

    protected final boolean isLspDbPersisted() {
        if (syncOptimization != null) {
            return syncOptimization.isSyncAvoidanceEnabled();
        }
        return false;
    }

    protected final boolean isLspDbRetreived() {
        if (syncOptimization != null) {
            return syncOptimization.isDbVersionPresent();
        }
        return false;
    }

    /**
     * Is Incremental synchronization if LSP-DB-VERSION are included,
     * LSP-DB-VERSION TLV values doesnt match, and  LSP-SYNC-CAPABILITY is enabled
     * @return
     */
    protected final boolean isIncrementalSynchro() {
        if (syncOptimization != null) {
            return syncOptimization.isSyncAvoidanceEnabled() && syncOptimization.isDeltaSyncEnabled();
        }
        return false;
    }

    protected final boolean isSynchronized() {
        if (syncOptimization != null) {
            return syncOptimization.doesLspDbMatch();
        }
        return false;
    }

    protected SessionListenerState getSessionListenerState() {
        return this.listenerState;
    }

    @Override
    public Integer getDelegatedLspsCount() {
        return this.lsps.size();
    }

    @Override
    public Boolean getSynchronized() {
        return this.synced;
    }

    @Override
    public StatefulMessages getStatefulMessages() {
        return this.listenerState.getStatefulMessages();
    }

    @Override
    public synchronized void resetStats() {
        this.listenerState.resetStats(this.session);
    }

    @Override
    public ReplyTime getReplyTime() {
        return this.listenerState.getReplyTime();
    }

    @Override
    public PeerCapabilities getPeerCapabilities() {
        return this.listenerState.getPeerCapabilities();
    }

    @Override
    public void tearDownSession() {
        this.close();
    }

    @Override
    public synchronized SessionState getSessionState() {
        return this.listenerState.getSessionState(this.session);
    }

    @Override
    public synchronized String getPeerId() {
        return this.session.getPeerPref().getIpAddress();
    }
}