/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.xml.internal.ws.api.addressing;

import com.sun.istack.internal.NotNull;

import com.sun.istack.internal.Nullable;

import com.sun.xml.internal.stream.buffer.MutableXMLStreamBuffer;

import com.sun.xml.internal.stream.buffer.XMLStreamBuffer;

import com.sun.xml.internal.stream.buffer.XMLStreamBufferResult;

import com.sun.xml.internal.stream.buffer.XMLStreamBufferSource;

import com.sun.xml.internal.stream.buffer.sax.SAXBufferProcessor;

import com.sun.xml.internal.stream.buffer.stax.StreamReaderBufferProcessor;

import com.sun.xml.internal.stream.buffer.stax.StreamWriterBufferCreator;

import com.sun.xml.internal.ws.addressing.EndpointReferenceUtil;

import com.sun.xml.internal.ws.addressing.W3CAddressingMetadataConstants;

import com.sun.xml.internal.ws.addressing.WSEPRExtension;

import com.sun.xml.internal.ws.addressing.model.InvalidAddressingHeaderException;

import com.sun.xml.internal.ws.addressing.v200408.MemberSubmissionAddressingConstants;

import com.sun.xml.internal.ws.api.message.Header;

import com.sun.xml.internal.ws.api.message.HeaderList;

import com.sun.xml.internal.ws.api.message.Message;

import com.sun.xml.internal.ws.api.message.MessageHeaders;

import com.sun.xml.internal.ws.api.streaming.XMLStreamReaderFactory;

import com.sun.xml.internal.ws.api.model.wsdl.WSDLExtension;

import com.sun.xml.internal.ws.resources.AddressingMessages;

import com.sun.xml.internal.ws.resources.ClientMessages;

import com.sun.xml.internal.ws.spi.ProviderImpl;

import com.sun.xml.internal.ws.streaming.XMLStreamReaderUtil;

import com.sun.xml.internal.ws.util.DOMUtil;

import com.sun.xml.internal.ws.util.xml.XMLStreamWriterFilter;

import com.sun.xml.internal.ws.util.xml.XmlUtil;

import com.sun.xml.internal.ws.wsdl.parser.WSDLConstants;

import org.w3c.dom.Element;

import org.xml.sax.*;

import org.xml.sax.helpers.XMLFilterImpl;

import javax.xml.bind.JAXBContext;

import javax.xml.namespace.QName;

import javax.xml.stream.XMLStreamException;

import javax.xml.stream.XMLStreamReader;

import javax.xml.stream.XMLStreamWriter;

import javax.xml.transform.Source;

import javax.xml.transform.TransformerException;

import javax.xml.transform.sax.SAXSource;

import javax.xml.transform.stream.StreamResult;

import javax.xml.transform.stream.StreamSource;

import javax.xml.ws.Dispatch;

import javax.xml.ws.EndpointReference;

import javax.xml.ws.Service;

import javax.xml.ws.WebServiceException;

import javax.xml.ws.WebServiceFeature;

import java.io.InputStream;

import java.io.StringWriter;

import java.net.URI;

import java.net.URL;

import java.util.*;

/**

 * Internal representation of the EPR.

 *

 * <p>

 * Instances of this class are immutable and thread-safe.

 *

 * @author Kohsuke Kawaguchi

 * @author Rama Pulavarthi

 *

 * @see AddressingVersion#anonymousEpr

 */

public final class WSEndpointReference  implements WSDLExtension {

    private final XMLStreamBuffer infoset;

    /**

     * Version of the addressing spec.

     */

    private final AddressingVersion version;

    /**

     * Marked Reference parameters inside this EPR.

     *

     * Parsed when the object is created. can be empty but never null.

     * @see #parse()

     */

    private @NotNull Header[] referenceParameters;

    private @NotNull String address;

    private @NotNull QName rootElement;

    /**

     * Creates from the spec version of {@link EndpointReference}.

     *

     * <p>

     * This method performs the data conversion, so it's slow.

     * Do not use this method in a performance critical path.

     */

