/**
 * 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.openflowplugin.openflow.md.core.translator;

import org.opendaylight.openflowplugin.openflow.md.core.IMDMessageTranslator;
import org.opendaylight.openflowplugin.openflow.md.core.SwitchConnectionDistinguisher;
import org.opendaylight.openflowplugin.openflow.md.core.session.SessionContext;
import org.opendaylight.openflowplugin.openflow.md.core.session.TransactionKey;
import org.opendaylight.openflowplugin.openflow.md.util.ByteUtil;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.errors.rev131116.ErrorType;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.NodeErrorNotification;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.NodeErrorNotificationBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.NodeFlow;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.node.error.reference.ObjectReference;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.node.error.reference.object.reference.FlowRefBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.node.error.reference.object.reference.GroupRefBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.node.error.reference.object.reference.MeterRefBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev131103.TransactionId;
import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev131103.TransactionMetadata;
import org.opendaylight.yang.gen.v1.urn.opendaylight.group.service.rev130918.NodeGroup;
import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.NodeMeter;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.math.BigInteger;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;

public abstract class AbstractErrorTranslator implements IMDMessageTranslator<OfHeader, List<DataObject>> {

    protected static final Logger LOG = LoggerFactory.getLogger(AbstractErrorTranslator.class);

    @Override
    public List<DataObject> translate(SwitchConnectionDistinguisher cookie, SessionContext sc, OfHeader msg) {
        if (msg instanceof ErrorMessage) {
            ErrorMessage message = (ErrorMessage) msg;
            List<DataObject> list = new CopyOnWriteArrayList<DataObject>();
            if (LOG.isDebugEnabled()) {
                String hexData = "n/a";
                if (message.getData() != null) {
                    hexData = ByteUtil.bytesToHexstring(message.getData(), " ");
                }
                LOG.debug(" Error Message received: type={}[{}], code={}[{}], data=[{}] ", message.getType(),
                        message.getTypeString(), message.getCode(), message.getCodeString(),
                        hexData);

            }

            // create a Node Error Notification event builder
            NodeErrorNotificationBuilder nodeErrBuilder = new NodeErrorNotificationBuilder();

            // Fill in the Node Error Notification Builder object from the Error
            // Message

            nodeErrBuilder.setTransactionId(new TransactionId(BigInteger.valueOf(message.getXid())));

            Object object = null;
            if (sc != null) {
                // sessionContext is available only after handshake finished
                object = sc.getbulkTransactionCache().getIfPresent(new TransactionKey(message.getXid()));
            }

            Uri uri = null;
            ObjectReference objRef = null;
            if(object != null) {
                uri = ((TransactionMetadata) object).getTransactionUri();
                objRef = getReference(object);
            }

            nodeErrBuilder.setTransactionUri(uri);
            nodeErrBuilder.setObjectReference(objRef);

            ErrorType type = decodeErrorType(message.getType());
            nodeErrBuilder.setType(type);
            nodeErrBuilder.setCode(message.getCode());

            if (message.getData() != null) {
                nodeErrBuilder.setData(new String(message.getData()));
            }

            // TODO -- Augmentation is not handled

            NodeErrorNotification nodeErrorEvent = nodeErrBuilder.build();
            list.add(nodeErrorEvent);

            list.addAll(getGranularNodeErrors(message, type, uri, objRef));

            return list;
        } else {
            LOG.error("Message is not of Error Message ");
            return Collections.emptyList();
        }
    }

    private ObjectReference getReference(Object object) {
        if (object instanceof NodeFlow) {
            FlowEntityData flowEntry = new FlowEntityData();
            FlowRefBuilder flowRef = flowEntry.getBuilder(object);
            return flowRef.build();

        } else if (object instanceof NodeGroup) {
            GroupEntityData groupEntry = new GroupEntityData();
            GroupRefBuilder groupRef = groupEntry.getBuilder(object);
            return groupRef.build();

        } else if (object instanceof NodeMeter) {
            MeterEntityData meterEntry = new MeterEntityData();
            MeterRefBuilder meterRef = meterEntry.getBuilder(object);
            return meterRef.build();

        }
        return null;
    }

    protected List<DataObject> getGranularNodeErrors(ErrorMessage message, ErrorType errorType, Uri uri, ObjectReference objRef){
        // this is the impl for V1.0
        return new ArrayList<>();
    }

    /**
     * @param type error type in source message
     */
    public abstract ErrorType decodeErrorType(int type);

}