/*
    * Copyright 2025 The Netty Project
    *
    * The Netty Project 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:
    *
    *   https://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.
   */
  package io.netty.handler.codec.compression;
  
  import io.netty.buffer.ByteBuf;
  import io.netty.buffer.ByteBufAllocator;
  import io.netty.buffer.ByteBufUtil;
  import io.netty.util.internal.ObjectUtil;
  import io.netty.util.internal.UnstableApi;
  
  import java.util.Objects;
  import java.util.zip.CRC32;
  import java.util.zip.DataFormatException;
  import java.util.zip.Deflater;
  import java.util.zip.Inflater;
  
  /**
   * Decompress a {@link ByteBuf} using the inflate algorithm.
   */
  @UnstableApi
  public final class JdkZlibDecompressor extends InputBufferingDecompressor {
      private static final int FHCRC = 0x02;
      private static final int FEXTRA = 0x04;
      private static final int FNAME = 0x08;
      private static final int FCOMMENT = 0x10;
      private static final int FRESERVED = 0xE0;
  
      /**
       * Smallest output buffer we hand to {@link Inflater#inflate(byte[], int, int)}. The number of remaining input
       * bytes is only a hint for how much output to expect: the inflater may still hold decoded data that did not fit
       * into the previous output buffer, and by then it may have consumed all input bytes already
       * ({@link Inflater#getRemaining()} == 0). Inflating into a zero-sized buffer can never make progress.
       */
      private static final int MIN_OUTPUT_BUFFER_SIZE = 512;
  
      private Inflater inflater;
      private final int maxAllocation;
      private final byte[] dictionary;
  
      // GZIP related
      private final ByteBufChecksum crc;
      private final boolean decompressConcatenated;
  
      private enum GzipState {
          HEADER_START,
          HEADER_END,
          FLG_READ,
          XLEN_READ,
          SKIP_FNAME,
          SKIP_COMMENT,
          PROCESS_FHCRC,
          FOOTER_START,
      }
  
      private GzipState gzipState = GzipState.HEADER_START;
      private int flags = -1;
      private int xlen = -1;
  
      private boolean decideZlibOrNone;
      private boolean finished;
      private boolean gzipMemberFinished;
      /**
       * If this is true, part of the input buffer is still in use by the {@link #inflater}, so we shouldn't touch that
       * buffer too much (e.g. compact it).
       */
      private boolean inputBufferInInflater;
      /**
       * If this is true, the last {@link Inflater#inflate(byte[], int, int)} filled the output buffer completely, so
       * the inflater may still hold decoded data even if {@link Inflater#needsInput()} reports that all input was
       * consumed.
       */
      private boolean inflaterHasPendingOutput;
  
      JdkZlibDecompressor(Builder builder, ByteBufAllocator allocator) {
          super(allocator);
          maxAllocation = builder.maxAllocation;
          dictionary = builder.dictionary;
          this.decompressConcatenated = builder.decompressConcatenated;
          switch (builder.wrapper) {
              case GZIP:
                  inflater = new Inflater(true);
                  crc = ByteBufChecksum.wrapChecksum(new CRC32());
                  break;
              case NONE:
                  inflater = new Inflater(true);
                  crc = null;
                 break;
             case ZLIB:
                 inflater = new Inflater();
                 crc = null;
                 break;
             case ZLIB_OR_NONE:
                 // Postpone the decision until decode(...) is called.
                 decideZlibOrNone = true;
                 crc = null;
                 break;
             default:
                 throw new IllegalArgumentException("Only GZIP or ZLIB is supported, but you used " + builder.wrapper);
         }
     }
 
     @Override
     public Status status() throws DecompressionException {
         if (finished) {
             return Status.COMPLETE;
         } else if (inflaterHasPendingOutput) {
             return Status.NEED_OUTPUT;
         } else if (inflater == null || inflater.needsInput() || gzipState == GzipState.FOOTER_START) {
             return Status.NEED_INPUT;
         } else {
             return Status.NEED_OUTPUT;
         }
     }
 
     @Override
     public void endOfInput() throws DecompressionException {
         if (finished) {
             return;
         }
         if (crc != null && decompressConcatenated && gzipMemberFinished &&
                 gzipState == GzipState.HEADER_START && available() == 0) {
             finished = true;
             return;
         }
         throw new DecompressionException("Compressed stream ended before the end-of-stream marker");
     }
 
     @Override
     void processInput(ByteBuf buf) throws DecompressionException {
         if (inputBufferInInflater) {
             throw new IllegalStateException("Not in state NEED_INPUT");
         }
 
         int readableBytes = buf.readableBytes();
         if (readableBytes == 0) {
             return;
         }
 
         if (decideZlibOrNone) {
             // First two bytes are needed to decide if it's a ZLIB stream.
             if (readableBytes < 2) {
                 return;
             }
 
             boolean nowrap = !looksLikeZlib(buf.getShort(buf.readerIndex()));
             inflater = new Inflater(nowrap);
             decideZlibOrNone = false;
         }
 
         if (crc != null) {
             if (gzipState != GzipState.HEADER_END) {
                 if (gzipState == GzipState.FOOTER_START) {
                     if (!handleGzipFooter(buf)) {
                         // Either there was not enough data or the input is finished.
                         return;
                     }
                     // If we consumed the footer we will start with the header again.
                     assert gzipState == GzipState.HEADER_START;
                 }
                 if (!readGZIPHeader(buf)) {
                     // There was not enough data readable to read the GZIP header.
                     return;
                 }
                 // Some bytes may have been consumed, and so we must re-set the number of readable bytes.
                 readableBytes = buf.readableBytes();
                 if (readableBytes == 0) {
                     return;
                 }
             }
         }
 
         if (inflater.needsInput()) {
             if (buf.hasArray()) {
                 inflater.setInput(buf.array(), buf.arrayOffset() + buf.readerIndex(), readableBytes);
             } else {
                 inflater.setInput(ByteBufUtil.getBytes(buf));
             }
             inputBufferInInflater = true;
         }
     }
 
     private void consumeInput(ByteBuf buf) {
         if (inputBufferInInflater) {
             buf.readerIndex(buf.writerIndex() - inflater.getRemaining());
             if (inflater.getRemaining() == 0) {
                 inputBufferInInflater = false;
             }
         }
     }
 
     @Override
     ByteBuf processOutput(ByteBuf buf) throws DecompressionException {
         int proposedCapacity = Math.max(inflater.getRemaining() << 1, MIN_OUTPUT_BUFFER_SIZE);
         int targetCapacity = maxAllocation == 0
                 ? proposedCapacity : Math.min(maxAllocation, proposedCapacity);
         ByteBuf decompressed = allocator.heapBuffer(targetCapacity);
         boolean success = false;
         try {
             byte[] outArray = decompressed.array();
             int writerIndex = decompressed.writerIndex();
             int outIndex = decompressed.arrayOffset() + writerIndex;
             int writableBytes = decompressed.writableBytes();
             int outputLength;
             try {
                 outputLength = inflater.inflate(outArray, outIndex, writableBytes);
             } catch (DataFormatException e) {
                 throw new DecompressionException("decompression failure", e);
             }
             consumeInput(buf);
             if (outputLength > 0) {
                 decompressed.writerIndex(writerIndex + outputLength);
                 if (crc != null) {
                     crc.update(outArray, outIndex, outputLength);
                 }
             }
             if (inflater.needsDictionary()) {
                 if (dictionary == null) {
                     throw new DecompressionException(
                             "decompression failure, unable to set dictionary as none was specified");
                 }
                 try {
                     inflater.setDictionary(dictionary);
                 } catch (IllegalArgumentException e) {
                     // The dictionary ID in the stream header does not match the configured dictionary.
                     throw new DecompressionException("decompression failure, dictionary mismatch", e);
                 }
             }
             if (inflater.finished()) {
                 inputBufferInInflater = false;
                 if (crc == null) {
                     finished = true; // Do not decode anymore.
                 } else {
                     gzipState = GzipState.FOOTER_START;
                     // potentially consume footer
                     processInput(buf);
                 }
             }
             // If we filled the whole buffer the inflater may still have decoded data left that it could not write.
             // In that case we must ask for another output buffer, as needsInput() only tells us that all input
             // bytes were consumed, not that all output was produced.
             inflaterHasPendingOutput = outputLength == writableBytes && !inflater.finished();
             success = true;
             return decompressed;
         } finally {
             if (!success) {
                 decompressed.release();
             }
         }
     }
 
     private boolean handleGzipFooter(ByteBuf in) {
         if (readGZIPFooter(in)) {
             gzipMemberFinished = true;
             finished = !decompressConcatenated;
 
             if (!finished) {
                 inflater.reset();
                 crc.reset();
                 xlen = -1;
                 gzipState = GzipState.HEADER_START;
                 return true;
             }
         }
         return false;
     }
 
     private boolean readGZIPHeader(ByteBuf in) {
         switch (gzipState) {
             case HEADER_START:
                 if (in.readableBytes() < 10) {
                     return false;
                 }
                 // read magic numbers
                 int magic0 = in.readUnsignedByte();
                 int magic1 = in.readUnsignedByte();
 
                 if (magic0 != 31 || magic1 != 139) {
                     throw new DecompressionException("Input is not in the GZIP format");
                 }
                 crc.update(magic0);
                 crc.update(magic1);
 
                 int method = in.readUnsignedByte();
                 if (method != Deflater.DEFLATED) {
                     throw new DecompressionException("Unsupported compression method "
                             + method + " in the GZIP header");
                 }
                 crc.update(method);
 
                 flags = in.readUnsignedByte();
                 crc.update(flags);
 
                 if ((flags & FRESERVED) != 0) {
                     throw new DecompressionException(
                             "Reserved flags are set in the GZIP header");
                 }
 
                 // mtime (int)
                 crc.update(in, in.readerIndex(), 4);
                 in.skipBytes(4);
 
                 crc.update(in.readUnsignedByte()); // extra flags
                 crc.update(in.readUnsignedByte()); // operating system
 
                 gzipState = GzipState.FLG_READ;
                 // fall through
             case FLG_READ:
                 if ((flags & FEXTRA) != 0) {
                     if (in.readableBytes() < 2) {
                         return false;
                     }
                     int xlen1 = in.readUnsignedByte();
                     int xlen2 = in.readUnsignedByte();
                     crc.update(xlen1);
                     crc.update(xlen2);
 
                     xlen = xlen2 << 8 | xlen1;
                 }
                 gzipState = GzipState.XLEN_READ;
                 // fall through
             case XLEN_READ:
                 if (xlen != -1) {
                     if (in.readableBytes() < xlen) {
                         return false;
                     }
                     crc.update(in, in.readerIndex(), xlen);
                     in.skipBytes(xlen);
                 }
                 gzipState = GzipState.SKIP_FNAME;
                 // fall through
             case SKIP_FNAME:
                 if (!skipIfNeeded(in, FNAME)) {
                     return false;
                 }
                 gzipState = GzipState.SKIP_COMMENT;
                 // fall through
             case SKIP_COMMENT:
                 if (!skipIfNeeded(in, FCOMMENT)) {
                     return false;
                 }
                 gzipState = GzipState.PROCESS_FHCRC;
                 // fall through
             case PROCESS_FHCRC:
                 if ((flags & FHCRC) != 0) {
                     if (!verifyCrc16(in)) {
                         return false;
                     }
                 }
                 crc.reset();
                 gzipState = GzipState.HEADER_END;
                 // fall through
             case HEADER_END:
                 return true;
             default:
                 throw new IllegalStateException();
         }
     }
 
     /**
      * Skip bytes in the input if needed until we find the end marker {@code 0x00}.
      * @param   in the input
      * @param   flagMask the mask that should be present in the {@code flags} when we need to skip bytes.
      * @return  {@code true} if the operation is complete and we can move to the next state, {@code false} if we need
      *          the retry again once we have more readable bytes.
      */
     private boolean skipIfNeeded(ByteBuf in, int flagMask) {
         if ((flags & flagMask) != 0) {
             for (;;) {
                 if (!in.isReadable()) {
                     // We didnt find the end yet, need to retry again once more data is readable
                     return false;
                 }
                 int b = in.readUnsignedByte();
                 crc.update(b);
                 if (b == 0x00) {
                     break;
                 }
             }
         }
         // Skip is handled, we can move to the next processing state.
         return true;
     }
 
     /**
      * Read the GZIP footer.
      *
      * @param   in the input.
      * @return  {@code true} if the footer could be read, {@code false} if the read could not be performed as
      *          the input {@link ByteBuf} doesn't have enough readable bytes (8 bytes).
      */
     private boolean readGZIPFooter(ByteBuf in) {
         if (in.readableBytes() < 8) {
             return false;
         }
 
         boolean enoughData = verifyCrc(in);
         assert enoughData;
 
         // read ISIZE and verify
         int dataLength = in.readIntLE();
         int readLength = inflater.getTotalOut();
         if (dataLength != readLength) {
             throw new DecompressionException(
                     "Number of bytes mismatch. Expected: " + dataLength + ", Got: " + readLength);
         }
         return true;
     }
 
     /**
      * Verifies CRC.
      *
      * @param   in the input.
      * @return  {@code true} if verification could be performed, {@code false} if verification could not be performed as
      *          the input {@link ByteBuf} doesn't have enough readable bytes (4 bytes).
      */
     private boolean verifyCrc(ByteBuf in) {
         if (in.readableBytes() < 4) {
             return false;
         }
         long crcValue = in.readUnsignedIntLE();
 
         long readCrc = crc.getValue();
         if (crcValue != readCrc) {
             throw new DecompressionException(
                     "CRC value mismatch. Expected: " + crcValue + ", Got: " + readCrc);
         }
         return true;
     }
 
     private boolean verifyCrc16(ByteBuf in) {
         if (in.readableBytes() < 2) {
             return false;
         }
 
         int crc16Value = in.readUnsignedShortLE();
         // the two least significant bytes from the CRC32
         int readCrc16 = (int) (crc.getValue() & 0xFFFF);
 
         if (crc16Value != readCrc16) {
             throw new DecompressionException(
                     "CRC16 value mismatch. Expected: " + crc16Value + ", Got: " + readCrc16);
         }
         return true;
     }
 
     /*
      * Returns true if the cmf_flg parameter (think: first two bytes of a zlib stream)
      * indicates that this is a zlib stream.
      * <p>
      * You can lookup the details in the ZLIB RFC:
      * <a href="https://tools.ietf.org/html/rfc1950#section-2.2">RFC 1950</a>.
      */
     private static boolean looksLikeZlib(short cmf_flg) {
         return (cmf_flg & 0x7800) == 0x7800 &&
                 cmf_flg % 31 == 0;
     }
 
     @Override
     public void close() {
         try {
             super.close();
         } finally {
             if (inflater != null) {
                 inflater.end();
                 inflater = null;
             }
         }
     }
 
     @UnstableApi
     public static Builder builder() {
         return new Builder();
     }
 
     @UnstableApi
     public static final class Builder extends Decompressor.AbstractDecompressorBuilder {
         private ZlibWrapper wrapper = ZlibWrapper.ZLIB;
         private byte[] dictionary;
         private int maxAllocation = 1024 * 1024;
         boolean decompressConcatenated;
 
         Builder() {
         }
 
         /**
          * Set the wrapper format for the deflated data. Defaults to {@link ZlibWrapper#ZLIB}.
          *
          * @param wrapper The wrapper format
          * @return This builder
          */
         public Builder wrapper(ZlibWrapper wrapper) {
             this.wrapper = Objects.requireNonNull(wrapper, "wrapper");
             return this;
         }
 
         /**
          * Set the preset dictionary to use. Defaults to no dictionary.
          *
          * @param dictionary The dictionary
          * @return This builder
          */
         public Builder dictionary(byte[] dictionary) {
             this.dictionary = dictionary;
             return this;
         }
 
         /**
          * Set the maximum output buffer size. Defaults to 1M.
          *
          * @param maxAllocation The maximum output buffer size.
          * @return This builder
          */
         public Builder maxAllocation(int maxAllocation) {
             this.maxAllocation = ObjectUtil.checkPositiveOrZero(maxAllocation, "maxAllocation");
             return this;
         }
 
         public Builder decompressConcatenated(boolean decompressConcatenated) {
             this.decompressConcatenated = decompressConcatenated;
             return this;
         }
 
         @Override
         public Decompressor build(ByteBufAllocator allocator) throws DecompressionException {
             return new DefensiveDecompressor(new JdkZlibDecompressor(this, allocator));
         }
     }
 }