    public WSEndpointReference(EndpointReference epr, AddressingVersion version) {

        try {

            MutableXMLStreamBuffer xsb = new MutableXMLStreamBuffer();

            epr.writeTo(new XMLStreamBufferResult(xsb));

            this.infoset = xsb;

            this.version = version;

            this.rootElement = new QName("EndpointReference", version.nsUri);

            parse();

        } catch (XMLStreamException e) {

            throw new WebServiceException(ClientMessages.FAILED_TO_PARSE_EPR(epr),e);

        }

    }

    /**

     * Creates from the spec version of {@link EndpointReference}.

     *

     * <p>

     * This method performs the data conversion, so it's slow.

     * Do not use this method in a performance critical path.

     */

    public WSEndpointReference(EndpointReference epr) {

        this(epr,AddressingVersion.fromSpecClass(epr.getClass()));

    }

    /**

     * Creates a {@link WSEndpointReference} that wraps a given infoset.

     */

    public WSEndpointReference(XMLStreamBuffer infoset, AddressingVersion version) {

        try {

            this.infoset = infoset;

            this.version = version;

            this.rootElement = new QName("EndpointReference", version.nsUri);

            parse();

        } catch (XMLStreamException e) {

            // this can never happen because XMLStreamBuffer never has underlying I/O error.

            throw new AssertionError(e);

        }

    }

    /**

     * Creates a {@link WSEndpointReference} by parsing an infoset.

     */

    public WSEndpointReference(InputStream infoset, AddressingVersion version) throws XMLStreamException {

        this(XMLStreamReaderFactory.create(null,infoset,false),version);

    }

    /**

     * Creates a {@link WSEndpointReference} from the given infoset.

     * The {@link XMLStreamReader} must point to either a document or an element.

     */

    public WSEndpointReference(XMLStreamReader in, AddressingVersion version) throws XMLStreamException {

        this(XMLStreamBuffer.createNewBufferFromXMLStreamReader(in), version);

    }

    /**

     * @see #WSEndpointReference(String, AddressingVersion)

     */

    public WSEndpointReference(URL address, AddressingVersion version) {

        this(address.toExternalForm(), version);

    }

    /**

     * @see #WSEndpointReference(String, AddressingVersion)

     */

    public WSEndpointReference(URI address, AddressingVersion version) {

        this(address.toString(), version);

    }

    /**

     * Creates a {@link WSEndpointReference} that only has an address.

     */

    public WSEndpointReference(String address, AddressingVersion version) {

        this.infoset = createBufferFromAddress(address,version);

        this.version = version;

        this.address = address;

        this.rootElement = new QName("EndpointReference", version.nsUri);

        this.referenceParameters = EMPTY_ARRAY;

    }

    private static XMLStreamBuffer createBufferFromAddress(String address, AddressingVersion version) {

        try {

            MutableXMLStreamBuffer xsb = new MutableXMLStreamBuffer();

            StreamWriterBufferCreator w = new StreamWriterBufferCreator(xsb);

            w.writeStartDocument();

            w.writeStartElement(version.getPrefix(),

                "EndpointReference", version.nsUri);

            w.writeNamespace(version.getPrefix(), version.nsUri);

            w.writeStartElement(version.getPrefix(),version.eprType.address, version.nsUri);

            w.writeCharacters(address);

            w.writeEndElement();

            w.writeEndElement();

            w.writeEndDocument();

            w.close();

            return xsb;

        } catch (XMLStreamException e) {

            // can never happen because we are writing to XSB

            throw new AssertionError(e);

        }

    }

    /**

     * Creates an EPR from individual components.

     *

     * <p>

     * This version takes various information about metadata, and creates an EPR that has

     * the necessary embedded WSDL.

     */

    public WSEndpointReference(@NotNull AddressingVersion version,

                               @NotNull String address,

                               @Nullable QName service,

                               @Nullable QName port,

                               @Nullable QName portType,

                               @Nullable List<Element> metadata,

                               @Nullable String wsdlAddress,

                               @Nullable List<Element> referenceParameters) {

       this(version, address, service, port, portType, metadata, wsdlAddress, null, referenceParameters, null, null);

    }

    /**

     * Creates an EPR from individual components.

     *

     * <p>

     * This version takes various information about metadata, and creates an EPR that has

     * the necessary embedded WSDL.

     */

