├── .gitignore
├── LICENSE.txt
├── README.md
├── build.gradle
├── gradle
└── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── settings.gradle
└── src
└── main
└── java
└── org
└── kamranzafar
└── jtar
├── Octal.java
├── TarConstants.java
├── TarEntry.java
├── TarHeader.java
├── TarInputStream.java
├── TarOutputStream.java
└── TarUtils.java
/.gitignore:
--------------------------------------------------------------------------------
1 | *.iml
2 | .gradle
3 | /.idea/
4 | .DS_Store
5 | /build
6 | /captures
7 | .externalNativeBuild
8 | .cxx
9 | /local.properties
10 |
--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Overview
2 | JTar is a simple Java Tar library, that provides an easy way to create and read tar files using IO streams. The API is very simple to use and similar to the *java.util.zip* package. This repo is forked from [kamranzafar/jtar](https://github.com/kamranzafar/jtar) with modifications to build on Android and switch to use **GNU USTAR tar header**.
3 |
4 | [](https://jitpack.io/#topjohnwu/jtar)
5 |
6 | ## Usage
7 | JTar is available on Jitpack and can be added as a dependency.
8 | ```
9 | repositories {
10 | ...
11 | maven { url 'https://jitpack.io' }
12 | }
13 | dependencies {
14 | implementation 'com.github.topjohnwu:jtar:1.0.0'
15 | }
16 | ```
17 |
18 | Below are some examples of using jtar in applications
19 |
20 | ### Tar example - using TarOutputStream
21 | // Output file stream
22 | FileOutputStream dest = new FileOutputStream( "c:/test/test.tar" );
23 |
24 | // Create a TarOutputStream
25 | TarOutputStream out = new TarOutputStream( new BufferedOutputStream( dest ) );
26 |
27 | // Files to tar
28 | File[] filesToTar=new File[2];
29 | filesToTar[0]=new File("c:/test/myfile1.txt");
30 | filesToTar[1]=new File("c:/test/myfile2.txt");
31 |
32 | for(File f:filesToTar){
33 | out.putNextEntry(new TarEntry(f, f.getName()));
34 | BufferedInputStream origin = new BufferedInputStream(new FileInputStream( f ));
35 | int count;
36 | byte data[] = new byte[2048];
37 |
38 | while((count = origin.read(data)) != -1) {
39 | out.write(data, 0, count);
40 | }
41 |
42 | out.flush();
43 | origin.close();
44 | }
45 |
46 | out.close();
47 |
48 |
49 | ### Untar example - using TarInputStream
50 | String tarFile = "c:/test/test.tar";
51 | String destFolder = "c:/test/myfiles";
52 |
53 | // Create a TarInputStream
54 | TarInputStream tis = new TarInputStream(new BufferedInputStream(new FileInputStream(tarFile)));
55 | TarEntry entry;
56 |
57 | while((entry = tis.getNextEntry()) != null) {
58 | int count;
59 | byte data[] = new byte[2048];
60 | FileOutputStream fos = new FileOutputStream(destFolder + "/" + entry.getName());
61 | BufferedOutputStream dest = new BufferedOutputStream(fos);
62 |
63 | while((count = tis.read(data)) != -1) {
64 | dest.write(data, 0, count);
65 | }
66 |
67 | dest.flush();
68 | dest.close();
69 | }
70 |
71 | tis.close();
72 |
73 |
74 | ___Tip: Always use buffered streams with jtar to speed up IO.___
75 |
--------------------------------------------------------------------------------
/build.gradle:
--------------------------------------------------------------------------------
1 | apply plugin: 'java'
2 | apply plugin: 'maven-publish'
3 |
4 | group = 'org.kamranzafar'
5 | version = '2.4-SNAPSHOT'
6 | description = 'JTar'
7 | sourceCompatibility = 1.8
8 | targetCompatibility = 1.8
9 |
10 | repositories {
11 | jcenter()
12 | }
13 |
14 | task sourcesJar(type: Jar) {
15 | archiveClassifier.set('sources')
16 | from sourceSets.main.allJava
17 | }
18 |
19 | task javadocJar(type: Jar) {
20 | archiveClassifier.set('javadoc')
21 | from javadoc.destinationDir
22 | }
23 |
24 | publishing {
25 | publications {
26 | maven(MavenPublication) {
27 | from components.java
28 | artifact sourcesJar
29 | artifact javadocJar
30 | }
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/topjohnwu/jtar/b18499211d3a304a8888a9e975ccbb10f7082d16/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionBase=GRADLE_USER_HOME
2 | distributionPath=wrapper/dists
3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip
4 | zipStoreBase=GRADLE_USER_HOME
5 | zipStorePath=wrapper/dists
6 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | #
4 | # Copyright © 2015-2021 the original authors.
5 | #
6 | # Licensed under the Apache License, Version 2.0 (the "License");
7 | # you may not use this file except in compliance with the License.
8 | # You may obtain a copy of the License at
9 | #
10 | # https://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 |
19 | ##############################################################################
20 | #
21 | # Gradle start up script for POSIX generated by Gradle.
22 | #
23 | # Important for running:
24 | #
25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
26 | # noncompliant, but you have some other compliant shell such as ksh or
27 | # bash, then to run this script, type that shell name before the whole
28 | # command line, like:
29 | #
30 | # ksh Gradle
31 | #
32 | # Busybox and similar reduced shells will NOT work, because this script
33 | # requires all of these POSIX shell features:
34 | # * functions;
35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»;
37 | # * compound commands having a testable exit status, especially «case»;
38 | # * various built-in commands including «command», «set», and «ulimit».
39 | #
40 | # Important for patching:
41 | #
42 | # (2) This script targets any POSIX shell, so it avoids extensions provided
43 | # by Bash, Ksh, etc; in particular arrays are avoided.
44 | #
45 | # The "traditional" practice of packing multiple parameters into a
46 | # space-separated string is a well documented source of bugs and security
47 | # problems, so this is (mostly) avoided, by progressively accumulating
48 | # options in "$@", and eventually passing that to Java.
49 | #
50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
52 | # see the in-line comments for details.
53 | #
54 | # There are tweaks for specific operating systems such as AIX, CygWin,
55 | # Darwin, MinGW, and NonStop.
56 | #
57 | # (3) This script is generated from the Groovy template
58 | # https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
59 | # within the Gradle project.
60 | #
61 | # You can find Gradle at https://github.com/gradle/gradle/.
62 | #
63 | ##############################################################################
64 |
65 | # Attempt to set APP_HOME
66 |
67 | # Resolve links: $0 may be a link
68 | app_path=$0
69 |
70 | # Need this for daisy-chained symlinks.
71 | while
72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
73 | [ -h "$app_path" ]
74 | do
75 | ls=$( ls -ld "$app_path" )
76 | link=${ls#*' -> '}
77 | case $link in #(
78 | /*) app_path=$link ;; #(
79 | *) app_path=$APP_HOME$link ;;
80 | esac
81 | done
82 |
83 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
84 |
85 | APP_NAME="Gradle"
86 | APP_BASE_NAME=${0##*/}
87 |
88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
90 |
91 | # Use the maximum available, or set MAX_FD != -1 to use that value.
92 | MAX_FD=maximum
93 |
94 | warn () {
95 | echo "$*"
96 | } >&2
97 |
98 | die () {
99 | echo
100 | echo "$*"
101 | echo
102 | exit 1
103 | } >&2
104 |
105 | # OS specific support (must be 'true' or 'false').
106 | cygwin=false
107 | msys=false
108 | darwin=false
109 | nonstop=false
110 | case "$( uname )" in #(
111 | CYGWIN* ) cygwin=true ;; #(
112 | Darwin* ) darwin=true ;; #(
113 | MSYS* | MINGW* ) msys=true ;; #(
114 | NONSTOP* ) nonstop=true ;;
115 | esac
116 |
117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
118 |
119 |
120 | # Determine the Java command to use to start the JVM.
121 | if [ -n "$JAVA_HOME" ] ; then
122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
123 | # IBM's JDK on AIX uses strange locations for the executables
124 | JAVACMD=$JAVA_HOME/jre/sh/java
125 | else
126 | JAVACMD=$JAVA_HOME/bin/java
127 | fi
128 | if [ ! -x "$JAVACMD" ] ; then
129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
130 |
131 | Please set the JAVA_HOME variable in your environment to match the
132 | location of your Java installation."
133 | fi
134 | else
135 | JAVACMD=java
136 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
137 |
138 | Please set the JAVA_HOME variable in your environment to match the
139 | location of your Java installation."
140 | fi
141 |
142 | # Increase the maximum file descriptors if we can.
143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
144 | case $MAX_FD in #(
145 | max*)
146 | MAX_FD=$( ulimit -H -n ) ||
147 | warn "Could not query maximum file descriptor limit"
148 | esac
149 | case $MAX_FD in #(
150 | '' | soft) :;; #(
151 | *)
152 | ulimit -n "$MAX_FD" ||
153 | warn "Could not set maximum file descriptor limit to $MAX_FD"
154 | esac
155 | fi
156 |
157 | # Collect all arguments for the java command, stacking in reverse order:
158 | # * args from the command line
159 | # * the main class name
160 | # * -classpath
161 | # * -D...appname settings
162 | # * --module-path (only if needed)
163 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
164 |
165 | # For Cygwin or MSYS, switch paths to Windows format before running java
166 | if "$cygwin" || "$msys" ; then
167 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
168 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
169 |
170 | JAVACMD=$( cygpath --unix "$JAVACMD" )
171 |
172 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
173 | for arg do
174 | if
175 | case $arg in #(
176 | -*) false ;; # don't mess with options #(
177 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
178 | [ -e "$t" ] ;; #(
179 | *) false ;;
180 | esac
181 | then
182 | arg=$( cygpath --path --ignore --mixed "$arg" )
183 | fi
184 | # Roll the args list around exactly as many times as the number of
185 | # args, so each arg winds up back in the position where it started, but
186 | # possibly modified.
187 | #
188 | # NB: a `for` loop captures its iteration list before it begins, so
189 | # changing the positional parameters here affects neither the number of
190 | # iterations, nor the values presented in `arg`.
191 | shift # remove old arg
192 | set -- "$@" "$arg" # push replacement arg
193 | done
194 | fi
195 |
196 | # Collect all arguments for the java command;
197 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
198 | # shell script including quotes and variable substitutions, so put them in
199 | # double quotes to make sure that they get re-expanded; and
200 | # * put everything else in single quotes, so that it's not re-expanded.
201 |
202 | set -- \
203 | "-Dorg.gradle.appname=$APP_BASE_NAME" \
204 | -classpath "$CLASSPATH" \
205 | org.gradle.wrapper.GradleWrapperMain \
206 | "$@"
207 |
208 | # Use "xargs" to parse quoted args.
209 | #
210 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed.
211 | #
212 | # In Bash we could simply go:
213 | #
214 | # readarray ARGS < <( xargs -n1 <<<"$var" ) &&
215 | # set -- "${ARGS[@]}" "$@"
216 | #
217 | # but POSIX shell has neither arrays nor command substitution, so instead we
218 | # post-process each arg (as a line of input to sed) to backslash-escape any
219 | # character that might be a shell metacharacter, then use eval to reverse
220 | # that process (while maintaining the separation between arguments), and wrap
221 | # the whole thing up as a single "set" statement.
222 | #
223 | # This will of course break if any of these variables contains a newline or
224 | # an unmatched quote.
225 | #
226 |
227 | eval "set -- $(
228 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
229 | xargs -n1 |
230 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
231 | tr '\n' ' '
232 | )" '"$@"'
233 |
234 | exec "$JAVACMD" "$@"
235 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @rem
2 | @rem Copyright 2015 the original author or authors.
3 | @rem
4 | @rem Licensed under the Apache License, Version 2.0 (the "License");
5 | @rem you may not use this file except in compliance with the License.
6 | @rem You may obtain a copy of the License at
7 | @rem
8 | @rem https://www.apache.org/licenses/LICENSE-2.0
9 | @rem
10 | @rem Unless required by applicable law or agreed to in writing, software
11 | @rem distributed under the License is distributed on an "AS IS" BASIS,
12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | @rem See the License for the specific language governing permissions and
14 | @rem limitations under the License.
15 | @rem
16 |
17 | @if "%DEBUG%" == "" @echo off
18 | @rem ##########################################################################
19 | @rem
20 | @rem Gradle startup script for Windows
21 | @rem
22 | @rem ##########################################################################
23 |
24 | @rem Set local scope for the variables with windows NT shell
25 | if "%OS%"=="Windows_NT" setlocal
26 |
27 | set DIRNAME=%~dp0
28 | if "%DIRNAME%" == "" set DIRNAME=.
29 | set APP_BASE_NAME=%~n0
30 | set APP_HOME=%DIRNAME%
31 |
32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter.
33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
34 |
35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
37 |
38 | @rem Find java.exe
39 | if defined JAVA_HOME goto findJavaFromJavaHome
40 |
41 | set JAVA_EXE=java.exe
42 | %JAVA_EXE% -version >NUL 2>&1
43 | if "%ERRORLEVEL%" == "0" goto execute
44 |
45 | echo.
46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
47 | echo.
48 | echo Please set the JAVA_HOME variable in your environment to match the
49 | echo location of your Java installation.
50 |
51 | goto fail
52 |
53 | :findJavaFromJavaHome
54 | set JAVA_HOME=%JAVA_HOME:"=%
55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
56 |
57 | if exist "%JAVA_EXE%" goto execute
58 |
59 | echo.
60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
61 | echo.
62 | echo Please set the JAVA_HOME variable in your environment to match the
63 | echo location of your Java installation.
64 |
65 | goto fail
66 |
67 | :execute
68 | @rem Setup the command line
69 |
70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
71 |
72 |
73 | @rem Execute Gradle
74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
75 |
76 | :end
77 | @rem End local scope for the variables with windows NT shell
78 | if "%ERRORLEVEL%"=="0" goto mainEnd
79 |
80 | :fail
81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
82 | rem the _cmd.exe /c_ return code!
83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
84 | exit /b 1
85 |
86 | :mainEnd
87 | if "%OS%"=="Windows_NT" endlocal
88 |
89 | :omega
90 |
--------------------------------------------------------------------------------
/settings.gradle:
--------------------------------------------------------------------------------
1 | /*
2 | * This file was generated by the Gradle 'init' task.
3 | */
4 |
5 | rootProject.name = 'jtar'
6 |
--------------------------------------------------------------------------------
/src/main/java/org/kamranzafar/jtar/Octal.java:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright 2012 Kamran Zafar
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * 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 |
18 | package org.kamranzafar.jtar;
19 |
20 | import java.nio.ByteBuffer;
21 | import java.nio.ByteOrder;
22 |
23 | /**
24 | * @author Kamran Zafar, John Wu
25 | *
26 | */
27 | public class Octal {
28 |
29 | // 8 ^ 11 - 1
30 | private static final long OCTAL_MAX = 8589934591L;
31 | private static final byte LARGE_NUM_MASK = (byte) 0x80;
32 |
33 | /**
34 | * Parse an octal string from a header buffer.
35 | *
36 | * @param header
37 | * The header buffer from which to parse.
38 | * @param offset
39 | * The offset into the buffer from which to parse.
40 | * @param length
41 | * The number of header bytes to parse.
42 | *
43 | * @return The long value of the octal string.
44 | */
45 | public static long parseOctal(byte[] header, int offset, int length) {
46 | long result = 0;
47 | boolean stillPadding = true;
48 |
49 | int end = offset + length;
50 | for (int i = offset; i < end; ++i) {
51 | byte b = header[i];
52 |
53 | if ((b & LARGE_NUM_MASK) != 0 && length == 12) {
54 | // Read the lower 8 bytes as big-endian long value
55 | return ByteBuffer.wrap(header, offset + 4, 8).order(ByteOrder.BIG_ENDIAN).getLong();
56 | }
57 |
58 | if (b == 0)
59 | break;
60 |
61 | if (b == (byte) ' ' || b == '0') {
62 | if (stillPadding)
63 | continue;
64 |
65 | if (b == (byte) ' ')
66 | break;
67 | }
68 |
69 | stillPadding = false;
70 |
71 | result = ( result << 3 ) + ( b - '0' );
72 | }
73 |
74 | return result;
75 | }
76 |
77 | /**
78 | * Write an octal integer to a header buffer.
79 | *
80 | * @param value
81 | * The value to write.
82 | * @param buf
83 | * The header buffer from which to parse.
84 | * @param offset
85 | * The offset into the buffer from which to parse.
86 | * @param length
87 | * The number of header bytes to parse.
88 | *
89 | * @return The new offset.
90 | */
91 | public static int getOctalBytes(long value, byte[] buf, int offset, int length) {
92 | if (value > OCTAL_MAX && length == 12) {
93 | buf[offset] = LARGE_NUM_MASK;
94 | buf[offset + 1] = 0;
95 | buf[offset + 2] = 0;
96 | buf[offset + 3] = 0;
97 | ByteBuffer.wrap(buf, offset + 4, 8).order(ByteOrder.BIG_ENDIAN).putLong(value);
98 | return offset + length;
99 | }
100 |
101 | int idx = length - 1;
102 |
103 | buf[offset + idx] = 0;
104 | --idx;
105 |
106 | for (long val = value; idx >= 0; --idx) {
107 | buf[offset + idx] = (byte) ((byte) '0' + (byte) (val & 7));
108 | val = val >> 3;
109 | }
110 |
111 | return offset + length;
112 | }
113 |
114 | /**
115 | * Write the checksum octal integer to a header buffer.
116 | *
117 | * @param value
118 | * The value to write.
119 | * @param buf
120 | * The header buffer from which to parse.
121 | * @param offset
122 | * The offset into the buffer from which to parse.
123 | * @param length
124 | * The number of header bytes to parse.
125 | * @return The new offset.
126 | */
127 | public static int getCheckSumOctalBytes(long value, byte[] buf, int offset, int length) {
128 | getOctalBytes(value, buf, offset, length - 1);
129 | buf[offset + length - 1] = (byte) ' ';
130 | return offset + length;
131 | }
132 |
133 | }
134 |
--------------------------------------------------------------------------------
/src/main/java/org/kamranzafar/jtar/TarConstants.java:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright 2012 Kamran Zafar
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * 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 |
18 | package org.kamranzafar.jtar;
19 |
20 | /**
21 | * @author Kamran Zafar
22 | *
23 | */
24 | public class TarConstants {
25 | public static final int EOF_BLOCK = 1024;
26 | public static final int DATA_BLOCK = 512;
27 | public static final int HEADER_BLOCK = 512;
28 | }
29 |
--------------------------------------------------------------------------------
/src/main/java/org/kamranzafar/jtar/TarEntry.java:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright 2012 Kamran Zafar
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * 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 |
18 | package org.kamranzafar.jtar;
19 |
20 | import java.io.File;
21 | import java.util.Arrays;
22 | import java.util.Date;
23 |
24 | /**
25 | * @author Kamran Zafar
26 | *
27 | */
28 | public class TarEntry {
29 | protected File file;
30 | protected TarHeader header;
31 |
32 | private TarEntry() {
33 | this.file = null;
34 | header = new TarHeader();
35 | }
36 |
37 | public TarEntry(File file, String entryName) {
38 | this();
39 | this.file = file;
40 | this.extractTarHeader(entryName);
41 | }
42 |
43 | public TarEntry(byte[] headerBuf) {
44 | this();
45 | this.parseTarHeader(headerBuf);
46 | }
47 |
48 | /**
49 | * Constructor to create an entry from an existing TarHeader object.
50 | *
51 | * This method is useful to add new entries programmatically (e.g. for
52 | * adding files or directories that do not exist in the file system).
53 | */
54 | public TarEntry(TarHeader header) {
55 | this.file = null;
56 | this.header = header;
57 | }
58 |
59 | @Override
60 | public boolean equals(Object it) {
61 | if (!(it instanceof TarEntry)) {
62 | return false;
63 | }
64 | return header.name.toString().equals(
65 | ((TarEntry) it).header.name.toString());
66 | }
67 |
68 | @Override
69 | public int hashCode() {
70 | return header.name.hashCode();
71 | }
72 |
73 | public boolean isDescendent(TarEntry desc) {
74 | return desc.header.name.toString().startsWith(header.name.toString());
75 | }
76 |
77 | public TarHeader getHeader() {
78 | return header;
79 | }
80 |
81 | public String getName() {
82 | String name = header.name.toString();
83 | if (header.namePrefix != null && !header.namePrefix.toString().equals("")) {
84 | name = header.namePrefix.toString() + "/" + name;
85 | }
86 |
87 | return name;
88 | }
89 |
90 | public void setName(String name) {
91 | header.name = new StringBuilder(name);
92 | }
93 |
94 | public int getUserId() {
95 | return header.userId;
96 | }
97 |
98 | public void setUserId(int userId) {
99 | header.userId = userId;
100 | }
101 |
102 | public int getGroupId() {
103 | return header.groupId;
104 | }
105 |
106 | public void setGroupId(int groupId) {
107 | header.groupId = groupId;
108 | }
109 |
110 | public String getUserName() {
111 | return header.userName.toString();
112 | }
113 |
114 | public void setUserName(String userName) {
115 | header.userName = new StringBuilder(userName);
116 | }
117 |
118 | public String getGroupName() {
119 | return header.groupName.toString();
120 | }
121 |
122 | public void setGroupName(String groupName) {
123 | header.groupName = new StringBuilder(groupName);
124 | }
125 |
126 | public void setIds(int userId, int groupId) {
127 | this.setUserId(userId);
128 | this.setGroupId(groupId);
129 | }
130 |
131 | public void setModTime(long time) {
132 | header.modTime = time / 1000;
133 | }
134 |
135 | public void setModTime(Date time) {
136 | header.modTime = time.getTime() / 1000;
137 | }
138 |
139 | public Date getModTime() {
140 | return new Date(header.modTime * 1000);
141 | }
142 |
143 | public File getFile() {
144 | return this.file;
145 | }
146 |
147 | public long getSize() {
148 | return header.size;
149 | }
150 |
151 | public void setSize(long size) {
152 | header.size = size;
153 | }
154 |
155 | /**
156 | * Checks if the org.kamrazafar.jtar entry is a directory
157 | */
158 | public boolean isDirectory() {
159 | if (this.file != null)
160 | return this.file.isDirectory();
161 |
162 | if (header != null) {
163 | if (header.typeflag == TarHeader.LF_DIR)
164 | return true;
165 |
166 | if (header.name.toString().endsWith("/"))
167 | return true;
168 | }
169 |
170 | return false;
171 | }
172 |
173 | /**
174 | * Extract header from File
175 | */
176 | public void extractTarHeader(String entryName) {
177 | int permissions = file.isDirectory() ? 0755 : 0644; // Default umask
178 | header = TarHeader.createHeader(entryName, file.length(), file.lastModified() / 1000, file.isDirectory(), permissions);
179 | }
180 |
181 | /**
182 | * Calculate checksum
183 | */
184 | public long computeCheckSum(byte[] buf) {
185 | long sum = 0;
186 |
187 | for (int i = 0; i < buf.length; ++i) {
188 | sum += 255 & buf[i];
189 | }
190 |
191 | return sum;
192 | }
193 |
194 | /**
195 | * Writes the header to the byte buffer
196 | */
197 | public void writeEntryHeader(byte[] outbuf) {
198 | int offset = 0;
199 |
200 | offset = TarHeader.getStringBytes(header.name, outbuf, offset, TarHeader.NAMELEN);
201 | offset = Octal.getOctalBytes(header.mode, outbuf, offset, TarHeader.MODELEN);
202 | offset = Octal.getOctalBytes(header.userId, outbuf, offset, TarHeader.UIDLEN);
203 | offset = Octal.getOctalBytes(header.groupId, outbuf, offset, TarHeader.GIDLEN);
204 | offset = Octal.getOctalBytes(header.size, outbuf, offset, TarHeader.SIZELEN);
205 | offset = Octal.getOctalBytes(header.modTime, outbuf, offset, TarHeader.MODTIMELEN);
206 |
207 | Arrays.fill(outbuf, offset, offset + TarHeader.CHKSUMLEN, (byte) ' ');
208 | int csOffset = offset;
209 | offset += TarHeader.CHKSUMLEN;
210 |
211 | outbuf[offset++] = header.typeflag;
212 |
213 | offset = TarHeader.getStringBytes(header.linkName, outbuf, offset, TarHeader.NAMELEN);
214 | offset = TarHeader.getStringBytes(header.magic, outbuf, offset, TarHeader.USTAR_MAGICLEN);
215 | offset = TarHeader.getStringBytes(header.userName, outbuf, offset, TarHeader.USTAR_USER_NAMELEN);
216 | offset = TarHeader.getStringBytes(header.groupName, outbuf, offset, TarHeader.USTAR_GROUP_NAMELEN);
217 | /* Java does not support blocks and character files, ignore */
218 | // offset = Octal.getOctalBytes(header.devMajor, outbuf, offset, TarHeader.USTAR_DEVLEN);
219 | // offset = Octal.getOctalBytes(header.devMinor, outbuf, offset, TarHeader.USTAR_DEVLEN);
220 | offset += TarHeader.USTAR_DEVLEN * 2;
221 | offset = TarHeader.getStringBytes(header.namePrefix, outbuf, offset, TarHeader.USTAR_FILENAME_PREFIX);
222 |
223 | for (; offset < outbuf.length;)
224 | outbuf[offset++] = 0;
225 |
226 | long checkSum = this.computeCheckSum(outbuf);
227 |
228 | Octal.getCheckSumOctalBytes(checkSum, outbuf, csOffset, TarHeader.CHKSUMLEN);
229 | }
230 |
231 | /**
232 | * Parses the tar header to the byte buffer
233 | */
234 | public void parseTarHeader(byte[] bh) {
235 | int offset = 0;
236 |
237 | header.name = TarHeader.parseString(bh, offset, TarHeader.NAMELEN);
238 | offset += TarHeader.NAMELEN;
239 |
240 | header.mode = (int) Octal.parseOctal(bh, offset, TarHeader.MODELEN);
241 | offset += TarHeader.MODELEN;
242 |
243 | header.userId = (int) Octal.parseOctal(bh, offset, TarHeader.UIDLEN);
244 | offset += TarHeader.UIDLEN;
245 |
246 | header.groupId = (int) Octal.parseOctal(bh, offset, TarHeader.GIDLEN);
247 | offset += TarHeader.GIDLEN;
248 |
249 | header.size = Octal.parseOctal(bh, offset, TarHeader.SIZELEN);
250 | offset += TarHeader.SIZELEN;
251 |
252 | header.modTime = Octal.parseOctal(bh, offset, TarHeader.MODTIMELEN);
253 | offset += TarHeader.MODTIMELEN;
254 |
255 | header.checkSum = (int) Octal.parseOctal(bh, offset, TarHeader.CHKSUMLEN);
256 | offset += TarHeader.CHKSUMLEN;
257 |
258 | header.typeflag = bh[offset++];
259 |
260 | header.linkName = TarHeader.parseString(bh, offset, TarHeader.NAMELEN);
261 | offset += TarHeader.NAMELEN;
262 |
263 | header.magic = TarHeader.parseString(bh, offset, TarHeader.USTAR_MAGICLEN);
264 | offset += TarHeader.USTAR_MAGICLEN;
265 |
266 | header.userName = TarHeader.parseString(bh, offset, TarHeader.USTAR_USER_NAMELEN);
267 | offset += TarHeader.USTAR_USER_NAMELEN;
268 |
269 | header.groupName = TarHeader.parseString(bh, offset, TarHeader.USTAR_GROUP_NAMELEN);
270 | offset += TarHeader.USTAR_GROUP_NAMELEN;
271 |
272 | header.devMajor = (int) Octal.parseOctal(bh, offset, TarHeader.USTAR_DEVLEN);
273 | offset += TarHeader.USTAR_DEVLEN;
274 |
275 | header.devMinor = (int) Octal.parseOctal(bh, offset, TarHeader.USTAR_DEVLEN);
276 | offset += TarHeader.USTAR_DEVLEN;
277 |
278 | header.namePrefix = TarHeader.parseString(bh, offset, TarHeader.USTAR_FILENAME_PREFIX);
279 | }
280 | }
--------------------------------------------------------------------------------
/src/main/java/org/kamranzafar/jtar/TarHeader.java:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright 2012 Kamran Zafar
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * 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 |
18 | package org.kamranzafar.jtar;
19 |
20 | import java.io.File;
21 |
22 | /**
23 | * Header
24 | *
25 | *
26 | * Offset Size Field
27 | * 0 100 File name
28 | * 100 8 File mode
29 | * 108 8 Owner's numeric user ID
30 | * 116 8 Group's numeric user ID
31 | * 124 12 File size in bytes
32 | * 136 12 Last modification time in numeric Unix time format
33 | * 148 8 Checksum for header block
34 | * 156 1 Link indicator (file type)
35 | * 157 100 Name of linked file
36 | *
37 | *
38 | *
39 | * File Types
40 | *
41 | *
42 | * Value Meaning
43 | * '0' Normal file
44 | * (ASCII NUL) Normal file (now obsolete)
45 | * '1' Hard link
46 | * '2' Symbolic link
47 | * '3' Character special
48 | * '4' Block special
49 | * '5' Directory
50 | * '6' FIFO
51 | * '7' Contigous
52 | *
53 | *
54 | *
55 | *
56 | * GNU Ustar header
57 | *
58 | *
59 | * Offset Size Field
60 | * 257 8 UStar indicator "ustar "
61 | * 265 32 Owner user name
62 | * 297 32 Owner group name
63 | * 329 8 Device major number
64 | * 337 8 Device minor number
65 | * 345 155 Filename prefix
66 | *
67 | */
68 |
69 | public class TarHeader {
70 |
71 | /*
72 | * Header
73 | */
74 | public static final int NAMELEN = 100;
75 | public static final int MODELEN = 8;
76 | public static final int UIDLEN = 8;
77 | public static final int GIDLEN = 8;
78 | public static final int SIZELEN = 12;
79 | public static final int MODTIMELEN = 12;
80 | public static final int CHKSUMLEN = 8;
81 | public static final byte LF_OLDNORM = 0;
82 |
83 | /*
84 | * File Types
85 | */
86 | public static final byte LF_NORMAL = (byte) '0';
87 | public static final byte LF_LINK = (byte) '1';
88 | public static final byte LF_SYMLINK = (byte) '2';
89 | public static final byte LF_CHR = (byte) '3';
90 | public static final byte LF_BLK = (byte) '4';
91 | public static final byte LF_DIR = (byte) '5';
92 | public static final byte LF_FIFO = (byte) '6';
93 | public static final byte LF_CONTIG = (byte) '7';
94 |
95 | /*
96 | * GNU header
97 | */
98 |
99 | public static final String USTAR_MAGIC = "ustar ";
100 |
101 | public static final int USTAR_MAGICLEN = 8;
102 | public static final int USTAR_USER_NAMELEN = 32;
103 | public static final int USTAR_GROUP_NAMELEN = 32;
104 | public static final int USTAR_DEVLEN = 8;
105 | public static final int USTAR_FILENAME_PREFIX = 155;
106 |
107 | // Header values
108 | public StringBuilder name;
109 | public int mode;
110 | public int userId;
111 | public int groupId;
112 | public long size;
113 | public long modTime;
114 | public int checkSum;
115 | public byte typeflag;
116 | public StringBuilder linkName;
117 | public StringBuilder magic;
118 | public StringBuilder userName;
119 | public StringBuilder groupName;
120 | public int devMajor;
121 | public int devMinor;
122 | public StringBuilder namePrefix;
123 |
124 | public TarHeader() {
125 | this.magic = new StringBuilder(TarHeader.USTAR_MAGIC);
126 |
127 | this.name = new StringBuilder();
128 | this.linkName = new StringBuilder();
129 |
130 | this.userId = 0;
131 | this.groupId = 0;
132 | this.userName = new StringBuilder();
133 | this.groupName = new StringBuilder();
134 | this.namePrefix = new StringBuilder();
135 | }
136 |
137 | /**
138 | * Parse an entry name from a header buffer.
139 | *
140 | * @param header
141 | * The header buffer from which to parse.
142 | * @param offset
143 | * The offset into the buffer from which to parse.
144 | * @param length
145 | * The number of header bytes to parse.
146 | * @return The header's entry name.
147 | */
148 | public static StringBuilder parseString(byte[] header, int offset, int length) {
149 | StringBuilder result = new StringBuilder(length);
150 |
151 | int end = offset + length;
152 | for (int i = offset; i < end; ++i) {
153 | if (header[i] == 0)
154 | break;
155 | result.append((char) header[i]);
156 | }
157 |
158 | return result;
159 | }
160 |
161 | /**
162 | * Write string as bytes into buffer.
163 | *
164 | * @param entry
165 | * The string buffer from which to parse.
166 | * @param offset
167 | * The offset into the buffer from which to parse.
168 | * @param length
169 | * The number of header bytes to parse.
170 | * @return The new offset after writing the entry.
171 | */
172 | public static int getStringBytes(StringBuilder entry, byte[] buf, int offset, int length) {
173 | int i;
174 |
175 | for (i = 0; i < length && i < entry.length(); ++i) {
176 | buf[offset + i] = (byte) entry.charAt(i);
177 | }
178 |
179 | for (; i < length; ++i) {
180 | buf[offset + i] = 0;
181 | }
182 |
183 | return offset + length;
184 | }
185 |
186 | /**
187 | * Creates a new header for a file/directory entry.
188 | *
189 | *
190 | * @param entryName
191 | * File name
192 | * @param size
193 | * File size in bytes
194 | * @param modTime
195 | * Last modification time in numeric Unix time format
196 | * @param dir
197 | * Is directory
198 | */
199 | public static TarHeader createHeader(String entryName, long size, long modTime, boolean dir, int permissions) {
200 | String name = entryName;
201 | name = TarUtils.trim(name.replace(File.separatorChar, '/'), '/');
202 |
203 | TarHeader header = new TarHeader();
204 | header.linkName = new StringBuilder();
205 | header.mode = permissions;
206 |
207 | if (name.length() > 100) {
208 | header.namePrefix = new StringBuilder(name.substring(0, name.lastIndexOf('/')));
209 | header.name = new StringBuilder(name.substring(name.lastIndexOf('/') + 1));
210 | } else {
211 | header.name = new StringBuilder(name);
212 | }
213 | if (dir) {
214 | header.typeflag = TarHeader.LF_DIR;
215 | if (header.name.charAt(header.name.length() - 1) != '/') {
216 | header.name.append("/");
217 | }
218 | header.size = 0;
219 | } else {
220 | header.typeflag = TarHeader.LF_NORMAL;
221 | header.size = size;
222 | }
223 |
224 | header.modTime = modTime;
225 | header.checkSum = 0;
226 | header.devMajor = 0;
227 | header.devMinor = 0;
228 |
229 | return header;
230 | }
231 | }
232 |
--------------------------------------------------------------------------------
/src/main/java/org/kamranzafar/jtar/TarInputStream.java:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright 2012 Kamran Zafar
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * 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 |
18 | package org.kamranzafar.jtar;
19 |
20 | import java.io.FilterInputStream;
21 | import java.io.IOException;
22 | import java.io.InputStream;
23 |
24 | /**
25 | * @author Kamran Zafar
26 | *
27 | */
28 | public class TarInputStream extends FilterInputStream {
29 |
30 | private static final int SKIP_BUFFER_SIZE = 2048;
31 | private TarEntry currentEntry;
32 | private long currentFileSize;
33 | private long bytesRead;
34 | private boolean defaultSkip = false;
35 |
36 | public TarInputStream(InputStream in) {
37 | super(in);
38 | currentFileSize = 0;
39 | bytesRead = 0;
40 | }
41 |
42 | @Override
43 | public boolean markSupported() {
44 | return false;
45 | }
46 |
47 | /**
48 | * Not supported
49 | *
50 | */
51 | @Override
52 | public synchronized void mark(int readlimit) {
53 | }
54 |
55 | /**
56 | * Not supported
57 | *
58 | */
59 | @Override
60 | public synchronized void reset() throws IOException {
61 | throw new IOException("mark/reset not supported");
62 | }
63 |
64 | /**
65 | * Read a byte
66 | *
67 | * @see java.io.FilterInputStream#read()
68 | */
69 | @Override
70 | public int read() throws IOException {
71 | byte[] buf = new byte[1];
72 |
73 | int res = this.read(buf, 0, 1);
74 |
75 | if (res != -1) {
76 | return 0xFF & buf[0];
77 | }
78 |
79 | return res;
80 | }
81 |
82 | /**
83 | * Checks if the bytes being read exceed the entry size and adjusts the byte
84 | * array length. Updates the byte counters
85 | *
86 | *
87 | * @see java.io.FilterInputStream#read(byte[], int, int)
88 | */
89 | @Override
90 | public int read(byte[] b, int off, int len) throws IOException {
91 | if (currentEntry != null) {
92 | if (currentFileSize == currentEntry.getSize()) {
93 | return -1;
94 | } else if ((currentEntry.getSize() - currentFileSize) < len) {
95 | len = (int) (currentEntry.getSize() - currentFileSize);
96 | }
97 | }
98 |
99 | int br = super.read(b, off, len);
100 |
101 | if (br != -1) {
102 | if (currentEntry != null) {
103 | currentFileSize += br;
104 | }
105 |
106 | bytesRead += br;
107 | }
108 |
109 | return br;
110 | }
111 |
112 | /**
113 | * Returns the next entry in the tar file
114 | *
115 | * @return TarEntry
116 | * @throws IOException
117 | */
118 | public TarEntry getNextEntry() throws IOException {
119 | closeCurrentEntry();
120 |
121 | byte[] header = new byte[TarConstants.HEADER_BLOCK];
122 | byte[] theader = new byte[TarConstants.HEADER_BLOCK];
123 | int tr = 0;
124 |
125 | // Read full header
126 | while (tr < TarConstants.HEADER_BLOCK) {
127 | int res = read(theader, 0, TarConstants.HEADER_BLOCK - tr);
128 |
129 | if (res < 0) {
130 | break;
131 | }
132 |
133 | System.arraycopy(theader, 0, header, tr, res);
134 | tr += res;
135 | }
136 |
137 | // Check if record is null
138 | boolean eof = true;
139 | for (byte b : header) {
140 | if (b != 0) {
141 | eof = false;
142 | break;
143 | }
144 | }
145 |
146 | if (!eof) {
147 | currentEntry = new TarEntry(header);
148 | }
149 |
150 | return currentEntry;
151 | }
152 |
153 | /**
154 | * Returns the current offset (in bytes) from the beginning of the stream.
155 | * This can be used to find out at which point in a tar file an entry's content begins, for instance.
156 | */
157 | public long getCurrentOffset() {
158 | return bytesRead;
159 | }
160 |
161 | /**
162 | * Closes the current tar entry
163 | *
164 | * @throws IOException
165 | */
166 | protected void closeCurrentEntry() throws IOException {
167 | if (currentEntry != null) {
168 | if (currentEntry.getSize() > currentFileSize) {
169 | // Not fully read, skip rest of the bytes
170 | long bs = 0;
171 | while (bs < currentEntry.getSize() - currentFileSize) {
172 | long res = skip(currentEntry.getSize() - currentFileSize - bs);
173 |
174 | if (res == 0 && currentEntry.getSize() - currentFileSize > 0) {
175 | // I suspect file corruption
176 | throw new IOException("Possible tar file corruption");
177 | }
178 |
179 | bs += res;
180 | }
181 | }
182 |
183 | currentEntry = null;
184 | currentFileSize = 0L;
185 | skipPad();
186 | }
187 | }
188 |
189 | /**
190 | * Skips the pad at the end of each tar entry file content
191 | *
192 | * @throws IOException
193 | */
194 | protected void skipPad() throws IOException {
195 | if (bytesRead > 0) {
196 | int extra = (int) (bytesRead % TarConstants.DATA_BLOCK);
197 |
198 | if (extra > 0) {
199 | long bs = 0;
200 | while (bs < TarConstants.DATA_BLOCK - extra) {
201 | long res = skip(TarConstants.DATA_BLOCK - extra - bs);
202 | bs += res;
203 | }
204 | }
205 | }
206 | }
207 |
208 | /**
209 | * Skips 'n' bytes on the InputStream
210 | * Overrides default implementation of skip
211 | *
212 | */
213 | @Override
214 | public long skip(long n) throws IOException {
215 | if (defaultSkip) {
216 | // use skip method of parent stream
217 | // may not work if skip not implemented by parent
218 | long bs = super.skip(n);
219 | bytesRead += bs;
220 |
221 | return bs;
222 | }
223 |
224 | if (n <= 0) {
225 | return 0;
226 | }
227 |
228 | long left = n;
229 | byte[] sBuff = new byte[SKIP_BUFFER_SIZE];
230 |
231 | while (left > 0) {
232 | int res = read(sBuff, 0, (int) (left < SKIP_BUFFER_SIZE ? left : SKIP_BUFFER_SIZE));
233 | if (res < 0) {
234 | break;
235 | }
236 | left -= res;
237 | }
238 |
239 | return n - left;
240 | }
241 |
242 | public boolean isDefaultSkip() {
243 | return defaultSkip;
244 | }
245 |
246 | public void setDefaultSkip(boolean defaultSkip) {
247 | this.defaultSkip = defaultSkip;
248 | }
249 | }
250 |
--------------------------------------------------------------------------------
/src/main/java/org/kamranzafar/jtar/TarOutputStream.java:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright 2012 Kamran Zafar
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * 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 |
18 | package org.kamranzafar.jtar;
19 |
20 | import java.io.*;
21 |
22 | /**
23 | * @author Kamran Zafar
24 | *
25 | */
26 | public class TarOutputStream extends OutputStream {
27 | private final OutputStream out;
28 | private long bytesWritten;
29 | private long currentFileSize;
30 | private TarEntry currentEntry;
31 |
32 | public TarOutputStream(OutputStream out) {
33 | this.out = out;
34 | bytesWritten = 0;
35 | currentFileSize = 0;
36 | }
37 |
38 | public TarOutputStream(final File fout) throws FileNotFoundException {
39 | this.out = new BufferedOutputStream(new FileOutputStream(fout));
40 | bytesWritten = 0;
41 | currentFileSize = 0;
42 | }
43 |
44 | /**
45 | * Opens a file for writing.
46 | */
47 | public TarOutputStream(final File fout, final boolean append) throws IOException {
48 | @SuppressWarnings("resource")
49 | RandomAccessFile raf = new RandomAccessFile(fout, "rw");
50 | final long fileSize = fout.length();
51 | if (append && fileSize > TarConstants.EOF_BLOCK) {
52 | raf.seek(fileSize - TarConstants.EOF_BLOCK);
53 | }
54 | out = new BufferedOutputStream(new FileOutputStream(raf.getFD()));
55 | }
56 |
57 | /**
58 | * Appends the EOF record and closes the stream
59 | *
60 | * @see java.io.FilterOutputStream#close()
61 | */
62 | @Override
63 | public void close() throws IOException {
64 | closeCurrentEntry();
65 | write( new byte[TarConstants.EOF_BLOCK] );
66 | out.close();
67 | }
68 | /**
69 | * Writes a byte to the stream and updates byte counters
70 | *
71 | * @see java.io.FilterOutputStream#write(int)
72 | */
73 | @Override
74 | public void write(int b) throws IOException {
75 | out.write( b );
76 | bytesWritten += 1;
77 |
78 | if (currentEntry != null) {
79 | currentFileSize += 1;
80 | }
81 | }
82 |
83 | /**
84 | * Checks if the bytes being written exceed the current entry size.
85 | *
86 | * @see java.io.FilterOutputStream#write(byte[], int, int)
87 | */
88 | @Override
89 | public void write(byte[] b, int off, int len) throws IOException {
90 | if (currentEntry != null && !currentEntry.isDirectory()) {
91 | if (currentEntry.getSize() < currentFileSize + len) {
92 | throw new IOException( "The current entry[" + currentEntry.getName() + "] size["
93 | + currentEntry.getSize() + "] is smaller than the bytes[" + ( currentFileSize + len )
94 | + "] being written." );
95 | }
96 | }
97 |
98 | out.write( b, off, len );
99 |
100 | bytesWritten += len;
101 |
102 | if (currentEntry != null) {
103 | currentFileSize += len;
104 | }
105 | }
106 |
107 | /**
108 | * Writes the next tar entry header on the stream
109 | *
110 | * @throws IOException
111 | */
112 | public void putNextEntry(TarEntry entry) throws IOException {
113 | closeCurrentEntry();
114 |
115 | byte[] header = new byte[TarConstants.HEADER_BLOCK];
116 | entry.writeEntryHeader( header );
117 |
118 | write( header );
119 |
120 | currentEntry = entry;
121 | }
122 |
123 | /**
124 | * Closes the current tar entry
125 | *
126 | * @throws IOException
127 | */
128 | protected void closeCurrentEntry() throws IOException {
129 | if (currentEntry != null) {
130 | if (currentEntry.getSize() > currentFileSize) {
131 | throw new IOException( "The current entry[" + currentEntry.getName() + "] of size["
132 | + currentEntry.getSize() + "] has not been fully written." );
133 | }
134 |
135 | currentEntry = null;
136 | currentFileSize = 0;
137 |
138 | pad();
139 | }
140 | }
141 |
142 | /**
143 | * Pads the last content block
144 | *
145 | * @throws IOException
146 | */
147 | protected void pad() throws IOException {
148 | if (bytesWritten > 0) {
149 | int extra = (int) ( bytesWritten % TarConstants.DATA_BLOCK );
150 |
151 | if (extra > 0) {
152 | write( new byte[TarConstants.DATA_BLOCK - extra] );
153 | }
154 | }
155 | }
156 | }
157 |
--------------------------------------------------------------------------------
/src/main/java/org/kamranzafar/jtar/TarUtils.java:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright 2012 Kamran Zafar
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * 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 |
18 | package org.kamranzafar.jtar;
19 |
20 | import java.io.File;
21 |
22 | /**
23 | * @author Kamran
24 | *
25 | */
26 | public class TarUtils {
27 | /**
28 | * Determines the tar file size of the given folder/file path
29 | */
30 | public static long calculateTarSize(File path) {
31 | return tarSize(path) + TarConstants.EOF_BLOCK;
32 | }
33 |
34 | private static long tarSize(File dir) {
35 | long size = 0;
36 |
37 | if (dir.isFile()) {
38 | return entrySize(dir.length());
39 | } else {
40 | File[] subFiles = dir.listFiles();
41 |
42 | if (subFiles != null && subFiles.length > 0) {
43 | for (File file : subFiles) {
44 | if (file.isFile()) {
45 | size += entrySize(file.length());
46 | } else {
47 | size += tarSize(file);
48 | }
49 | }
50 | } else {
51 | // Empty folder header
52 | return TarConstants.HEADER_BLOCK;
53 | }
54 | }
55 |
56 | return size;
57 | }
58 |
59 | private static long entrySize(long fileSize) {
60 | long size = 0;
61 | size += TarConstants.HEADER_BLOCK; // Header
62 | size += fileSize; // File size
63 |
64 | long extra = size % TarConstants.DATA_BLOCK;
65 |
66 | if (extra > 0) {
67 | size += (TarConstants.DATA_BLOCK - extra); // pad
68 | }
69 |
70 | return size;
71 | }
72 |
73 | public static String trim(String s, char c) {
74 | StringBuilder tmp = new StringBuilder(s);
75 | for (int i = 0; i < tmp.length(); i++) {
76 | if (tmp.charAt(i) != c) {
77 | break;
78 | } else {
79 | tmp.deleteCharAt(i);
80 | }
81 | }
82 |
83 | for (int i = tmp.length() - 1; i >= 0; i--) {
84 | if (tmp.charAt(i) != c) {
85 | break;
86 | } else {
87 | tmp.deleteCharAt(i);
88 | }
89 | }
90 |
91 | return tmp.toString();
92 | }
93 | }
94 |
--------------------------------------------------------------------------------