GZIPHeader.java

/*
 * Copyright (c) 2011 ymnk, JCraft,Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted
 * provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions
 * and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other materials provided with
 * the distribution.
 *
 * 3. The names of the authors may not be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL JCRAFT, INC. OR ANY CONTRIBUTORS TO THIS SOFTWARE BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/*
 * This program is based on zlib-1.1.3, so all credit should go authors Jean-loup
 * Gailly(jloup@gzip.org) and Mark Adler(madler@alumni.caltech.edu) and contributors of zlib.
 */

package com.jcraft.jsch.jzlib;

import java.nio.charset.StandardCharsets;

/**
 * @see <a href="http://www.ietf.org/rfc/rfc1952.txt">http://www.ietf.org/rfc/rfc1952.txt</a>
 */
final class GZIPHeader implements Cloneable {

  static final byte OS_MSDOS = (byte) 0x00;
  static final byte OS_AMIGA = (byte) 0x01;
  static final byte OS_VMS = (byte) 0x02;
  static final byte OS_UNIX = (byte) 0x03;
  static final byte OS_ATARI = (byte) 0x05;
  static final byte OS_OS2 = (byte) 0x06;
  static final byte OS_MACOS = (byte) 0x07;
  static final byte OS_TOPS20 = (byte) 0x0a;
  static final byte OS_WIN32 = (byte) 0x0b;
  static final byte OS_VMCMS = (byte) 0x04;
  static final byte OS_ZSYSTEM = (byte) 0x08;
  static final byte OS_CPM = (byte) 0x09;
  static final byte OS_QDOS = (byte) 0x0c;
  static final byte OS_RISCOS = (byte) 0x0d;
  static final byte OS_UNKNOWN = (byte) 0xff;

  boolean text = false;
  private boolean fhcrc = false;
  int xflags;
  int os = 255;
  byte[] extra;
  byte[] name;
  byte[] comment;
  int hcrc;
  long crc;
  boolean done = false;
  long mtime = 0;

  void setModifiedTime(long mtime) {
    this.mtime = mtime;
  }

  long getModifiedTime() {
    return mtime;
  }

  void setOS(int os) {
    if ((0 <= os && os <= 13) || os == 255)
      this.os = os;
    else
      throw new IllegalArgumentException("os: " + os);
  }

  int getOS() {
    return os;
  }

  void setName(String name) {
    this.name = name.getBytes(StandardCharsets.ISO_8859_1);
  }

  String getName() {
    if (name == null)
      return "";
    return new String(name, StandardCharsets.ISO_8859_1);
  }

  void setComment(String comment) {
    this.comment = comment.getBytes(StandardCharsets.ISO_8859_1);
  }

  String getComment() {
    if (comment == null)
      return "";
    return new String(comment, StandardCharsets.ISO_8859_1);
  }

  void setCRC(long crc) {
    this.crc = crc;
  }

  long getCRC() {
    return crc;
  }

  void put(Deflate d) {
    int flag = 0;
    if (text) {
      flag |= 1; // FTEXT
    }
    if (fhcrc) {
      flag |= 2; // FHCRC
    }
    if (extra != null) {
      flag |= 4; // FEXTRA
    }
    if (name != null) {
      flag |= 8; // FNAME
    }
    if (comment != null) {
      flag |= 16; // FCOMMENT
    }
    int xfl = 0;
    if (d.level == JZlib.Z_BEST_SPEED) {
      xfl |= 4;
    } else if (d.level == JZlib.Z_BEST_COMPRESSION) {
      xfl |= 2;
    }

    d.put_short((short) 0x8b1f); // ID1 ID2
    d.put_byte((byte) 8); // CM(Compression Method)
    d.put_byte((byte) flag);
    d.put_byte((byte) mtime);
    d.put_byte((byte) (mtime >> 8));
    d.put_byte((byte) (mtime >> 16));
    d.put_byte((byte) (mtime >> 24));
    d.put_byte((byte) xfl);
    d.put_byte((byte) os);

    if (extra != null) {
      d.put_byte((byte) extra.length);
      d.put_byte((byte) (extra.length >> 8));
      d.put_byte(extra, 0, extra.length);
    }

    if (name != null) {
      d.put_byte(name, 0, name.length);
      d.put_byte((byte) 0);
    }

    if (comment != null) {
      d.put_byte(comment, 0, comment.length);
      d.put_byte((byte) 0);
    }
  }

  @Override
  public Object clone() throws CloneNotSupportedException {
    GZIPHeader gheader = (GZIPHeader) super.clone();
    byte[] tmp;
    if (gheader.extra != null) {
      tmp = new byte[gheader.extra.length];
      System.arraycopy(gheader.extra, 0, tmp, 0, tmp.length);
      gheader.extra = tmp;
    }

    if (gheader.name != null) {
      tmp = new byte[gheader.name.length];
      System.arraycopy(gheader.name, 0, tmp, 0, tmp.length);
      gheader.name = tmp;
    }

    if (gheader.comment != null) {
      tmp = new byte[gheader.comment.length];
      System.arraycopy(gheader.comment, 0, tmp, 0, tmp.length);
      gheader.comment = tmp;
    }

    return gheader;
  }
}