    public WSEndpointReference(@NotNull AddressingVersion version,

                               @NotNull String address,

                               @Nullable QName service,

                               @Nullable QName port,

                               @Nullable QName portType,

                               @Nullable List<Element> metadata,

                               @Nullable String wsdlAddress,

                               @Nullable List<Element> referenceParameters,

                               @Nullable Collection<EPRExtension> extns,@Nullable Map<QName, String> attributes) {

       this(createBufferFromData(version, address, referenceParameters, service, port, portType, metadata, wsdlAddress, null, extns, attributes),

            version );

    }

    /**

     * Creates an EPR from individual components.

     *

     * <p>

     * This version takes various information about metadata, and creates an EPR that has

     * the necessary embedded WSDL.

     * @since JAX-WS 2.2

     */

    public WSEndpointReference(@NotNull AddressingVersion version,

                               @NotNull String address,

                               @Nullable QName service,

                               @Nullable QName port,

                               @Nullable QName portType,

                               @Nullable List<Element> metadata,

                               @Nullable String wsdlAddress,

                               @Nullable String wsdlTargetNamepsace,

                               @Nullable List<Element> referenceParameters,

                               @Nullable List<Element> elements, @Nullable Map<QName, String> attributes) {

       this(

            createBufferFromData(version, address, referenceParameters, service, port, portType, metadata, wsdlAddress,wsdlTargetNamepsace, elements, attributes),

            version );

    }

    private static XMLStreamBuffer createBufferFromData(AddressingVersion version, String address, List<Element> referenceParameters, QName service, QName port, QName portType,

                                                            List<Element> metadata, String wsdlAddress, String wsdlTargetNamespace, @Nullable List<Element> elements, @Nullable Map<QName, String> attributes) {

        StreamWriterBufferCreator writer = new StreamWriterBufferCreator();

        try {

            writer.writeStartDocument();

            writer.writeStartElement(version.getPrefix(),"EndpointReference", version.nsUri);

            writer.writeNamespace(version.getPrefix(),version.nsUri);

                writePartialEPRInfoset(writer, version, address, referenceParameters, service, port, portType,

                        metadata,wsdlAddress, wsdlTargetNamespace, attributes);

                //write extensibility elements in the EPR element

                if (elements != null) {

                    for (Element e : elements) {

                        DOMUtil.serializeNode(e, writer);

                    }

                }

                writer.writeEndElement();

                writer.writeEndDocument();

                writer.flush();

                return writer.getXMLStreamBuffer();

            } catch (XMLStreamException e) {

                throw new WebServiceException(e);

            }

        }

        private static XMLStreamBuffer createBufferFromData(AddressingVersion version, String address, List<Element> referenceParameters, QName service, QName port, QName portType,

                                                            List<Element> metadata, String wsdlAddress, String wsdlTargetNamespace, @Nullable Collection<EPRExtension> extns, @Nullable Map<QName, String> attributes) {

            StreamWriterBufferCreator writer = new StreamWriterBufferCreator();

            try {

                writer.writeStartDocument();

                writer.writeStartElement(version.getPrefix(),"EndpointReference", version.nsUri);

                writer.writeNamespace(version.getPrefix(),version.nsUri);

                writePartialEPRInfoset(writer, version, address, referenceParameters, service, port, portType,

                        metadata,wsdlAddress, wsdlTargetNamespace, attributes);

                //write extensibility elements in the EPR element

                if (extns != null) {

                    for (EPRExtension e : extns) {

                        XMLStreamReaderToXMLStreamWriter c = new XMLStreamReaderToXMLStreamWriter();

                        XMLStreamReader r = e.readAsXMLStreamReader();

                        c.bridge(r, writer);

                        XMLStreamReaderFactory.recycle(r);

                    }

                }

                writer.writeEndElement();

                writer.writeEndDocument();

                writer.flush();

                return writer.getXMLStreamBuffer();

            } catch (XMLStreamException e) {

                throw new WebServiceException(e);

            }

        }

