Generic LZW implementation.
22 | 23 | 24 | -------------------------------------------------------------------------------- /src/test/resources/archives/FreeBSD.ar: -------------------------------------------------------------------------------- 1 | !Contains utilities used internally by the compress library.
22 | 23 | 24 | -------------------------------------------------------------------------------- /src/site/resources/download_compress.cgi: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # Licensed to the Apache Software Foundation (ASF) under one or more 4 | # contributor license agreements. See the NOTICE file distributed with 5 | # this work for additional information regarding copyright ownership. 6 | # The ASF licenses this file to You under the Apache License, Version 2.0 7 | # (the "License"); you may not use this file except in compliance with 8 | # the License. You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | 18 | # Just call the standard mirrors.cgi script. It will use download.html 19 | # as the input template. 20 | exec /www/www.apache.org/dyn/mirrors/mirrors.cgi $* 21 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/parallel/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |Provides common API classes for parallel compression features.
22 | 23 | 24 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/arj/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |Provides stream classes for reading archives using 22 | the ARJ format.
23 | 24 | 25 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/sevenz/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |Provides classes for reading and writing archives using 22 | the 7z format.
23 | 24 | 25 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/compressors/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |Provides a unified API and factories for dealing with 22 | compressed streams.
23 | 24 | 25 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/ar/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |Provides stream classes for reading and writing archives using 22 | the AR format.
23 | 24 | 25 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/cpio/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |Provides stream classes for reading and writing archives using 22 | the CPIO format.
23 | 24 | 25 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |Provides a unified API and factories for dealing with archives 22 | in different formats.
23 | 24 | 25 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/zip/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |Provides stream classes for reading and writing archives using 22 | the ZIP format.
23 | 24 | 25 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/compressors/deflate/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |Provides a stream classes that allow (de)compressing streams 22 | using the DEFLATE algorithm.
23 | 24 | 25 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/compressors/bzip2/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |Provides stream classes for compressing and decompressing 22 | streams using the BZip2 algorithm.
23 | 24 | 25 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/compressors/z/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |Provides stream classes for decompressing 22 | streams using the "compress" algorithm used to write .Z files.
23 | 24 | 25 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/sevenz/StartHeader.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * http://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | * 17 | */ 18 | package org.apache.commons.compress.archivers.sevenz; 19 | 20 | class StartHeader { 21 | long nextHeaderOffset; 22 | long nextHeaderSize; 23 | long nextHeaderCrc; 24 | } 25 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/compressors/CompressorOutputStream.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | package org.apache.commons.compress.compressors; 20 | 21 | import java.io.OutputStream; 22 | 23 | public abstract class CompressorOutputStream extends OutputStream { 24 | // TODO 25 | } 26 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/jar/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |Provides stream classes for reading and writing archives using 22 | the ZIP format with some extensions for the special case of JAR 23 | archives.
24 | 25 | 26 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/sevenz/Coder.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * http://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | * 17 | */ 18 | package org.apache.commons.compress.archivers.sevenz; 19 | 20 | class Coder { 21 | byte[] decompressionMethodId; 22 | long numInStreams; 23 | long numOutStreams; 24 | byte[] properties = null; 25 | } 26 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/changes/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |EXPERIMENTAL support for changesets that are applied to 22 | archives.
23 | 24 |This API is considered unstable and may be modified or even 25 | removed in future releases.
26 | 27 | 28 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/sevenz/BindPair.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * http://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | * 17 | */ 18 | package org.apache.commons.compress.archivers.sevenz; 19 | 20 | class BindPair { 21 | long inIndex; 22 | long outIndex; 23 | 24 | @Override 25 | public String toString() { 26 | return "BindPair binding input " + inIndex + " to output " + outIndex; 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/compressors/gzip/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |Provides stream classes for compressing and decompressing 22 | streams using the GZip algorithm.
23 | 24 |The classes in this package are wrappers around {@link 25 | java.util.zip.GZIPInputStream java.util.zip.GZIPInputStream} and 26 | {@link java.util.zip.GZIPOutputStream 27 | java.util.zip.GZIPOutputStream}.
28 | 29 | 30 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/dump/ShortFileException.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | package org.apache.commons.compress.archivers.dump; 20 | 21 | 22 | /** 23 | * Short File Exception. There was an unexpected EOF when reading 24 | * the input stream. 25 | */ 26 | public class ShortFileException extends DumpArchiveException { 27 | private static final long serialVersionUID = 1L; 28 | 29 | public ShortFileException() { 30 | super("unexpected EOF"); 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/sevenz/SubStreamsInfo.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * http://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | * 17 | */ 18 | package org.apache.commons.compress.archivers.sevenz; 19 | 20 | import java.util.BitSet; 21 | 22 | /// Properties for non-empty files. 23 | class SubStreamsInfo { 24 | /// Unpacked size of each unpacked stream. 25 | long[] unpackSizes; 26 | /// Whether CRC is present for each unpacked stream. 27 | BitSet hasCrc; 28 | /// CRCs of unpacked streams, if present. 29 | long[] crcs; 30 | } 31 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/parallel/ScatterGatherBackingStoreSupplier.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | package org.apache.commons.compress.parallel; 20 | 21 | import java.io.IOException; 22 | 23 | /** 24 | * Supplies {@link ScatterGatherBackingStore} instances. 25 | * 26 | * @since 1.10 27 | */ 28 | public interface ScatterGatherBackingStoreSupplier { 29 | /** 30 | * Create a ScatterGatherBackingStore. 31 | * 32 | * @return a ScatterGatherBackingStore, not null 33 | */ 34 | ScatterGatherBackingStore get() throws IOException; 35 | } 36 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/dump/UnrecognizedFormatException.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | package org.apache.commons.compress.archivers.dump; 20 | 21 | 22 | /** 23 | * Unrecognized Format Exception. This is either not a recognized dump archive or there's 24 | * a bad tape segment header. 25 | */ 26 | public class UnrecognizedFormatException extends DumpArchiveException { 27 | private static final long serialVersionUID = 1L; 28 | 29 | public UnrecognizedFormatException() { 30 | super("this is not a recognized format."); 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/tar/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |Provides stream classes for reading and writing archives using 22 | the TAR format.
23 | 24 |There are many different format dialects that call themselves 25 | TAR. The classes of this package can read and write archives in 26 | the traditional pre-POSIX ustar format and support GNU 27 | specific extensions for long filenames that GNU tar itself by 28 | now refers to as oldgnu.
29 | 30 | 31 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/compressors/xz/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |Provides stream classes for compressing and decompressing 22 | streams using the XZ algorithm.
23 | 24 |The classes in this package are wrappers around {@link 25 | org.tukaani.xz.XZInputStream org.tukaani.xz.XZInputStream} and 26 | {@link org.tukaani.xz.XZOutputStream 27 | org.tukaani.xz.XZOutputStream} provided by the public 28 | domain XZ for Java 29 | library.
30 | 31 | 32 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Constants.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | package org.apache.commons.compress.compressors.bzip2; 21 | 22 | /** 23 | * Constants for both the compress and decompress BZip2 classes. 24 | */ 25 | interface BZip2Constants { 26 | 27 | int BASEBLOCKSIZE = 100000; 28 | int MAX_ALPHA_SIZE = 258; 29 | int MAX_CODE_LEN = 23; 30 | int RUNA = 0; 31 | int RUNB = 1; 32 | int N_GROUPS = 6; 33 | int G_SIZE = 50; 34 | int N_ITERS = 4; 35 | int MAX_SELECTORS = (2 + (900000 / G_SIZE)); 36 | int NUM_OVERSHOOT_BYTES = 20; 37 | 38 | } -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/compressors/lzma/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |Provides a stream class decompressing streams using the 22 | "stand-alone" LZMA algorithm.
23 | 24 |The class in this package is a wrapper around {@link 25 | org.tukaani.xz.LZMAInputStream org.tukaani.xz.LZMAInputStream} 26 | and provided by the public 27 | domain XZ for Java 28 | library.
29 | 30 |In general you should prefer the more modern and robust XZ 31 | format over stand-alone LZMA compression.
32 | 33 | 34 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntryPredicate.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * http://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | * 17 | */ 18 | 19 | package org.apache.commons.compress.archivers.zip; 20 | 21 | /** 22 | * A predicate to test if a #ZipArchiveEntry matches a criteria. 23 | * Some day this can extend java.util.function.Predicate 24 | * 25 | * @since 1.10 26 | */ 27 | public interface ZipArchiveEntryPredicate { 28 | /** 29 | * Indicate if the given entry should be included in the operation 30 | * @param zipArchiveEntry the entry to test 31 | * @return true if the entry should be included 32 | */ 33 | boolean test(ZipArchiveEntry zipArchiveEntry); 34 | } 35 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/parallel/InputStreamSupplier.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | 20 | package org.apache.commons.compress.parallel; 21 | 22 | import java.io.InputStream; 23 | 24 | /** 25 | * Supplies input streams. 26 | * 27 | * Implementations are required to support thread-handover. While an instance will 28 | * not be accessed concurrently by multiple threads, it will be called by 29 | * a different thread than it was created on. 30 | * 31 | * @since 1.10 32 | */ 33 | public interface InputStreamSupplier { 34 | 35 | /** 36 | * Supply an input stream for a resource. 37 | * @return the input stream. Should never null, but may be an empty stream. 38 | */ 39 | InputStream get(); 40 | } 41 | -------------------------------------------------------------------------------- /src/test/resources/archives/SunOS_odc.cpio: -------------------------------------------------------------------------------- 1 | 07070700000000000110064400505600000100000117777711163465216000002000000000331 abcdefghijklmnopqrstuvwxyz 2 | 070707000000000002100644005056000001000001177777111635162140000030000000003312 abcdefghijklmnopqrstuvwxyz 3 | 0707070000000000031006440050560000010000011777771116351622100000400000000033123 abcdefghijklmnopqrstuvwxyz 4 | 07070700000000000410064400505600000100000117777711163516233000005000000000331234 abcdefghijklmnopqrstuvwxyz 5 | 070707000000000005100644005056000001000001177777111635162350000060000000003312345 abcdefghijklmnopqrstuvwxyz 6 | 0707070000000000061006440050560000010000011777771116351641100000700000000033123450 abcdefghijklmnopqrstuvwxyz 7 | 0707070000000000071006440050560000010000011777771116351676400000700000000032123456 bcdefghijklmnopqrstuvwxyz 8 | 0707070000000000101006440050560000010000011777771116351703400000700000000031123457 cdefghijklmnopqrstuvwxyz 9 | 0707070000000000111006440050560000010000011777771116351704600000700000000030123458 defghijklmnopqrstuvwxyz 10 | 0707070000000000121006440050560000010000011777771116351705700000700000000027123459 efghijklmnopqrstuvwxyz 11 | 0707070000000000000000000000000000000000010000000000000000000001300000000000TRAILER!!! -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveException.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | package org.apache.commons.compress.archivers.dump; 20 | 21 | import java.io.IOException; 22 | 23 | 24 | /** 25 | * Dump Archive Exception 26 | */ 27 | public class DumpArchiveException extends IOException { 28 | private static final long serialVersionUID = 1L; 29 | 30 | public DumpArchiveException() { 31 | } 32 | 33 | public DumpArchiveException(String msg) { 34 | super(msg); 35 | } 36 | 37 | public DumpArchiveException(Throwable cause) { 38 | initCause(cause); 39 | } 40 | 41 | public DumpArchiveException(String msg, Throwable cause) { 42 | super(msg); 43 | initCause(cause); 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /pmd-ruleset.xml: -------------------------------------------------------------------------------- 1 | 2 | 20 |This will cause a {@link Zip64RequiredException} to be 38 | * thrown if {@link ZipArchiveOutputStream} detects it needs Zip64 39 | * support.
40 | */ 41 | Never, 42 | /** 43 | * Use Zip64 extensions for all entries where they are required, 44 | * don't use them for entries that clearly don't require them. 45 | */ 46 | AsNeeded 47 | } 48 | -------------------------------------------------------------------------------- /src/main/assembly/bin.xml: -------------------------------------------------------------------------------- 1 | 17 |Provides stream classes for decompressing streams using the 22 | Snappy 23 | algorithm.
24 | 25 |The raw Snappy format which only contains the compressed data
26 | is supported by the SnappyCompressorInputStream
27 | class while the so called "framing format" is implemented
28 | by FramedSnappyCompressorInputStream. Note there
29 | have been different versions of the fraing format specification,
30 | the implementation in Commons Compress is based on the
31 | specification "Last revised: 2013-10-25".
Only the "framing format" can be auto-detected this means you
34 | have to speficy the format explicitly if you want to read a
35 | "raw" Snappy stream
36 | via CompressorStreamFactory.
27 | * The C structure for a sparse entry is: 28 | *
29 | * struct posix_header {
30 | * struct sparse sp[21]; // TarConstants.SPARSELEN_GNU_SPARSE - offset 0
31 | * char isextended; // TarConstants.ISEXTENDEDLEN_GNU_SPARSE - offset 504
32 | * };
33 | *
34 | * Whereas, "struct sparse" is:
35 | *
36 | * struct sparse {
37 | * char offset[12]; // offset 0
38 | * char numbytes[12]; // offset 12
39 | * };
40 | *
41 | */
42 |
43 | public class TarArchiveSparseEntry implements TarConstants {
44 | /** If an extension sparse header follows. */
45 | private final boolean isExtended;
46 |
47 | /**
48 | * Construct an entry from an archive's header bytes. File is set
49 | * to null.
50 | *
51 | * @param headerBuf The header bytes from a tar archive entry.
52 | * @throws IOException on unknown format
53 | */
54 | public TarArchiveSparseEntry(byte[] headerBuf) throws IOException {
55 | int offset = 0;
56 | offset += SPARSELEN_GNU_SPARSE;
57 | isExtended = TarUtils.parseBoolean(headerBuf, offset);
58 | }
59 |
60 | public boolean isExtended() {
61 | return isExtended;
62 | }
63 | }
64 |
--------------------------------------------------------------------------------
/src/test/java/org/apache/commons/compress/archivers/cpio/CpioUtilTest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | package org.apache.commons.compress.archivers.cpio;
20 |
21 | import static org.junit.Assert.assertArrayEquals;
22 | import static org.junit.Assert.assertEquals;
23 |
24 | import org.junit.Test;
25 |
26 | public class CpioUtilTest {
27 |
28 | @Test
29 | public void oldBinMagic2ByteArrayNotSwapped() {
30 | assertArrayEquals(new byte[] { (byte) 0xc7, 0x71 },
31 | CpioUtil.long2byteArray(CpioConstants.MAGIC_OLD_BINARY,
32 | 2, false));
33 | }
34 |
35 | @Test
36 | public void oldBinMagic2ByteArraySwapped() {
37 | assertArrayEquals(new byte[] { 0x71, (byte) 0xc7, },
38 | CpioUtil.long2byteArray(CpioConstants.MAGIC_OLD_BINARY,
39 | 2, true));
40 | }
41 |
42 | @Test
43 | public void oldBinMagicFromByteArrayNotSwapped() {
44 | assertEquals(CpioConstants.MAGIC_OLD_BINARY,
45 | CpioUtil.byteArray2long(new byte[] { (byte) 0xc7, 0x71 },
46 | false));
47 | }
48 |
49 | @Test
50 | public void oldBinMagicFromByteArraySwapped() {
51 | assertEquals(CpioConstants.MAGIC_OLD_BINARY,
52 | CpioUtil.byteArray2long(new byte[] { 0x71, (byte) 0xc7 },
53 | true));
54 | }
55 |
56 | }
--------------------------------------------------------------------------------
/src/main/java/org/apache/commons/compress/archivers/sevenz/NID.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one or more
3 | * contributor license agreements. See the NOTICE file distributed with
4 | * this work for additional information regarding copyright ownership.
5 | * The ASF licenses this file to You under the Apache License, Version 2.0
6 | * (the "License"); you may not use this file except in compliance with
7 | * the License. You may obtain a copy of the License at
8 | *
9 | * http://www.apache.org/licenses/LICENSE-2.0
10 | *
11 | * Unless required by applicable law or agreed to in writing, software
12 | * distributed under the License is distributed on an "AS IS" BASIS,
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | * See the License for the specific language governing permissions and
15 | * limitations under the License.
16 | *
17 | */
18 | package org.apache.commons.compress.archivers.sevenz;
19 |
20 | final class NID {
21 | public static final int kEnd = 0x00;
22 | public static final int kHeader = 0x01;
23 | public static final int kArchiveProperties = 0x02;
24 | public static final int kAdditionalStreamsInfo = 0x03;
25 | public static final int kMainStreamsInfo = 0x04;
26 | public static final int kFilesInfo = 0x05;
27 | public static final int kPackInfo = 0x06;
28 | public static final int kUnpackInfo = 0x07;
29 | public static final int kSubStreamsInfo = 0x08;
30 | public static final int kSize = 0x09;
31 | public static final int kCRC = 0x0A;
32 | public static final int kFolder = 0x0B;
33 | public static final int kCodersUnpackSize = 0x0C;
34 | public static final int kNumUnpackStream = 0x0D;
35 | public static final int kEmptyStream = 0x0E;
36 | public static final int kEmptyFile = 0x0F;
37 | public static final int kAnti = 0x10;
38 | public static final int kName = 0x11;
39 | public static final int kCTime = 0x12;
40 | public static final int kATime = 0x13;
41 | public static final int kMTime = 0x14;
42 | public static final int kWinAttributes = 0x15;
43 | public static final int kComment = 0x16;
44 | public static final int kEncodedHeader = 0x17;
45 | public static final int kStartPos = 0x18;
46 | public static final int kDummy = 0x19;
47 | }
48 |
--------------------------------------------------------------------------------
/src/main/java/org/apache/commons/compress/parallel/FileBasedScatterGatherBackingStore.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one or more
3 | * contributor license agreements. See the NOTICE file distributed with
4 | * this work for additional information regarding copyright ownership.
5 | * The ASF licenses this file to You under the Apache License, Version 2.0
6 | * (the "License"); you may not use this file except in compliance with
7 | * the License. You may obtain a copy of the License at
8 | *
9 | * http://www.apache.org/licenses/LICENSE-2.0
10 | *
11 | * Unless required by applicable law or agreed to in writing, software
12 | * distributed under the License is distributed on an "AS IS" BASIS,
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | * See the License for the specific language governing permissions and
15 | * limitations under the License.
16 | *
17 | */
18 | package org.apache.commons.compress.parallel;
19 |
20 | import java.io.File;
21 | import java.io.FileNotFoundException;
22 | import java.io.FileInputStream;
23 | import java.io.FileOutputStream;
24 | import java.io.IOException;
25 | import java.io.InputStream;
26 |
27 | /**
28 | * ScatterGatherBackingStore that is backed by a file.
29 | *
30 | * @since 1.10
31 | */
32 | public class FileBasedScatterGatherBackingStore implements ScatterGatherBackingStore {
33 | private final File target;
34 | private final FileOutputStream os;
35 | private boolean closed;
36 |
37 | public FileBasedScatterGatherBackingStore(File target) throws FileNotFoundException {
38 | this.target = target;
39 | os = new FileOutputStream(target);
40 | }
41 |
42 | public InputStream getInputStream() throws IOException {
43 | return new FileInputStream(target);
44 | }
45 |
46 | @SuppressWarnings("ResultOfMethodCallIgnored")
47 | public void closeForWriting() throws IOException {
48 | if (!closed) {
49 | os.close();
50 | closed = true;
51 | }
52 | }
53 |
54 | public void writeOut(byte[] data, int offset, int length) throws IOException {
55 | os.write(data, offset, length);
56 | }
57 |
58 | public void close() throws IOException {
59 | closeForWriting();
60 | target.delete();
61 | }
62 | }
63 |
--------------------------------------------------------------------------------
/src/test/java/org/apache/commons/compress/ChainingTestCase.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one or more
3 | * contributor license agreements. See the NOTICE file distributed with
4 | * this work for additional information regarding copyright ownership.
5 | * The ASF licenses this file to You under the Apache License, Version 2.0
6 | * (the "License"); you may not use this file except in compliance with
7 | * the License. You may obtain a copy of the License at
8 | *
9 | * http://www.apache.org/licenses/LICENSE-2.0
10 | *
11 | * Unless required by applicable law or agreed to in writing, software
12 | * distributed under the License is distributed on an "AS IS" BASIS,
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | * See the License for the specific language governing permissions and
15 | * limitations under the License.
16 | *
17 | */
18 |
19 | package org.apache.commons.compress;
20 |
21 | import static org.junit.Assert.*;
22 |
23 | import java.io.File;
24 | import java.io.FileInputStream;
25 |
26 | import org.apache.commons.compress.archivers.tar.TarArchiveEntry;
27 | import org.apache.commons.compress.archivers.tar.TarArchiveInputStream;
28 | import org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream;
29 | import org.apache.commons.compress.compressors.gzip.GzipCompressorInputStream;
30 | import org.junit.Test;
31 |
32 |
33 | public class ChainingTestCase extends AbstractTestCase {
34 |
35 | @Test
36 | public void testTarGzip() throws Exception {
37 | File file = getFile("bla.tgz");
38 | final TarArchiveInputStream is = new TarArchiveInputStream(new GzipCompressorInputStream(new FileInputStream(file)));
39 | final TarArchiveEntry entry = (TarArchiveEntry)is.getNextEntry();
40 | assertNotNull(entry);
41 | assertEquals("test1.xml", entry.getName());
42 | is.close();
43 | }
44 |
45 | @Test
46 | public void testTarBzip2() throws Exception {
47 | File file = getFile("bla.tar.bz2");
48 | final TarArchiveInputStream is = new TarArchiveInputStream(new BZip2CompressorInputStream(new FileInputStream(file)));
49 | final TarArchiveEntry entry = (TarArchiveEntry)is.getNextEntry();
50 | assertNotNull(entry);
51 | assertEquals("test1.xml", entry.getName());
52 | is.close();
53 | }
54 | }
55 |
--------------------------------------------------------------------------------
/src/main/java/org/apache/commons/compress/archivers/dump/Dirent.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | package org.apache.commons.compress.archivers.dump;
20 |
21 | /**
22 | * Directory entry.
23 | */
24 | class Dirent {
25 | private final int ino;
26 | private final int parentIno;
27 | private final int type;
28 | private final String name;
29 |
30 | /**
31 | * Constructor
32 | *
33 | * @param ino
34 | * @param parentIno
35 | * @param type
36 | * @param name
37 | */
38 | Dirent(int ino, int parentIno, int type, String name) {
39 | this.ino = ino;
40 | this.parentIno = parentIno;
41 | this.type = type;
42 | this.name = name;
43 | }
44 |
45 | /**
46 | * Get ino.
47 | * @return the i-node
48 | */
49 | int getIno() {
50 | return ino;
51 | }
52 |
53 | /**
54 | * Get ino of parent directory.
55 | * @return the parent i-node
56 | */
57 | int getParentIno() {
58 | return parentIno;
59 | }
60 |
61 | /**
62 | * Get entry type.
63 | * @return the entry type
64 | */
65 | int getType() {
66 | return type;
67 | }
68 |
69 | /**
70 | * Get name of directory entry.
71 | * @return the directory name
72 | */
73 | String getName() {
74 | return name;
75 | }
76 |
77 | /**
78 | * @see java.lang.Object#toString()
79 | */
80 | @Override
81 | public String toString() {
82 | return String.format("[%d]: %s", ino, name);
83 | }
84 | }
85 |
--------------------------------------------------------------------------------
/src/main/java/org/apache/commons/compress/archivers/sevenz/BoundedRandomAccessFileInputStream.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one or more
3 | * contributor license agreements. See the NOTICE file distributed with
4 | * this work for additional information regarding copyright ownership.
5 | * The ASF licenses this file to You under the Apache License, Version 2.0
6 | * (the "License"); you may not use this file except in compliance with
7 | * the License. You may obtain a copy of the License at
8 | *
9 | * http://www.apache.org/licenses/LICENSE-2.0
10 | *
11 | * Unless required by applicable law or agreed to in writing, software
12 | * distributed under the License is distributed on an "AS IS" BASIS,
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | * See the License for the specific language governing permissions and
15 | * limitations under the License.
16 | *
17 | */
18 | package org.apache.commons.compress.archivers.sevenz;
19 |
20 | import java.io.IOException;
21 | import java.io.InputStream;
22 | import java.io.RandomAccessFile;
23 |
24 | class BoundedRandomAccessFileInputStream extends InputStream {
25 | private final RandomAccessFile file;
26 | private long bytesRemaining;
27 |
28 | public BoundedRandomAccessFileInputStream(final RandomAccessFile file,
29 | final long size) {
30 | this.file = file;
31 | this.bytesRemaining = size;
32 | }
33 |
34 | @Override
35 | public int read() throws IOException {
36 | if (bytesRemaining > 0) {
37 | --bytesRemaining;
38 | return file.read();
39 | } else {
40 | return -1;
41 | }
42 | }
43 |
44 | @Override
45 | public int read(byte[] b, int off, int len) throws IOException {
46 | if (bytesRemaining == 0) {
47 | return -1;
48 | }
49 | int bytesToRead = len;
50 | if (bytesToRead > bytesRemaining) {
51 | bytesToRead = (int) bytesRemaining;
52 | }
53 | final int bytesRead = file.read(b, off, bytesToRead);
54 | if (bytesRead >= 0) {
55 | bytesRemaining -= bytesRead;
56 | }
57 | return bytesRead;
58 | }
59 |
60 | @Override
61 | public void close() {
62 | // the nested RandomAccessFile is controlled externally
63 | }
64 | }
65 |
--------------------------------------------------------------------------------
/src/main/java/org/apache/commons/compress/compressors/pack200/StreamBridge.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 |
20 | package org.apache.commons.compress.compressors.pack200;
21 |
22 | import java.io.FilterOutputStream;
23 | import java.io.IOException;
24 | import java.io.InputStream;
25 | import java.io.OutputStream;
26 |
27 | /**
28 | * Provides an InputStream to read all data written to this
29 | * OutputStream.
30 | *
31 | * @ThreadSafe
32 | * @since 1.3
33 | */
34 | abstract class StreamBridge extends FilterOutputStream {
35 | private InputStream input;
36 | private final Object INPUT_LOCK = new Object();
37 |
38 | protected StreamBridge(OutputStream out) {
39 | super(out);
40 | }
41 |
42 | protected StreamBridge() {
43 | this(null);
44 | }
45 |
46 | /**
47 | * Provides the input view.
48 | */
49 | InputStream getInput() throws IOException {
50 | synchronized (INPUT_LOCK) {
51 | if (input == null) {
52 | input = getInputView();
53 | }
54 | }
55 | return input;
56 | }
57 |
58 | /**
59 | * Creates the input view.
60 | */
61 | abstract InputStream getInputView() throws IOException;
62 |
63 | /**
64 | * Closes input and output and releases all associated resources.
65 | */
66 | void stop() throws IOException {
67 | close();
68 | synchronized (INPUT_LOCK) {
69 | if (input != null) {
70 | input.close();
71 | input = null;
72 | }
73 | }
74 | }
75 | }
76 |
--------------------------------------------------------------------------------
/src/main/java/org/apache/commons/compress/archivers/sevenz/Archive.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one or more
3 | * contributor license agreements. See the NOTICE file distributed with
4 | * this work for additional information regarding copyright ownership.
5 | * The ASF licenses this file to You under the Apache License, Version 2.0
6 | * (the "License"); you may not use this file except in compliance with
7 | * the License. You may obtain a copy of the License at
8 | *
9 | * http://www.apache.org/licenses/LICENSE-2.0
10 | *
11 | * Unless required by applicable law or agreed to in writing, software
12 | * distributed under the License is distributed on an "AS IS" BASIS,
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | * See the License for the specific language governing permissions and
15 | * limitations under the License.
16 | *
17 | */
18 | package org.apache.commons.compress.archivers.sevenz;
19 |
20 | import java.util.BitSet;
21 |
22 | class Archive {
23 | /// Offset from beginning of file + SIGNATURE_HEADER_SIZE to packed streams.
24 | long packPos;
25 | /// Size of each packed stream.
26 | long[] packSizes;
27 | /// Whether each particular packed streams has a CRC.
28 | BitSet packCrcsDefined;
29 | /// CRCs for each packed stream, valid only if that packed stream has one.
30 | long[] packCrcs;
31 | /// Properties of solid compression blocks.
32 | Folder[] folders;
33 | /// Temporary properties for non-empty files (subsumed into the files array later).
34 | SubStreamsInfo subStreamsInfo;
35 | /// The files and directories in the archive.
36 | SevenZArchiveEntry[] files;
37 | /// Mapping between folders, files and streams.
38 | StreamMap streamMap;
39 |
40 | @Override
41 | public String toString() {
42 | return "Archive with packed streams starting at offset " + packPos
43 | + ", " + lengthOf(packSizes) + " pack sizes, " + lengthOf(packCrcs)
44 | + " CRCs, " + lengthOf(folders) + " folders, " + lengthOf(files)
45 | + " files and " + streamMap;
46 | }
47 |
48 | private static String lengthOf(long[] a) {
49 | return a == null ? "(null)" : String.valueOf(a.length);
50 | }
51 |
52 | private static String lengthOf(Object[] a) {
53 | return a == null ? "(null)" : String.valueOf(a.length);
54 | }
55 | }
56 |
--------------------------------------------------------------------------------
/src/main/java/org/apache/commons/compress/utils/CountingOutputStream.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | package org.apache.commons.compress.utils;
20 |
21 | import java.io.FilterOutputStream;
22 | import java.io.IOException;
23 | import java.io.OutputStream;
24 |
25 | /**
26 | * Stream that tracks the number of bytes read.
27 | * @since 1.3
28 | * @NotThreadSafe
29 | */
30 | public class CountingOutputStream extends FilterOutputStream {
31 | private long bytesWritten = 0;
32 |
33 | public CountingOutputStream(final OutputStream out) {
34 | super(out);
35 | }
36 |
37 | @Override
38 | public void write(int b) throws IOException {
39 | out.write(b);
40 | count(1);
41 | }
42 | @Override
43 | public void write(byte[] b) throws IOException {
44 | write(b, 0, b.length);
45 | }
46 | @Override
47 | public void write(byte[] b, int off, int len) throws IOException {
48 | out.write(b, off, len);
49 | count(len);
50 | }
51 |
52 | /**
53 | * Increments the counter of already written bytes.
54 | * Doesn't increment if the EOF has been hit (written == -1)
55 | *
56 | * @param written the number of bytes written
57 | */
58 | protected void count(long written) {
59 | if (written != -1) {
60 | bytesWritten += written;
61 | }
62 | }
63 |
64 | /**
65 | * Returns the current number of bytes written to this stream.
66 | * @return the number of written bytes
67 | */
68 | public long getBytesWritten() {
69 | return bytesWritten;
70 | }
71 | }
72 |
--------------------------------------------------------------------------------
/src/main/java/org/apache/commons/compress/parallel/ScatterGatherBackingStore.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one or more
3 | * contributor license agreements. See the NOTICE file distributed with
4 | * this work for additional information regarding copyright ownership.
5 | * The ASF licenses this file to You under the Apache License, Version 2.0
6 | * (the "License"); you may not use this file except in compliance with
7 | * the License. You may obtain a copy of the License at
8 | *
9 | * http://www.apache.org/licenses/LICENSE-2.0
10 | *
11 | * Unless required by applicable law or agreed to in writing, software
12 | * distributed under the License is distributed on an "AS IS" BASIS,
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | * See the License for the specific language governing permissions and
15 | * limitations under the License.
16 | *
17 | */
18 | package org.apache.commons.compress.parallel;
19 |
20 | import java.io.Closeable;
21 | import java.io.IOException;
22 | import java.io.InputStream;
23 |
24 | /**
25 | * Store intermediate payload in a scatter-gather scenario. 26 | * Multiple threads write their payload to a backing store, which can 27 | * subsequently be reversed to an {@link InputStream} to be used as input in the 28 | * gather phase.
29 | * 30 | *It is the responsibility of the allocator of an instance of this class 31 | * to close this. Closing it should clear off any allocated structures 32 | * and preferably delete files.
33 | * 34 | * @since 1.10 35 | */ 36 | public interface ScatterGatherBackingStore extends Closeable { 37 | 38 | /** 39 | * An input stream that contains the scattered payload 40 | * 41 | * @return An InputStream, should be closed by the caller of this method. 42 | * @throws IOException when something fails 43 | */ 44 | InputStream getInputStream() throws IOException; 45 | 46 | /** 47 | * Writes a piece of payload. 48 | * 49 | * @param data the data to write 50 | * @param offset offset inside data to start writing from 51 | * @param length the amount of data to write 52 | * @throws IOException when something fails 53 | */ 54 | void writeOut(byte[] data, int offset, int length) throws IOException; 55 | 56 | /** 57 | * Closes this backing store for further writing. 58 | */ 59 | void closeForWriting() throws IOException; 60 | } 61 | -------------------------------------------------------------------------------- /src/test/java/org/apache/commons/compress/utils/CharsetsTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * http://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | */ 17 | 18 | package org.apache.commons.compress.utils; 19 | 20 | import java.nio.charset.Charset; 21 | 22 | import org.junit.Assert; 23 | 24 | import org.junit.Test; 25 | 26 | /** 27 | * Sanity checks for {@link Charsets}. 28 | * 29 | * @version $Id$ 30 | */ 31 | public class CharsetsTest { 32 | 33 | @Test 34 | public void testToCharset() { 35 | Assert.assertEquals(Charset.defaultCharset(), Charsets.toCharset((String) null)); 36 | Assert.assertEquals(Charset.defaultCharset(), Charsets.toCharset((Charset) null)); 37 | Assert.assertEquals(Charset.defaultCharset(), Charsets.toCharset(Charset.defaultCharset())); 38 | Assert.assertEquals(Charset.forName("UTF-8"), Charsets.toCharset(Charset.forName("UTF-8"))); 39 | } 40 | 41 | @Test 42 | public void testIso8859_1() { 43 | Assert.assertEquals("ISO-8859-1", Charsets.ISO_8859_1.name()); 44 | } 45 | 46 | @Test 47 | public void testUsAscii() { 48 | Assert.assertEquals("US-ASCII", Charsets.US_ASCII.name()); 49 | } 50 | 51 | @Test 52 | public void testUtf16() { 53 | Assert.assertEquals("UTF-16", Charsets.UTF_16.name()); 54 | } 55 | 56 | @Test 57 | public void testUtf16Be() { 58 | Assert.assertEquals("UTF-16BE", Charsets.UTF_16BE.name()); 59 | } 60 | 61 | @Test 62 | public void testUtf16Le() { 63 | Assert.assertEquals("UTF-16LE", Charsets.UTF_16LE.name()); 64 | } 65 | 66 | @Test 67 | public void testUtf8() { 68 | Assert.assertEquals("UTF-8", Charsets.UTF_8.name()); 69 | } 70 | 71 | } 72 | -------------------------------------------------------------------------------- /src/test/resources/longpath/files.txt: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one or more 2 | # contributor license agreements. See the NOTICE file distributed with 3 | # this work for additional information regarding copyright ownership. 4 | # The ASF licenses this file to You under the Apache License, Version 2.0 5 | # (the "License"); you may not use this file except in compliance with 6 | # the License. You may obtain a copy of the License at 7 | # 8 | # http://www.apache.org/licenses/LICENSE-2.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | # 17 | # File prefixes correspond to the following OSes: 18 | # cygwin - CYGWIN_NT-5.1 1.7.1(0.218/5/3) 19 | # hudson - SunOS 5.10 20 | # minotaur - FreeBSD 8.0-STABLE 21 | # vmgump - Linux 2.6.24-27-server 22 | # winXP_ant - Ant 1.7.1 on Windows/XP 23 | # 24 | compress-test/ 25 | compress-test/dir1/ 26 | compress-test/dir1/dir2/ 27 | compress-test/dir1/dir2/dir3/ 28 | compress-test/dir1/dir2/dir3/dir4/ 29 | compress-test/dir1/dir2/dir3/dir4/dir5/ 30 | compress-test/dir1/dir2/dir3/dir4/dir5/dir6/ 31 | compress-test/dir1/dir2/dir3/dir4/dir5/dir6/dir7/ 32 | compress-test/dir1/dir2/dir3/dir4/dir5/dir6/dir7/dir8/ 33 | compress-test/dir1/dir2/dir3/dir4/dir5/dir6/dir7/dir8/dir9/ 34 | compress-test/dir1/dir2/dir3/dir4/dir5/dir6/dir7/dir8/dir9/dir10/ 35 | compress-test/dir1/dir2/dir3/dir4/dir5/dir6/dir7/dir8/dir9/dir10/file12345678901234567890.txt 36 | compress-test/dir1/dir2/dir3/dir4/dir5/dir6/dir7/dir8/dir9/dir10/file1234567890123456789012345678901234567890123456789012345678901234567890.txt 37 | compress-test/dir1/dir2/dir3/dir4/dir5/dir6/dir7/dir8/dir9/dir10/file123456789012345678901234567890123456789012345678901234567890.txt 38 | compress-test/dir1/dir2/dir3/dir4/dir5/dir6/dir7/dir8/dir9/dir10/file.txt 39 | compress-test/dir1/dir2/dir3/dir4/dir5/dir6/dir7/dir8/dir9/dir10/file123456789012345678901234567890.txt 40 | compress-test/dir1/dir2/dir3/dir4/dir5/dir6/dir7/dir8/dir9/dir10/file1234567890.txt 41 | compress-test/dir1/dir2/dir3/dir4/dir5/dir6/dir7/dir8/dir9/dir10/file1234567890123456789012345678901234567890.txt 42 | compress-test/dir1/dir2/dir3/dir4/dir5/dir6/dir7/dir8/dir9/dir10/file12345678901234567890123456789012345678901234567890.txt -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/utils/CountingInputStream.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | package org.apache.commons.compress.utils; 20 | 21 | import java.io.FilterInputStream; 22 | import java.io.IOException; 23 | import java.io.InputStream; 24 | 25 | /** 26 | * Stream that tracks the number of bytes read. 27 | * @since 1.3 28 | * @NotThreadSafe 29 | */ 30 | public class CountingInputStream extends FilterInputStream { 31 | private long bytesRead; 32 | 33 | public CountingInputStream(final InputStream in) { 34 | super(in); 35 | } 36 | 37 | @Override 38 | public int read() throws IOException { 39 | int r = in.read(); 40 | if (r >= 0) { 41 | count(1); 42 | } 43 | return r; 44 | } 45 | @Override 46 | public int read(byte[] b) throws IOException { 47 | return read(b, 0, b.length); 48 | } 49 | @Override 50 | public int read(byte[] b, int off, int len) throws IOException { 51 | int r = in.read(b, off, len); 52 | if (r >= 0) { 53 | count(r); 54 | } 55 | return r; 56 | } 57 | /** 58 | * Increments the counter of already read bytes. 59 | * Doesn't increment if the EOF has been hit (read == -1) 60 | * 61 | * @param read the number of bytes read 62 | */ 63 | protected final void count(long read) { 64 | if (read != -1) { 65 | bytesRead += read; 66 | } 67 | } 68 | 69 | /** 70 | * Returns the current number of bytes read from this stream. 71 | * @return the number of read bytes 72 | */ 73 | public long getBytesRead() { 74 | return bytesRead; 75 | } 76 | } 77 | -------------------------------------------------------------------------------- /src/test/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStreamTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * http://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | * 17 | */ 18 | 19 | package org.apache.commons.compress.archivers.ar; 20 | 21 | import static org.junit.Assert.*; 22 | 23 | import java.io.BufferedInputStream; 24 | import java.io.FileInputStream; 25 | 26 | import org.apache.commons.compress.AbstractTestCase; 27 | import org.apache.commons.compress.archivers.ArchiveEntry; 28 | import org.apache.commons.compress.utils.ArchiveUtils; 29 | import org.junit.Test; 30 | 31 | public class ArArchiveInputStreamTest extends AbstractTestCase { 32 | 33 | @Test 34 | public void testReadLongNamesGNU() throws Exception { 35 | checkLongNameEntry("longfile_gnu.ar"); 36 | } 37 | 38 | @Test 39 | public void testReadLongNamesBSD() throws Exception { 40 | checkLongNameEntry("longfile_bsd.ar"); 41 | } 42 | 43 | private void checkLongNameEntry(String archive) throws Exception { 44 | FileInputStream fis = new FileInputStream(getFile(archive)); 45 | ArArchiveInputStream s = null; 46 | try { 47 | s = new ArArchiveInputStream(new BufferedInputStream(fis)); 48 | ArchiveEntry e = s.getNextEntry(); 49 | assertEquals("this_is_a_long_file_name.txt", e.getName()); 50 | assertEquals(14, e.getSize()); 51 | byte[] hello = new byte[14]; 52 | s.read(hello); 53 | assertEquals("Hello, world!\n", ArchiveUtils.toAsciiString(hello)); 54 | assertNull(s.getNextEntry()); 55 | } finally { 56 | if (s != null) { 57 | s.close(); 58 | } 59 | fis.close(); 60 | } 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /src/test/java/org/apache/commons/compress/archivers/sevenz/SevenZMethodConfigurationTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * http://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | * 17 | */ 18 | package org.apache.commons.compress.archivers.sevenz; 19 | 20 | import org.junit.Assert; 21 | import org.junit.Test; 22 | import org.tukaani.xz.LZMA2Options; 23 | 24 | public class SevenZMethodConfigurationTest { 25 | 26 | @Test 27 | public void shouldAllowNullOptions() { 28 | Assert.assertNull(new SevenZMethodConfiguration(SevenZMethod.LZMA2, null) 29 | .getOptions()); 30 | } 31 | 32 | @Test 33 | public void shouldAllowLZMA2OptionsForLZMA2() { 34 | Assert.assertNotNull(new SevenZMethodConfiguration(SevenZMethod.LZMA2, 35 | new LZMA2Options()) 36 | .getOptions()); 37 | } 38 | 39 | @Test 40 | public void shouldAllowNumberForLZMA2() { 41 | Assert.assertNotNull(new SevenZMethodConfiguration(SevenZMethod.LZMA2, 42) 42 | .getOptions()); 43 | } 44 | 45 | @Test 46 | public void shouldAllowNumberForBzip2() { 47 | Assert.assertNotNull(new SevenZMethodConfiguration(SevenZMethod.BZIP2, 42) 48 | .getOptions()); 49 | } 50 | 51 | @Test 52 | public void shouldAllowNumberForDeflate() { 53 | Assert.assertNotNull(new SevenZMethodConfiguration(SevenZMethod.DEFLATE, 42) 54 | .getOptions()); 55 | } 56 | 57 | @Test(expected = IllegalArgumentException.class) 58 | public void shouldNotAllowStringOptionsForLZMA2() { 59 | new SevenZMethodConfiguration(SevenZMethod.LZMA2, ""); 60 | } 61 | 62 | } 63 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/dump/package.html: -------------------------------------------------------------------------------- 1 | 2 | 20 | 21 |This package provides stream classes for reading archives 22 | using the Unix DUMP format. This format is similar to (and 23 | contemporary with) TAR but reads the raw filesystem directly. 24 | This means that writers are filesystem-specific even though the 25 | created archives are filesystem-agnostic. 26 |
27 | 28 |Unlike other formats DUMP offers clean support for sparse files, 29 | extended attributes, and other file metadata. In addition DUMP 30 | supports incremental dump files can capture (most) file deletion. 31 | It also provides a native form of compression and will soon support 32 | native encryption as well. 33 |
34 | 35 |In practice TAR archives are used for both distribution 36 | and backups. DUMP archives are used exclusively for backups. 37 |
38 | 39 |Like any 30+-year-old application there are a number of variants. 40 | For pragmatic reasons we will only support archives with the 41 | 'new' tape header and inode formats. Other restrictions: 42 | 43 |
As of Apache Commons Compress 1.3 support for the dump format is 54 | read-only.
55 | 56 | 57 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveOutputStream.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | package org.apache.commons.compress.archivers.jar; 20 | 21 | import java.io.IOException; 22 | import java.io.OutputStream; 23 | 24 | import org.apache.commons.compress.archivers.ArchiveEntry; 25 | import org.apache.commons.compress.archivers.zip.JarMarker; 26 | import org.apache.commons.compress.archivers.zip.ZipArchiveEntry; 27 | import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream; 28 | 29 | /** 30 | * Subclass that adds a special extra field to the very first entry 31 | * which allows the created archive to be used as an executable jar on 32 | * Solaris. 33 | * 34 | * @NotThreadSafe 35 | */ 36 | public class JarArchiveOutputStream extends ZipArchiveOutputStream { 37 | 38 | private boolean jarMarkerAdded = false; 39 | 40 | public JarArchiveOutputStream(final OutputStream out) { 41 | super(out); 42 | } 43 | 44 | /** 45 | * Create and instance that wraps the output stream using the provided encoding. 46 | * 47 | * @param out the output stream to wrap 48 | * @param encoding the encoding to use. Use null for the platform default. 49 | * @since 1.10 50 | */ 51 | public JarArchiveOutputStream(final OutputStream out, final String encoding) { 52 | super(out); 53 | setEncoding(encoding); 54 | } 55 | 56 | // @throws ClassCastException if entry is not an instance of ZipArchiveEntry 57 | @Override 58 | public void putArchiveEntry(ArchiveEntry ze) throws IOException { 59 | if (!jarMarkerAdded) { 60 | ((ZipArchiveEntry)ze).addAsFirstExtraField(JarMarker.getInstance()); 61 | jarMarkerAdded = true; 62 | } 63 | super.putArchiveEntry(ze); 64 | } 65 | } 66 | -------------------------------------------------------------------------------- /src/site/xdoc/conventions.xml: -------------------------------------------------------------------------------- 1 | 2 | 18 |26 | The developers of this component decided to follow the recommended standards 27 | but not to include Checkstyle (or similar tools) into Commons Compress. 28 |
29 |32 | Commons Compress does not aim to be threadsafe at the moment. But the developers 33 | agreed to document multithreading behaviour in the javadocs. 34 |
35 |36 | We use some of the annotations from 37 | JCIP 38 | as JavaDoc tags. The used tags are: 39 | 40 |
The name of the archive must be given as a command line argument.
30 | *The optional second argument defines the archive type, in case the format is not recognised.
31 | * 32 | * @since 1.1 33 | */ 34 | public final class Lister { 35 | private static final ArchiveStreamFactory factory = new ArchiveStreamFactory(); 36 | 37 | public static void main(String[] args) throws Exception { 38 | if (args.length == 0) { 39 | usage(); 40 | return; 41 | } 42 | System.out.println("Analysing "+args[0]); 43 | File f = new File(args[0]); 44 | if (!f.isFile()) { 45 | System.err.println(f + " doesn't exist or is a directory"); 46 | } 47 | InputStream fis = new BufferedInputStream(new FileInputStream(f)); 48 | ArchiveInputStream ais; 49 | if (args.length > 1) { 50 | ais = factory.createArchiveInputStream(args[1], fis); 51 | } else { 52 | ais = factory.createArchiveInputStream(fis); 53 | } 54 | System.out.println("Created "+ais.toString()); 55 | ArchiveEntry ae; 56 | while((ae=ais.getNextEntry()) != null){ 57 | System.out.println(ae.getName()); 58 | } 59 | ais.close(); 60 | fis.close(); 61 | } 62 | 63 | private static void usage() { 64 | System.out.println("Parameters: archive-name [archive-type]"); 65 | } 66 | 67 | } -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/sevenz/DeltaDecoder.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * http://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | * 17 | */ 18 | package org.apache.commons.compress.archivers.sevenz; 19 | 20 | import java.io.IOException; 21 | import java.io.InputStream; 22 | import java.io.OutputStream; 23 | import org.tukaani.xz.DeltaOptions; 24 | import org.tukaani.xz.FinishableWrapperOutputStream; 25 | import org.tukaani.xz.UnsupportedOptionsException; 26 | 27 | class DeltaDecoder extends CoderBase { 28 | DeltaDecoder() { 29 | super(Number.class); 30 | } 31 | 32 | @Override 33 | InputStream decode(final String archiveName, final InputStream in, long uncompressedLength, 34 | final Coder coder, byte[] password) throws IOException { 35 | return new DeltaOptions(getOptionsFromCoder(coder)).getInputStream(in); 36 | } 37 | 38 | @Override 39 | OutputStream encode(final OutputStream out, final Object options) throws IOException { 40 | int distance = numberOptionOrDefault(options, 1); 41 | try { 42 | return new DeltaOptions(distance).getOutputStream(new FinishableWrapperOutputStream(out)); 43 | } catch (UnsupportedOptionsException ex) { 44 | throw new IOException(ex.getMessage()); 45 | } 46 | } 47 | 48 | @Override 49 | byte[] getOptionsAsProperties(Object options) { 50 | return new byte[] { 51 | (byte) (numberOptionOrDefault(options, 1) - 1) 52 | }; 53 | } 54 | 55 | @Override 56 | Object getOptionsFromCoder(Coder coder, InputStream in) { 57 | return getOptionsFromCoder(coder); 58 | } 59 | 60 | private int getOptionsFromCoder(Coder coder) { 61 | if (coder.properties == null || coder.properties.length == 0) { 62 | return 1; 63 | } 64 | return (0xff & coder.properties[0]) + 1; 65 | } 66 | } 67 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/utils/BoundedInputStream.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * http://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | * 17 | */ 18 | package org.apache.commons.compress.utils; 19 | 20 | import java.io.IOException; 21 | import java.io.InputStream; 22 | 23 | /** 24 | * A stream that limits reading from a wrapped stream to a given number of bytes. 25 | * @NotThreadSafe 26 | * @since 1.6 27 | */ 28 | public class BoundedInputStream extends InputStream { 29 | private final InputStream in; 30 | private long bytesRemaining; 31 | 32 | /** 33 | * Creates the stream that will at most read the given amount of 34 | * bytes from the given stream. 35 | * @param in the stream to read from 36 | * @param size the maximum amount of bytes to read 37 | */ 38 | public BoundedInputStream(final InputStream in, final long size) { 39 | this.in = in; 40 | bytesRemaining = size; 41 | } 42 | 43 | @Override 44 | public int read() throws IOException { 45 | if (bytesRemaining > 0) { 46 | --bytesRemaining; 47 | return in.read(); 48 | } else { 49 | return -1; 50 | } 51 | } 52 | 53 | @Override 54 | public int read(byte[] b, int off, int len) throws IOException { 55 | if (bytesRemaining == 0) { 56 | return -1; 57 | } 58 | int bytesToRead = len; 59 | if (bytesToRead > bytesRemaining) { 60 | bytesToRead = (int) bytesRemaining; 61 | } 62 | final int bytesRead = in.read(b, off, bytesToRead); 63 | if (bytesRead >= 0) { 64 | bytesRemaining -= bytesRead; 65 | } 66 | return bytesRead; 67 | } 68 | 69 | @Override 70 | public void close() { 71 | // there isn't anything to close in this stream and the nested 72 | // stream is controlled externally 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /src/test/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStreamTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one 3 | * or more contributor license agreements. See the NOTICE file 4 | * distributed with this work for additional information 5 | * regarding copyright ownership. The ASF licenses this file 6 | * to you under the Apache License, Version 2.0 (the 7 | * "License"); you may not use this file except in compliance 8 | * with the License. You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, 13 | * software distributed under the License is distributed on an 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | * KIND, either express or implied. See the License for the 16 | * specific language governing permissions and limitations 17 | * under the License. 18 | */ 19 | package org.apache.commons.compress.archivers.cpio; 20 | 21 | import static org.junit.Assert.*; 22 | 23 | import java.io.FileInputStream; 24 | 25 | import org.apache.commons.compress.AbstractTestCase; 26 | import org.junit.Test; 27 | 28 | public class CpioArchiveInputStreamTest extends AbstractTestCase { 29 | 30 | @Test 31 | public void testCpioUnarchive() throws Exception { 32 | StringBuilder expected = new StringBuilder(); 33 | expected.append("./test1.xml\n"); 34 | expected.append("Stores the UTF-8 version of the file name field as stored in the 25 | * local header and central directory header.
26 | * 27 | * @see PKWARE 28 | * APPNOTE.TXT, section 4.6.9 29 | * 30 | * @NotThreadSafe super-class is not thread-safe 31 | */ 32 | public class UnicodePathExtraField extends AbstractUnicodeExtraField { 33 | 34 | public static final ZipShort UPATH_ID = new ZipShort(0x7075); 35 | 36 | public UnicodePathExtraField () { 37 | } 38 | 39 | /** 40 | * Assemble as unicode path extension from the name given as 41 | * text as well as the encoded bytes actually written to the archive. 42 | * 43 | * @param text The file name 44 | * @param bytes the bytes actually written to the archive 45 | * @param off The offset of the encoded filename inbytes.
46 | * @param len The length of the encoded filename or comment in
47 | * bytes.
48 | */
49 | public UnicodePathExtraField(String text, byte[] bytes, int off, int len) {
50 | super(text, bytes, off, len);
51 | }
52 |
53 | /**
54 | * Assemble as unicode path extension from the name given as
55 | * text as well as the encoded bytes actually written to the archive.
56 | *
57 | * @param name The file name
58 | * @param bytes the bytes actually written to the archive
59 | */
60 | public UnicodePathExtraField(String name, byte[] bytes) {
61 | super(name, bytes);
62 | }
63 |
64 | public ZipShort getHeaderId() {
65 | return UPATH_ID;
66 | }
67 | }
68 |
--------------------------------------------------------------------------------
/src/main/java/org/apache/commons/compress/compressors/CompressorInputStream.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | package org.apache.commons.compress.compressors;
20 |
21 | import java.io.InputStream;
22 |
23 | public abstract class CompressorInputStream extends InputStream {
24 | private long bytesRead = 0;
25 |
26 | /**
27 | * Increments the counter of already read bytes.
28 | * Doesn't increment if the EOF has been hit (read == -1)
29 | *
30 | * @param read the number of bytes read
31 | *
32 | * @since 1.1
33 | */
34 | protected void count(int read) {
35 | count((long) read);
36 | }
37 |
38 | /**
39 | * Increments the counter of already read bytes.
40 | * Doesn't increment if the EOF has been hit (read == -1)
41 | *
42 | * @param read the number of bytes read
43 | */
44 | protected void count(long read) {
45 | if (read != -1) {
46 | bytesRead = bytesRead + read;
47 | }
48 | }
49 |
50 | /**
51 | * Decrements the counter of already read bytes.
52 | *
53 | * @param pushedBack the number of bytes pushed back.
54 | * @since 1.7
55 | */
56 | protected void pushedBackBytes(long pushedBack) {
57 | bytesRead -= pushedBack;
58 | }
59 |
60 | /**
61 | * Returns the current number of bytes read from this stream.
62 | * @return the number of read bytes
63 | * @deprecated this method may yield wrong results for large
64 | * archives, use #getBytesRead instead
65 | */
66 | @Deprecated
67 | public int getCount() {
68 | return (int) bytesRead;
69 | }
70 |
71 | /**
72 | * Returns the current number of bytes read from this stream.
73 | * @return the number of read bytes
74 | *
75 | * @since 1.1
76 | */
77 | public long getBytesRead() {
78 | return bytesRead;
79 | }
80 | }
81 |
--------------------------------------------------------------------------------
/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateParameters.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 |
20 | package org.apache.commons.compress.compressors.deflate;
21 |
22 | import java.util.zip.Deflater;
23 |
24 | /**
25 | * Parameters for the Deflate compressor.
26 | * @since 1.9
27 | */
28 | public class DeflateParameters {
29 |
30 | private boolean zlibHeader = true;
31 | private int compressionLevel = Deflater.DEFAULT_COMPRESSION;
32 |
33 | /**
34 | * Whether or not the zlib header shall be written (when
35 | * compressing) or expected (when decompressing).
36 | */
37 | public boolean withZlibHeader() {
38 | return zlibHeader;
39 | }
40 |
41 | /**
42 | * Sets the zlib header presence parameter.
43 | *
44 | * This affects whether or not the zlib header will be written 45 | * (when compressing) or expected (when decompressing).
46 | * 47 | * @param zlibHeader 48 | */ 49 | public void setWithZlibHeader(boolean zlibHeader) { 50 | this.zlibHeader = zlibHeader; 51 | } 52 | 53 | /** 54 | * The compression level. 55 | * @see #setCompressionLevel 56 | */ 57 | public int getCompressionLevel() { 58 | return compressionLevel; 59 | } 60 | 61 | /** 62 | * Sets the compression level. 63 | * 64 | * @param compressionLevel the compression level (between 0 and 9) 65 | * @see Deflater#NO_COMPRESSION 66 | * @see Deflater#BEST_SPEED 67 | * @see Deflater#DEFAULT_COMPRESSION 68 | * @see Deflater#BEST_COMPRESSION 69 | */ 70 | public void setCompressionLevel(int compressionLevel) { 71 | if (compressionLevel < -1 || compressionLevel > 9) { 72 | throw new IllegalArgumentException("Invalid Deflate compression level: " + compressionLevel); 73 | } 74 | this.compressionLevel = compressionLevel; 75 | } 76 | 77 | } 78 | -------------------------------------------------------------------------------- /src/main/java/org/apache/commons/compress/archivers/zip/UnicodeCommentExtraField.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Licensed to the Apache Software Foundation (ASF) under one or more 3 | * contributor license agreements. See the NOTICE file distributed with 4 | * this work for additional information regarding copyright ownership. 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 6 | * (the "License"); you may not use this file except in compliance with 7 | * the License. You may obtain a copy of the License at 8 | * 9 | * http://www.apache.org/licenses/LICENSE-2.0 10 | * 11 | * Unless required by applicable law or agreed to in writing, software 12 | * distributed under the License is distributed on an "AS IS" BASIS, 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | * See the License for the specific language governing permissions and 15 | * limitations under the License. 16 | * 17 | */ 18 | 19 | package org.apache.commons.compress.archivers.zip; 20 | 21 | /** 22 | * Info-ZIP Unicode Comment Extra Field (0x6375): 23 | * 24 | *Stores the UTF-8 version of the file comment as stored in the 25 | * central directory header.
26 | * 27 | * @see PKWARE 28 | * APPNOTE.TXT, section 4.6.8 29 | * 30 | * @NotThreadSafe super-class is not thread-safe 31 | */ 32 | public class UnicodeCommentExtraField extends AbstractUnicodeExtraField { 33 | 34 | public static final ZipShort UCOM_ID = new ZipShort(0x6375); 35 | 36 | public UnicodeCommentExtraField () { 37 | } 38 | 39 | /** 40 | * Assemble as unicode comment extension from the name given as 41 | * text as well as the encoded bytes actually written to the archive. 42 | * 43 | * @param text The file name 44 | * @param bytes the bytes actually written to the archive 45 | * @param off The offset of the encoded comment inbytes.
46 | * @param len The length of the encoded comment or comment in
47 | * bytes.
48 | */
49 | public UnicodeCommentExtraField(String text, byte[] bytes, int off,
50 | int len) {
51 | super(text, bytes, off, len);
52 | }
53 |
54 | /**
55 | * Assemble as unicode comment extension from the comment given as
56 | * text as well as the bytes actually written to the archive.
57 | *
58 | * @param comment The file comment
59 | * @param bytes the bytes actually written to the archive
60 | */
61 | public UnicodeCommentExtraField(String comment, byte[] bytes) {
62 | super(comment, bytes);
63 | }
64 |
65 | public ZipShort getHeaderId() {
66 | return UCOM_ID;
67 | }
68 |
69 | }
70 |
--------------------------------------------------------------------------------
/src/test/java/org/apache/commons/compress/archivers/zip/StreamCompressorTest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one or more
3 | * contributor license agreements. See the NOTICE file distributed with
4 | * this work for additional information regarding copyright ownership.
5 | * The ASF licenses this file to You under the Apache License, Version 2.0
6 | * (the "License"); you may not use this file except in compliance with
7 | * the License. You may obtain a copy of the License at
8 | *
9 | * http://www.apache.org/licenses/LICENSE-2.0
10 | *
11 | * Unless required by applicable law or agreed to in writing, software
12 | * distributed under the License is distributed on an "AS IS" BASIS,
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | * See the License for the specific language governing permissions and
15 | * limitations under the License.
16 | *
17 | */
18 | package org.apache.commons.compress.archivers.zip;
19 |
20 | import org.junit.Test;
21 |
22 | import java.io.ByteArrayInputStream;
23 | import java.io.ByteArrayOutputStream;
24 | import java.util.zip.ZipEntry;
25 |
26 | import static org.junit.Assert.assertArrayEquals;
27 | import static org.junit.Assert.assertEquals;
28 |
29 | public class StreamCompressorTest {
30 |
31 | @Test
32 | public void storedEntries() throws Exception {
33 | ByteArrayOutputStream baos = new ByteArrayOutputStream();
34 | StreamCompressor sc = StreamCompressor.create( baos);
35 | sc.deflate(new ByteArrayInputStream("A".getBytes()), ZipEntry.STORED);
36 | sc.deflate(new ByteArrayInputStream("BAD".getBytes()), ZipEntry.STORED);
37 | assertEquals(3, sc.getBytesRead());
38 | assertEquals(3, sc.getBytesWrittenForLastEntry());
39 | assertEquals(344750961, sc.getCrc32());
40 | sc.deflate(new ByteArrayInputStream("CAFE".getBytes()), ZipEntry.STORED);
41 | assertEquals("ABADCAFE", baos.toString());
42 | }
43 |
44 | @Test
45 | public void deflatedEntries() throws Exception {
46 | ByteArrayOutputStream baos = new ByteArrayOutputStream();
47 | StreamCompressor sc = StreamCompressor.create( baos);
48 | sc.deflate(new ByteArrayInputStream("AAAAAABBBBBB".getBytes()), ZipEntry.DEFLATED);
49 | assertEquals(12, sc.getBytesRead());
50 | assertEquals(8, sc.getBytesWrittenForLastEntry());
51 | assertEquals(3299542, sc.getCrc32());
52 |
53 | final byte[] actuals = baos.toByteArray();
54 | byte[] expected = new byte[]{115,116,4,1,39,48,0,0};
55 | // Note that this test really asserts stuff about the java Deflater, which might be a little bit brittle
56 | assertArrayEquals(expected, actuals);
57 | }
58 | }
--------------------------------------------------------------------------------