net.sourceforge.plantuml.code.deflate.Decompressor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-gplv2 Show documentation
Show all versions of plantuml-gplv2 Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
* |
* | PlantUML : a free UML diagram generator
* |
* +=======================================================================
*
* (C) Copyright 2009-2024, Arnaud Roques
*
* Project Info: https://plantuml.com
*
* If you like this project or if you find it useful, you can support us at:
*
* https://plantuml.com/patreon (only 1$ per month!)
* https://plantuml.com/liberapay (only 1€ per month!)
* https://plantuml.com/paypal
*
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License V2.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [GNU General Public License V2]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*
* 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.
*
* PlantUML can occasionally display sponsored or advertising messages. Those
* messages are usually generated on welcome or error images and never on
* functional diagrams.
* See https://plantuml.com/professional if you want to remove them
*
* Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
* are owned by the author of their corresponding sources code (that is, their
* textual description in PlantUML language). Those images are not covered by
* this GPL v2 license.
*
* The generated images can then be used without any reference to the GPL v2 license.
* It is not even necessary to stipulate that they have been generated with PlantUML,
* although this will be appreciated by the PlantUML team.
*
* There is an exception : if the textual description in PlantUML language is also covered
* by any license, then the generated images are logically covered
* by the very same license.
*
* This is the IGY distribution (Install GraphViz by Yourself).
* You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
* (see https://plantuml.com/graphviz-dot )
*
* Icons provided by OpenIconic : https://useiconic.com/open
* Archimate sprites provided by Archi : http://www.archimatetool.com
* Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
* Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
* ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
* ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
* CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
* Brotli (c) by the Brotli Authors https://github.com/google/brotli
* Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
* Twemoji (c) by Twitter at https://twemoji.twitter.com/
*
*/
package net.sourceforge.plantuml.code.deflate;
import java.io.EOFException;
import java.io.IOException;
import java.util.Arrays;
import java.util.Objects;
import java.util.zip.DataFormatException;
/**
* Decompresses raw DEFLATE data (without zlib or gzip container) into bytes.
*/
public final class Decompressor {
/*---- Public functions ----*/
/**
* Reads from the specified input stream, decompress the data, and returns a new
* byte array.
*
* @param in the bit input stream to read from (not {@code null})
* @throws NullPointerException if the input stream is {@code null}
* @throws DataFormatException if the DEFLATE data is malformed
*/
public static byte[] decompress(BitInputStream in) throws IOException, DataFormatException {
OutputStreamProtected out = new OutputStreamProtected();
decompress(in, out);
return out.toByteArray();
}
/**
* Reads from the specified input stream, decompress the data, and writes to the
* specified output stream.
*
* @param in the bit input stream to read from (not {@code null})
* @param out the byte output stream to write to (not {@code null})
* @throws NullPointerException if the input or output stream is {@code null}
* @throws DataFormatException if the DEFLATE data is malformed
*/
public static void decompress(BitInputStream in, OutputStreamProtected out)
throws IOException, DataFormatException {
new Decompressor(in, out);
}
/*---- Private implementation ----*/
private BitInputStream input;
private OutputStreamProtected output;
private ByteHistory dictionary;
// Constructor, which immediately performs decompression
private Decompressor(BitInputStream in, OutputStreamProtected out) throws IOException, DataFormatException {
// Initialize fields
input = Objects.requireNonNull(in);
output = Objects.requireNonNull(out);
dictionary = new ByteHistory(32 * 1024);
// Process the stream of blocks
boolean isFinal;
do {
// Read the block header
isFinal = in.readNoEof() == 1; // bfinal
int type = readInt(2); // btype
// Decompress rest of block based on the type
if (type == 0)
decompressUncompressedBlock();
else if (type == 1)
decompressHuffmanBlock(FIXED_LITERAL_LENGTH_CODE, FIXED_DISTANCE_CODE);
else if (type == 2) {
CanonicalCode[] litLenAndDist = decodeHuffmanCodes();
decompressHuffmanBlock(litLenAndDist[0], litLenAndDist[1]);
} else if (type == 3)
throw new DataFormatException("Reserved block type");
else
throw new IllegalStateException("Impossible value");
} while (!isFinal);
}
/*-- The constant code trees for static Huffman codes (btype = 1) --*/
private static final CanonicalCode FIXED_LITERAL_LENGTH_CODE;
private static final CanonicalCode FIXED_DISTANCE_CODE;
static { // Make temporary tables of canonical code lengths
int[] llcodelens = new int[288];
Arrays.fill(llcodelens, 0, 144, 8);
Arrays.fill(llcodelens, 144, 256, 9);
Arrays.fill(llcodelens, 256, 280, 7);
Arrays.fill(llcodelens, 280, 288, 8);
FIXED_LITERAL_LENGTH_CODE = new CanonicalCode(llcodelens);
int[] distcodelens = new int[32];
Arrays.fill(distcodelens, 5);
FIXED_DISTANCE_CODE = new CanonicalCode(distcodelens);
}
/*-- Method for reading and decoding dynamic Huffman codes (btype = 2) --*/
// Reads from the bit input stream, decodes the Huffman code
// specifications into code trees, and returns the trees.
private CanonicalCode[] decodeHuffmanCodes() throws IOException, DataFormatException {
int numLitLenCodes = readInt(5) + 257; // hlit + 257
int numDistCodes = readInt(5) + 1; // hdist + 1
// Read the code length code lengths
int numCodeLenCodes = readInt(4) + 4; // hclen + 4
int[] codeLenCodeLen = new int[19]; // This array is filled in a strange order
codeLenCodeLen[16] = readInt(3);
codeLenCodeLen[17] = readInt(3);
codeLenCodeLen[18] = readInt(3);
codeLenCodeLen[0] = readInt(3);
for (int i = 0; i < numCodeLenCodes - 4; i++) {
int j = (i % 2 == 0) ? (8 + i / 2) : (7 - i / 2);
codeLenCodeLen[j] = readInt(3);
}
// Create the code length code
CanonicalCode codeLenCode;
try {
codeLenCode = new CanonicalCode(codeLenCodeLen);
} catch (IllegalArgumentException e) {
throw new DataFormatException(e.getMessage());
}
// Read the main code lengths and handle runs
int[] codeLens = new int[numLitLenCodes + numDistCodes];
for (int codeLensIndex = 0; codeLensIndex < codeLens.length;) {
int sym = codeLenCode.decodeNextSymbol(input);
if (0 <= sym && sym <= 15) {
codeLens[codeLensIndex] = sym;
codeLensIndex++;
} else {
int runLen;
int runVal = 0;
if (sym == 16) {
if (codeLensIndex == 0)
throw new DataFormatException("No code length value to copy");
runLen = readInt(2) + 3;
runVal = codeLens[codeLensIndex - 1];
} else if (sym == 17)
runLen = readInt(3) + 3;
else if (sym == 18)
runLen = readInt(7) + 11;
else
throw new IllegalStateException("Symbol out of range");
int end = codeLensIndex + runLen;
if (end > codeLens.length)
throw new DataFormatException("Run exceeds number of codes");
Arrays.fill(codeLens, codeLensIndex, end, runVal);
codeLensIndex = end;
}
}
// Create literal-length code tree
int[] litLenCodeLen = Arrays.copyOf(codeLens, numLitLenCodes);
CanonicalCode litLenCode;
try {
litLenCode = new CanonicalCode(litLenCodeLen);
} catch (IllegalArgumentException e) {
throw new DataFormatException(e.getMessage());
}
// Create distance code tree with some extra processing
int[] distCodeLen = Arrays.copyOfRange(codeLens, numLitLenCodes, codeLens.length);
CanonicalCode distCode;
if (distCodeLen.length == 1 && distCodeLen[0] == 0)
distCode = null; // Empty distance code; the block shall be all literal symbols
else {
// Get statistics for upcoming logic
int oneCount = 0;
int otherPositiveCount = 0;
for (int x : distCodeLen) {
if (x == 1)
oneCount++;
else if (x > 1)
otherPositiveCount++;
}
// Handle the case where only one distance code is defined
if (oneCount == 1 && otherPositiveCount == 0) {
// Add a dummy invalid code to make the Huffman tree complete
distCodeLen = Arrays.copyOf(distCodeLen, 32);
distCodeLen[31] = 1;
}
try {
distCode = new CanonicalCode(distCodeLen);
} catch (IllegalArgumentException e) {
throw new DataFormatException(e.getMessage());
}
}
return new CanonicalCode[] { litLenCode, distCode };
}
/*-- Block decompression methods --*/
// Handles and copies an uncompressed block from the bit input stream.
private void decompressUncompressedBlock() throws IOException, DataFormatException {
// Discard bits to align to byte boundary
while (input.getBitPosition() != 0)
input.readNoEof();
// Read length
int len = readInt(16);
int nlen = readInt(16);
if ((len ^ 0xFFFF) != nlen)
throw new DataFormatException("Invalid length in uncompressed block");
// Copy bytes
for (int i = 0; i < len; i++) {
int b = input.readByte();
if (b == -1)
throw new EOFException();
output.write(b);
dictionary.append(b);
}
}
// Decompresses a Huffman-coded block from the bit input stream based on the
// given Huffman codes.
private void decompressHuffmanBlock(CanonicalCode litLenCode, CanonicalCode distCode)
throws IOException, DataFormatException {
Objects.requireNonNull(litLenCode);
// distCode is allowed to be null
while (true) {
int sym = litLenCode.decodeNextSymbol(input);
if (sym == 256) // End of block
break;
if (sym < 256) { // Literal byte
output.write(sym);
dictionary.append(sym);
} else { // Length and distance for copying
int run = decodeRunLength(sym);
if (run < 3 || run > 258)
throw new IllegalStateException("Invalid run length");
if (distCode == null)
throw new DataFormatException("Length symbol encountered with empty distance code");
int distSym = distCode.decodeNextSymbol(input);
int dist = decodeDistance(distSym);
if (dist < 1 || dist > 32768)
throw new IllegalStateException("Invalid distance");
dictionary.copy(dist, run, output);
}
}
}
/*-- Symbol decoding methods --*/
// Returns the run length based on the given symbol and possibly reading more
// bits.
private int decodeRunLength(int sym) throws IOException, DataFormatException {
if (sym < 257 || sym > 287) // Cannot occur in the bit stream; indicates the decompressor is buggy
throw new IllegalStateException("Invalid run length symbol: " + sym);
else if (sym <= 264)
return sym - 254;
else if (sym <= 284) {
int numExtraBits = (sym - 261) / 4;
return (((sym - 265) % 4 + 4) << numExtraBits) + 3 + readInt(numExtraBits);
} else if (sym == 285)
return 258;
else // sym is 286 or 287
throw new DataFormatException("Reserved length symbol: " + sym);
}
// Returns the distance based on the given symbol and possibly reading more
// bits.
private int decodeDistance(int sym) throws IOException, DataFormatException {
if (sym < 0 || sym > 31) // Cannot occur in the bit stream; indicates the decompressor is buggy
throw new IllegalStateException("Invalid distance symbol: " + sym);
if (sym <= 3)
return sym + 1;
else if (sym <= 29) {
int numExtraBits = sym / 2 - 1;
return ((sym % 2 + 2) << numExtraBits) + 1 + readInt(numExtraBits);
} else // sym is 30 or 31
throw new DataFormatException("Reserved distance symbol: " + sym);
}
/*-- Utility method --*/
// Reads the given number of bits from the bit input stream as a single integer,
// packed in little endian.
private int readInt(int numBits) throws IOException {
if (numBits < 0 || numBits > 31)
throw new IllegalArgumentException();
int result = 0;
for (int i = 0; i < numBits; i++)
result |= input.readNoEof() << i;
return result;
}
}