        private static void writePartialEPRInfoset(StreamWriterBufferCreator writer, AddressingVersion version, String address, List<Element> referenceParameters, QName service, QName port, QName portType,

                                                   List<Element> metadata, String wsdlAddress, String wsdlTargetNamespace, @Nullable Map<QName, String> attributes) throws XMLStreamException {

            //add extensibile attributes on the EPR element

            if (attributes != null) {

                for (Map.Entry<QName, String> entry : attributes.entrySet()) {

                    QName qname = entry.getKey();

                    writer.writeAttribute(qname.getPrefix(), qname.getNamespaceURI(), qname.getLocalPart(), entry.getValue());

                }

            }

            writer.writeStartElement(version.getPrefix(), version.eprType.address, version.nsUri);

            writer.writeCharacters(address);

            writer.writeEndElement();

            //When the size of ReferenceParametes is zero, the ReferenceParametes element will not be written.

            if(referenceParameters != null && referenceParameters.size() > 0) {

                writer.writeStartElement(version.getPrefix(), version.eprType.referenceParameters, version.nsUri);

                for (Element e : referenceParameters) {

                    DOMUtil.serializeNode(e, writer);

                }

                writer.writeEndElement();

            }

            switch (version) {

                case W3C:

                    writeW3CMetaData(writer, service, port, portType, metadata, wsdlAddress, wsdlTargetNamespace);

                    break;

                case MEMBER:

                    writeMSMetaData(writer, service, port, portType, metadata);

                    if (wsdlAddress != null) {

                        //Inline the wsdl as extensibility element

                        //Write mex:Metadata wrapper

                        writer.writeStartElement(MemberSubmissionAddressingConstants.MEX_METADATA.getPrefix(),

                                MemberSubmissionAddressingConstants.MEX_METADATA.getLocalPart(),

                                MemberSubmissionAddressingConstants.MEX_METADATA.getNamespaceURI());

                        writer.writeStartElement(MemberSubmissionAddressingConstants.MEX_METADATA_SECTION.getPrefix(),

                                MemberSubmissionAddressingConstants.MEX_METADATA_SECTION.getLocalPart(),

                                MemberSubmissionAddressingConstants.MEX_METADATA_SECTION.getNamespaceURI());

                        writer.writeAttribute(MemberSubmissionAddressingConstants.MEX_METADATA_DIALECT_ATTRIBUTE,

                                MemberSubmissionAddressingConstants.MEX_METADATA_DIALECT_VALUE);

                        writeWsdl(writer, service, wsdlAddress);

                        writer.writeEndElement();

                        writer.writeEndElement();

                    }

                    break;

            }

        }

    private static boolean isEmty(QName qname) {

        return qname == null || qname.toString().trim().length()== 0;

    }

    private static void writeW3CMetaData(StreamWriterBufferCreator writer,

                                         QName service,

                                         QName port,

                                         QName portType, List<Element> metadata,

                                         String wsdlAddress, String wsdlTargetNamespace) throws XMLStreamException {

        //.NET treate empty metaData element as bad request.

        if (isEmty(service) && isEmty(port) && isEmty(portType) && metadata == null/* && wsdlAddress == null*/) {

            return;

        }

        writer.writeStartElement(AddressingVersion.W3C.getPrefix(),

                AddressingVersion.W3C.eprType.wsdlMetadata.getLocalPart(), AddressingVersion.W3C.nsUri);

        writer.writeNamespace(AddressingVersion.W3C.getWsdlPrefix(),

                AddressingVersion.W3C.wsdlNsUri);

        //write wsdliLication as defined in WS-Addressing 1.0 Metadata spec

        if(wsdlAddress != null) {

            writeWsdliLocation(writer, service, wsdlAddress, wsdlTargetNamespace);

        }

        //Write Interface info

        if (portType != null) {

            writer.writeStartElement(W3CAddressingMetadataConstants.WSAM_PREFIX_NAME,

                    AddressingVersion.W3C.eprType.portTypeName,

                    W3CAddressingMetadataConstants.WSAM_NAMESPACE_NAME);

            writer.writeNamespace(W3CAddressingMetadataConstants.WSAM_PREFIX_NAME,

                W3CAddressingMetadataConstants.WSAM_NAMESPACE_NAME);

            String portTypePrefix = portType.getPrefix();

            if (portTypePrefix == null || portTypePrefix.equals("")) {

                //TODO check prefix again

                portTypePrefix = "wsns";

            }

            writer.writeNamespace(portTypePrefix, portType.getNamespaceURI());

            writer.writeCharacters(portTypePrefix + ":" + portType.getLocalPart());

            writer.writeEndElement();

        }

        if (service != null) {

            //Write service and Port info

            if (!(service.getNamespaceURI().equals("") || service.getLocalPart().equals(""))) {

                writer.writeStartElement(W3CAddressingMetadataConstants.WSAM_PREFIX_NAME,

                        AddressingVersion.W3C.eprType.serviceName,

                        W3CAddressingMetadataConstants.WSAM_NAMESPACE_NAME);

                writer.writeNamespace(W3CAddressingMetadataConstants.WSAM_PREFIX_NAME,

                    W3CAddressingMetadataConstants.WSAM_NAMESPACE_NAME);

                String servicePrefix = service.getPrefix();

                if (servicePrefix == null || servicePrefix.equals("")) {

                    //TODO check prefix again

                    servicePrefix = "wsns";

                }

                writer.writeNamespace(servicePrefix, service.getNamespaceURI());

                if (port != null) {

                    writer.writeAttribute(AddressingVersion.W3C.eprType.portName, port.getLocalPart());

                }

                writer.writeCharacters(servicePrefix + ":" + service.getLocalPart());

                writer.writeEndElement();

            }

        }

        /*

        //Inline the wsdl

        if (wsdlAddress != null) {

            writeWsdl(writer, service, wsdlAddress);

        }

        */

        //Add the extra metadata Elements

        if (metadata != null) {

            for (Element e : metadata) {

                DOMUtil.serializeNode(e, writer);

            }

        }

        writer.writeEndElement();

    }

