/*
    * ====================================================================
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you under the Apache License, Version 2.0 (the
    * "License"); you may not use this file except in compliance
    * with the License.  You may obtain a copy of the License at
   *
   *   http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing,
   * software distributed under the License is distributed on an
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   * KIND, either express or implied.  See the License for the
   * specific language governing permissions and limitations
   * under the License.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */
  
  package org.apache.hc.core5.http;
  
  import java.io.Serializable;
  import java.nio.charset.Charset;
  import java.nio.charset.StandardCharsets;
  import java.nio.charset.UnsupportedCharsetException;
  import java.util.ArrayList;
  import java.util.Collections;
  import java.util.HashMap;
  import java.util.LinkedHashMap;
  import java.util.List;
  import java.util.Map;
  
  import org.apache.hc.core5.annotation.Contract;
  import org.apache.hc.core5.annotation.ThreadingBehavior;
  import org.apache.hc.core5.http.message.BasicHeaderValueFormatter;
  import org.apache.hc.core5.http.message.BasicHeaderValueParser;
  import org.apache.hc.core5.http.message.BasicNameValuePair;
  import org.apache.hc.core5.http.message.ParserCursor;
  import org.apache.hc.core5.util.Args;
  import org.apache.hc.core5.util.CharArrayBuffer;
  import org.apache.hc.core5.util.TextUtils;
  
  /**
   * Content type information consisting of a MIME type and an optional charset.
   * <p>
   * This class makes no attempts to verify validity of the MIME type.
   * The input parameters of the {@link #create(String, String)} method, however, may not
   * contain characters {@code <">, <;>, <,>} reserved by the HTTP specification.
   *
   * @since 4.2
   */
  @Contract(threading = ThreadingBehavior.IMMUTABLE)
  public final class ContentType implements Serializable {
  
      private static final long serialVersionUID = -7768694718232371896L;
  
      /**
       * Param that represent {@code charset} constant.
       */
      private static final String CHARSET = "charset";
  
      // constants
      public static final ContentType APPLICATION_ATOM_XML = create(
              "application/atom+xml", StandardCharsets.UTF_8);
      public static final ContentType APPLICATION_FORM_URLENCODED = create(
              "application/x-www-form-urlencoded", StandardCharsets.ISO_8859_1);
      public static final ContentType APPLICATION_JSON = create(
              "application/json", StandardCharsets.UTF_8);
  
      /**
       * Public constant media type for {@code application/x-ndjson}.
       * @since 5.1
       */
      public static final ContentType APPLICATION_NDJSON = create(
              "application/x-ndjson", StandardCharsets.UTF_8);
  
      public static final ContentType APPLICATION_OCTET_STREAM = create(
              "application/octet-stream", (Charset) null);
      /**
       * Public constant media type for {@code application/pdf}.
       * @since 5.1
       */
      public static final ContentType APPLICATION_PDF = create(
              "application/pdf", StandardCharsets.UTF_8);
  
      public static final ContentType APPLICATION_SOAP_XML = create(
              "application/soap+xml", StandardCharsets.UTF_8);
      public static final ContentType APPLICATION_SVG_XML = create(
              "application/svg+xml", StandardCharsets.UTF_8);
      public static final ContentType APPLICATION_XHTML_XML = create(
              "application/xhtml+xml", StandardCharsets.UTF_8);
     public static final ContentType APPLICATION_XML = create(
             "application/xml", StandardCharsets.UTF_8);
     /**
      * Public constant media type for {@code application/problem+json}.
      * @see <a href="https://tools.ietf.org/html/rfc7807#section-6.1">Problem Details for HTTP APIs, 6.1. application/problem+json</a>
      * @since 5.1
      */
     public static final ContentType APPLICATION_PROBLEM_JSON = create(
             "application/problem+json", StandardCharsets.UTF_8);
     /**
      * Public constant media type for {@code application/problem+xml}.
      * @see <a href="https://tools.ietf.org/html/rfc7807#section-6.2">Problem Details for HTTP APIs, 6.2. application/problem+xml</a>
      * @since 5.1
      */
     public static final ContentType APPLICATION_PROBLEM_XML = create(
             "application/problem+xml", StandardCharsets.UTF_8);
 
     /**
      * Public constant media type for {@code application/rss+xml}.
      * @since 5.1
      */
     public static final ContentType APPLICATION_RSS_XML = create(
             "application/rss+xml", StandardCharsets.UTF_8);
 
     public static final ContentType IMAGE_BMP = create(
             "image/bmp");
     public static final ContentType IMAGE_GIF = create(
             "image/gif");
     public static final ContentType IMAGE_JPEG = create(
             "image/jpeg");
     public static final ContentType IMAGE_PNG = create(
             "image/png");
     public static final ContentType IMAGE_SVG = create(
             "image/svg+xml");
     public static final ContentType IMAGE_TIFF = create(
             "image/tiff");
     public static final ContentType IMAGE_WEBP = create(
             "image/webp");
     public static final ContentType MULTIPART_FORM_DATA = create(
             "multipart/form-data", StandardCharsets.ISO_8859_1);
 
     /**
      * Public constant media type for {@code multipart/mixed}.
      * @since 5.1
      */
     public static final ContentType MULTIPART_MIXED = create(
             "multipart/mixed", StandardCharsets.ISO_8859_1);
 
     /**
      * Public constant media type for {@code multipart/related}.
      * @since 5.1
      */
     public static final ContentType MULTIPART_RELATED = create(
             "multipart/related", StandardCharsets.ISO_8859_1);
 
     public static final ContentType TEXT_HTML = create(
             "text/html", StandardCharsets.ISO_8859_1);
 
     /**
      * Public constant media type for {@code text/markdown}.
      * @since 5.1
      */
     public static final ContentType TEXT_MARKDOWN = create(
             "text/markdown", StandardCharsets.UTF_8);
 
     public static final ContentType TEXT_PLAIN = create(
             "text/plain", StandardCharsets.ISO_8859_1);
     public static final ContentType TEXT_XML = create(
             "text/xml", StandardCharsets.UTF_8);
     /**
      * Public constant media type for {@code text/event-stream}.
      * @see <a href="https://www.w3.org/TR/eventsource/">Server-Sent Events W3C recommendation</a>
      * @since 5.1
      */
     public static final ContentType TEXT_EVENT_STREAM = create(
             "text/event-stream", StandardCharsets.UTF_8);
 
     public static final ContentType WILDCARD = create(
             "*/*", (Charset) null);
 
     /**
      * An empty immutable {@code NameValuePair} array.
      */
     private static final NameValuePair[] EMPTY_NAME_VALUE_PAIR_ARRAY = {};
 
     /**
      * @deprecated To be removed in 6.0
      */
     @Deprecated
     private static final Map<String, ContentType> CONTENT_TYPE_MAP;
     static {
 
         final ContentType[] contentTypes = {
             APPLICATION_ATOM_XML,
             APPLICATION_FORM_URLENCODED,
             APPLICATION_JSON,
             APPLICATION_SVG_XML,
             APPLICATION_XHTML_XML,
             APPLICATION_XML,
             IMAGE_BMP,
             IMAGE_GIF,
             IMAGE_JPEG,
             IMAGE_PNG,
             IMAGE_SVG,
             IMAGE_TIFF,
             IMAGE_WEBP,
             MULTIPART_FORM_DATA,
             TEXT_HTML,
             TEXT_PLAIN,
             TEXT_XML };
         final HashMap<String, ContentType> map = new HashMap<>();
         for (final ContentType contentType: contentTypes) {
             map.put(contentType.getMimeType(), contentType);
         }
         CONTENT_TYPE_MAP = Collections.unmodifiableMap(map);
     }
 
     // defaults
     public static final ContentType DEFAULT_TEXT = TEXT_PLAIN;
     public static final ContentType DEFAULT_BINARY = APPLICATION_OCTET_STREAM;
 
     private final String mimeType;
     private final Charset charset;
     private final NameValuePair[] params;
 
     ContentType(
             final String mimeType,
             final Charset charset) {
         this.mimeType = mimeType;
         this.charset = charset;
         this.params = null;
     }
 
     ContentType(
             final String mimeType,
             final Charset charset,
             final NameValuePair[] params) {
         this.mimeType = mimeType;
         this.charset = charset;
         this.params = params;
     }
 
     public String getMimeType() {
         return this.mimeType;
     }
 
     public Charset getCharset() {
         return this.charset;
     }
 
     /**
      * Gets this Charset if it's non-null, otherwise, return the given {@code defaultCharset}.
      *
      * @param defaultCharset A default Charset.
      * @return this Charset if it's non-null, or the given {@code defaultCharset}.
      * @since 5.2
      */
     public Charset getCharset(final Charset defaultCharset) {
         return this.charset != null ? this.charset : defaultCharset;
     }
 
     /**
      * @since 4.3
      */
     public String getParameter(final String name) {
         Args.notEmpty(name, "Parameter name");
         if (this.params == null) {
             return null;
         }
         for (final NameValuePair param: this.params) {
             if (param.getName().equalsIgnoreCase(name)) {
                 return param.getValue();
             }
         }
         return null;
     }
 
     /**
      * Generates textual representation of this content type which can be used as the value
      * of a {@code Content-Type} header.
      */
     @Override
     public String toString() {
         final CharArrayBuffer buf = new CharArrayBuffer(64);
         buf.append(this.mimeType);
         if (this.params != null) {
             buf.append("; ");
             BasicHeaderValueFormatter.INSTANCE.formatParameters(buf, this.params, false);
         } else if (this.charset != null) {
             buf.append("; charset=");
             buf.append(this.charset.name());
         }
         return buf.toString();
     }
 
     private static boolean valid(final String s) {
         for (int i = 0; i < s.length(); i++) {
             final char ch = s.charAt(i);
             if (ch == '"' || ch == ',' || ch == ';') {
                 return false;
             }
         }
         return true;
     }
 
     /**
      * Creates a new instance of {@link ContentType}.
      *
      * @param mimeType MIME type. It may not be {@code null} or empty. It may not contain
      *        characters {@code <">, <;>, <,>} reserved by the HTTP specification.
      * @param charset charset.
      * @return content type
      */
     public static ContentType create(final String mimeType, final Charset charset) {
         final String normalizedMimeType = TextUtils.toLowerCase(Args.notBlank(mimeType, "MIME type"));
         Args.check(valid(normalizedMimeType), "MIME type may not contain reserved characters");
         return new ContentType(normalizedMimeType, charset);
     }
 
     /**
      * Creates a new instance of {@link ContentType} without a charset.
      *
      * @param mimeType MIME type. It may not be {@code null} or empty. It may not contain
      *        characters {@code <">, <;>, <,>} reserved by the HTTP specification.
      * @return content type
      */
     public static ContentType create(final String mimeType) {
         return create(mimeType, (Charset) null);
     }
 
     /**
      * Creates a new instance of {@link ContentType}.
      *
      * @param mimeType MIME type. It may not be {@code null} or empty. It may not contain
      *        characters {@code <">, <;>, <,>} reserved by the HTTP specification.
      * @param charset charset. It may not contain characters {@code <">, <;>, <,>} reserved by the HTTP
      *        specification. This parameter is optional.
      * @return content type
      * @throws UnsupportedCharsetException Thrown when the named charset is not available in
      * this instance of the Java virtual machine
      */
     public static ContentType create(
             final String mimeType, final String charset) throws UnsupportedCharsetException {
         return create(mimeType, !TextUtils.isBlank(charset) ? Charset.forName(charset) : null);
     }
 
     private static ContentType create(final HeaderElement helem, final boolean strict) {
         final String mimeType = helem.getName();
         if (TextUtils.isBlank(mimeType)) {
             return null;
         }
         return create(helem.getName(), helem.getParameters(), strict);
     }
 
     private static ContentType create(final String mimeType, final NameValuePair[] params, final boolean strict) {
         Charset charset = null;
         if (params != null) {
             for (final NameValuePair param : params) {
                 if (param.getName().equalsIgnoreCase(CHARSET)) {
                     final String s = param.getValue();
                     if (!TextUtils.isBlank(s)) {
                         try {
                             charset = Charset.forName(s);
                         } catch (final UnsupportedCharsetException ex) {
                             if (strict) {
                                 throw ex;
                             }
                         }
                     }
                     break;
                 }
             }
         }
         return new ContentType(mimeType, charset, params != null && params.length > 0 ? params : null);
     }
 
     /**
      * Creates a new instance of {@link ContentType} with the given parameters.
      *
      * @param mimeType MIME type. It may not be {@code null} or empty. It may not contain
      *        characters {@code <">, <;>, <,>} reserved by the HTTP specification.
      * @param params parameters.
      * @return content type
      *
      * @since 4.4
      */
     public static ContentType create(
             final String mimeType, final NameValuePair... params) throws UnsupportedCharsetException {
         final String type = TextUtils.toLowerCase(Args.notBlank(mimeType, "MIME type"));
         Args.check(valid(type), "MIME type may not contain reserved characters");
         return create(mimeType, params != null ? params.clone() : null, true);
     }
 
     /**
      * Parses textual representation of {@code Content-Type} value.
      *
      * @param s text
      * @return content type {@code Content-Type} value or null.
      * @throws UnsupportedCharsetException Thrown when the named charset is not available in
      * this instance of the Java virtual machine
      */
     public static ContentType parse(final CharSequence s) throws UnsupportedCharsetException {
         return parse(s, true);
     }
 
     /**
      * Parses textual representation of {@code Content-Type} value ignoring invalid charsets.
      *
      * @param s text
      * @return content type {@code Content-Type} value or null.
      * @throws UnsupportedCharsetException Thrown when the named charset is not available in
      * this instance of the Java virtual machine
      */
     public static ContentType parseLenient(final CharSequence s) throws UnsupportedCharsetException {
         return parse(s, false);
     }
 
     private static ContentType parse(final CharSequence s, final boolean strict) throws UnsupportedCharsetException {
         if (TextUtils.isBlank(s)) {
             return null;
         }
         final ParserCursor cursor = new ParserCursor(0, s.length());
         final HeaderElement[] elements = BasicHeaderValueParser.INSTANCE.parseElements(s, cursor);
         if (elements.length > 0) {
             return create(elements[0], strict);
         }
         return null;
     }
 
     /**
      * Returns {@code Content-Type} for the given MIME type.
      *
      * @param mimeType MIME type
      * @return content type or {@code null} if not known.
      *
      * @since 4.5
      *
      * @deprecated Do not use. This method was made public by mistake.
      */
     @Deprecated
     public static ContentType getByMimeType(final String mimeType) {
         if (mimeType == null) {
             return null;
         }
         return CONTENT_TYPE_MAP.get(mimeType);
     }
 
     /**
      * Gets a ContentType's Charset if neither are null, otherwise, return the given {@code defaultCharset}.
      *
      * @param contentType the ContentType to test and query.
      * @param defaultCharset a default Charset.
      * @return the ContentType's Charset if neither are null, otherwise, return the given {@code defaultCharset}.
      * @since 5.2
      */
     public static Charset getCharset(final ContentType contentType, final Charset defaultCharset) {
         return contentType != null ? contentType.getCharset(defaultCharset) : defaultCharset;
     }
 
     /**
      * Creates a new instance with this MIME type and the given Charset.
      *
      * @param charset charset
      * @return a new instance with this MIME type and the given Charset.
      * @since 4.3
      */
     public ContentType withCharset(final Charset charset) {
         return create(this.getMimeType(), charset);
     }
 
     /**
      * Creates a new instance with this MIME type and the given Charset name.
      *
      * @param charset name
      * @return a new instance with this MIME type and the given Charset name.
      * @throws UnsupportedCharsetException Thrown when the named charset is not available in
      * this instance of the Java virtual machine
      * @since 4.3
      */
     public ContentType withCharset(final String charset) {
         return create(this.getMimeType(), charset);
     }
 
     /**
      * Creates a new instance with this MIME type and the given parameters.
      *
      * @param params parameters.
      * @return a new instance with this MIME type and the given parameters.
      * @since 4.4
      */
     public ContentType withParameters(
             final NameValuePair... params) throws UnsupportedCharsetException {
         if (params.length == 0) {
             return this;
         }
         final Map<String, String> paramMap = new LinkedHashMap<>();
         if (this.params != null) {
             for (final NameValuePair param: this.params) {
                 paramMap.put(param.getName(), param.getValue());
             }
         }
         for (final NameValuePair param: params) {
             paramMap.put(param.getName(), param.getValue());
         }
         final List<NameValuePair> newParams = new ArrayList<>(paramMap.size() + 1);
         if (this.charset != null && !paramMap.containsKey(CHARSET)) {
             newParams.add(new BasicNameValuePair(CHARSET, this.charset.name()));
         }
         for (final Map.Entry<String, String> entry: paramMap.entrySet()) {
             newParams.add(new BasicNameValuePair(entry.getKey(), entry.getValue()));
         }
         return create(this.getMimeType(), newParams.toArray(EMPTY_NAME_VALUE_PAIR_ARRAY), true);
     }
 
     public boolean isSameMimeType(final ContentType contentType) {
         return contentType != null && mimeType.equalsIgnoreCase(contentType.getMimeType());
     }
 
 }