    /**

     * @param writer the writer should be at the start of element.

     * @param service Namespace URI of servcie is used as targetNamespace of wsdl if wsdlTargetNamespace is not null

     * @param wsdlAddress  wsdl location

     * @param wsdlTargetNamespace  targetnamespace of wsdl to be put in wsdliLocation

     *

     */

    private static void writeWsdliLocation(StreamWriterBufferCreator writer, QName service,String wsdlAddress,String wsdlTargetNamespace) throws XMLStreamException {

        String wsdliLocation = "";

        if(wsdlTargetNamespace != null) {

           wsdliLocation = wsdlTargetNamespace + " ";

        } else if (service != null) {

            wsdliLocation = service.getNamespaceURI() + " ";

        } else {

            throw new WebServiceException("WSDL target Namespace cannot be resolved");

        }

        wsdliLocation += wsdlAddress;

        writer.writeNamespace(W3CAddressingMetadataConstants.WSAM_WSDLI_ATTRIBUTE_PREFIX,

            W3CAddressingMetadataConstants.WSAM_WSDLI_ATTRIBUTE_NAMESPACE);

        writer.writeAttribute(W3CAddressingMetadataConstants.WSAM_WSDLI_ATTRIBUTE_PREFIX,

                W3CAddressingMetadataConstants.WSAM_WSDLI_ATTRIBUTE_NAMESPACE,

                W3CAddressingMetadataConstants.WSAM_WSDLI_ATTRIBUTE_LOCALNAME,

                wsdliLocation);

    }

    private static void writeMSMetaData(StreamWriterBufferCreator writer,

                                        QName service,

                                        QName port,

                                        QName portType, List<Element> metadata) throws XMLStreamException {

        // TODO: write ReferenceProperties

        //TODO: write ReferenceParameters

        if (portType != null) {

            //Write Interface info

            writer.writeStartElement(AddressingVersion.MEMBER.getPrefix(),

                    AddressingVersion.MEMBER.eprType.portTypeName,

                    AddressingVersion.MEMBER.nsUri);

            String portTypePrefix = portType.getPrefix();

            if (portTypePrefix == null || portTypePrefix.equals("")) {

                //TODO check prefix again

                portTypePrefix = "wsns";

            }

            writer.writeNamespace(portTypePrefix, portType.getNamespaceURI());

            writer.writeCharacters(portTypePrefix + ":" + portType.getLocalPart());

            writer.writeEndElement();

        }

        //Write service and Port info

        if (service != null) {

            if (!(service.getNamespaceURI().equals("") || service.getLocalPart().equals(""))) {

                writer.writeStartElement(AddressingVersion.MEMBER.getPrefix(),

                        AddressingVersion.MEMBER.eprType.serviceName,

                        AddressingVersion.MEMBER.nsUri);

                String servicePrefix = service.getPrefix();

                if (servicePrefix == null || servicePrefix.equals("")) {

                    //TODO check prefix again

                    servicePrefix = "wsns";