Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 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.tar; |
| 20 | |
| 21 | import java.io.File; |
| 22 | import java.util.Date; |
| 23 | import java.util.Locale; |
| 24 | |
| 25 | import org.apache.commons.compress.archivers.ArchiveEntry; |
| 26 | |
| 27 | /** |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 28 | * This class represents an entry in a Tar archive. It consists |
| 29 | * of the entry's header, as well as the entry's File. Entries |
| 30 | * can be instantiated in one of three ways, depending on how |
| 31 | * they are to be used. |
| 32 | * <p> |
| 33 | * TarEntries that are created from the header bytes read from |
| 34 | * an archive are instantiated with the TarEntry( byte[] ) |
| 35 | * constructor. These entries will be used when extracting from |
| 36 | * or listing the contents of an archive. These entries have their |
| 37 | * header filled in using the header bytes. They also set the File |
| 38 | * to null, since they reference an archive entry not a file. |
| 39 | * <p> |
| 40 | * TarEntries that are created from Files that are to be written |
| 41 | * into an archive are instantiated with the TarEntry( File ) |
| 42 | * constructor. These entries have their header filled in using |
| 43 | * the File's information. They also keep a reference to the File |
| 44 | * for convenience when writing entries. |
| 45 | * <p> |
| 46 | * Finally, TarEntries can be constructed from nothing but a name. |
| 47 | * This allows the programmer to construct the entry by hand, for |
| 48 | * instance when only an InputStream is available for writing to |
| 49 | * the archive, and the header information is constructed from |
| 50 | * other information. In this case the header fields are set to |
| 51 | * defaults and the File is set to null. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 52 | * |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 53 | * <p> |
| 54 | * The C structure for a Tar Entry's header is: |
| 55 | * <pre> |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 56 | * struct header { |
Sebastian Bazley | 24f9c9b | 2009-04-02 15:19:17 +0000 | [diff] [blame] | 57 | * char name[100]; // TarConstants.NAMELEN |
| 58 | * char mode[8]; // TarConstants.MODELEN |
| 59 | * char uid[8]; // TarConstants.UIDLEN |
| 60 | * char gid[8]; // TarConstants.GIDLEN |
| 61 | * char size[12]; // TarConstants.SIZELEN |
| 62 | * char mtime[12]; // TarConstants.MODTIMELEN |
| 63 | * char chksum[8]; // TarConstants.CHKSUMLEN |
| 64 | * char linkflag[1]; |
| 65 | * char linkname[100]; // TarConstants.NAMELEN |
| 66 | * The following fields are only present in new-style POSIX tar archives: |
| 67 | * char magic[8]; // TarConstants.MAGICLEN |
| 68 | * TODO: Posix/GNU split this into magic[6] and char version[2]; |
| 69 | * char uname[32]; // TarConstants.UNAMELEN |
| 70 | * char gname[32]; // TarConstants.GNAMELEN |
| 71 | * char devmajor[8]; // TarConstants.DEVLEN |
| 72 | * char devminor[8]; // TarConstants.DEVLEN |
| 73 | * char prefix[155]; // Used if "name" field is not long enough to hold the path |
| 74 | * char pad[12]; // NULs |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 75 | * } header; |
Sebastian Bazley | 24f9c9b | 2009-04-02 15:19:17 +0000 | [diff] [blame] | 76 | * All unused bytes are set to null. |
| 77 | * New-style GNU tar files are slightly different from the above. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 78 | * </pre> |
Sebastian Bazley | 99870ef | 2009-03-28 00:04:36 +0000 | [diff] [blame] | 79 | * |
| 80 | * @NotThreadSafe |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 81 | */ |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 82 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 83 | public class TarArchiveEntry implements TarConstants, ArchiveEntry { |
| 84 | /** The entry's name. */ |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 85 | private String name; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 86 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 87 | /** The entry's permission mode. */ |
| 88 | private int mode; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 89 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 90 | /** The entry's user id. */ |
| 91 | private int userId; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 92 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 93 | /** The entry's group id. */ |
| 94 | private int groupId; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 95 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 96 | /** The entry's size. */ |
| 97 | private long size; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 98 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 99 | /** The entry's modification time. */ |
| 100 | private long modTime; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 101 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 102 | /** The entry's link flag. */ |
| 103 | private byte linkFlag; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 104 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 105 | /** The entry's link name. */ |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 106 | private String linkName; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 107 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 108 | /** The entry's magic tag. */ |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 109 | private String magic; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 110 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 111 | /** The entry's user name. */ |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 112 | private String userName; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 113 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 114 | /** The entry's group name. */ |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 115 | private String groupName; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 116 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 117 | /** The entry's major device number. */ |
| 118 | private int devMajor; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 119 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 120 | /** The entry's minor device number. */ |
| 121 | private int devMinor; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 122 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 123 | /** The entry's file reference */ |
| 124 | private File file; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 125 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 126 | /** Maximum length of a user's name in the tar file */ |
| 127 | public static final int MAX_NAMELEN = 31; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 128 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 129 | /** Default permissions bits for directories */ |
| 130 | public static final int DEFAULT_DIR_MODE = 040755; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 131 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 132 | /** Default permissions bits for files */ |
| 133 | public static final int DEFAULT_FILE_MODE = 0100644; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 134 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 135 | /** Convert millis to seconds */ |
| 136 | public static final int MILLIS_PER_SECOND = 1000; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 137 | |
| 138 | /** |
| 139 | * Construct an empty entry and prepares the header values. |
| 140 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 141 | private TarArchiveEntry () { |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 142 | this.magic = MAGIC_POSIX; |
| 143 | this.name = ""; |
| 144 | this.linkName = ""; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 145 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 146 | String user = System.getProperty("user.name", ""); |
| 147 | |
| 148 | if (user.length() > MAX_NAMELEN) { |
| 149 | user = user.substring(0, MAX_NAMELEN); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 150 | } |
| 151 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 152 | this.userId = 0; |
| 153 | this.groupId = 0; |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 154 | this.userName = user; |
| 155 | this.groupName = ""; |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 156 | this.file = null; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 157 | } |
| 158 | |
| 159 | /** |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 160 | * Construct an entry with only a name. This allows the programmer |
| 161 | * to construct the entry's header "by hand". File is set to null. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 162 | * |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 163 | * @param name the entry name |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 164 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 165 | public TarArchiveEntry(String name) { |
| 166 | this(); |
| 167 | |
Stefan Bodewig | 32eea1e | 2009-03-17 12:53:22 +0000 | [diff] [blame] | 168 | name = normalizeFileName(name); |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 169 | boolean isDir = name.endsWith("/"); |
| 170 | |
| 171 | this.devMajor = 0; |
| 172 | this.devMinor = 0; |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 173 | this.name = name; |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 174 | this.mode = isDir ? DEFAULT_DIR_MODE : DEFAULT_FILE_MODE; |
| 175 | this.linkFlag = isDir ? LF_DIR : LF_NORMAL; |
| 176 | this.userId = 0; |
| 177 | this.groupId = 0; |
| 178 | this.size = 0; |
| 179 | this.modTime = (new Date()).getTime() / MILLIS_PER_SECOND; |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 180 | this.linkName = ""; |
| 181 | this.userName = ""; |
| 182 | this.groupName = ""; |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 183 | this.devMajor = 0; |
| 184 | this.devMinor = 0; |
| 185 | |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 186 | } |
| 187 | |
| 188 | /** |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 189 | * Construct an entry with a name and a link flag. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 190 | * |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 191 | * @param name the entry name |
| 192 | * @param linkFlag the entry link flag. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 193 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 194 | public TarArchiveEntry(String name, byte linkFlag) { |
| 195 | this(name); |
| 196 | this.linkFlag = linkFlag; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 197 | } |
| 198 | |
| 199 | /** |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 200 | * Construct an entry for a file. File is set to file, and the |
| 201 | * header is constructed from information from the file. |
Sebastian Bazley | fec51a1 | 2009-03-31 00:35:56 +0000 | [diff] [blame] | 202 | * The name is set from the normalized file path. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 203 | * |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 204 | * @param file The file that the entry represents. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 205 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 206 | public TarArchiveEntry(File file) { |
Sebastian Bazley | fec51a1 | 2009-03-31 00:35:56 +0000 | [diff] [blame] | 207 | this(file, normalizeFileName(file.getPath())); |
| 208 | } |
| 209 | |
| 210 | /** |
| 211 | * Construct an entry for a file. File is set to file, and the |
| 212 | * header is constructed from information from the file. |
| 213 | * |
| 214 | * @param file The file that the entry represents. |
| 215 | * @param fileName the name to be used for the entry. |
| 216 | */ |
| 217 | public TarArchiveEntry(File file, String fileName) { |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 218 | this(); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 219 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 220 | this.file = file; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 221 | |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 222 | this.linkName = ""; |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 223 | |
| 224 | if (file.isDirectory()) { |
| 225 | this.mode = DEFAULT_DIR_MODE; |
| 226 | this.linkFlag = LF_DIR; |
| 227 | |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 228 | int nameLength = fileName.length(); |
Stefan Bodewig | 32eea1e | 2009-03-17 12:53:22 +0000 | [diff] [blame] | 229 | if (nameLength == 0 || name.charAt(nameLength - 1) != '/') { |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 230 | this.name = fileName + "/"; |
| 231 | } else { |
| 232 | this.name = fileName; |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 233 | } |
Stefan Bodewig | c013e28 | 2009-03-18 04:38:47 +0000 | [diff] [blame] | 234 | this.size = 0; |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 235 | } else { |
| 236 | this.mode = DEFAULT_FILE_MODE; |
| 237 | this.linkFlag = LF_NORMAL; |
Stefan Bodewig | c013e28 | 2009-03-18 04:38:47 +0000 | [diff] [blame] | 238 | this.size = file.length(); |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 239 | this.name = fileName; |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 240 | } |
| 241 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 242 | this.modTime = file.lastModified() / MILLIS_PER_SECOND; |
| 243 | this.devMajor = 0; |
| 244 | this.devMinor = 0; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 245 | } |
| 246 | |
| 247 | /** |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 248 | * Construct an entry from an archive's header bytes. File is set |
| 249 | * to null. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 250 | * |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 251 | * @param headerBuf The header bytes from a tar archive entry. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 252 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 253 | public TarArchiveEntry(byte[] headerBuf) { |
| 254 | this(); |
| 255 | parseTarHeader(headerBuf); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 256 | } |
| 257 | |
| 258 | /** |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 259 | * Determine if the two entries are equal. Equality is determined |
| 260 | * by the header names being equal. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 261 | * |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 262 | * @param it Entry to be checked for equality. |
| 263 | * @return True if the entries are equal. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 264 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 265 | public boolean equals(TarArchiveEntry it) { |
| 266 | return getName().equals(it.getName()); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 267 | } |
| 268 | |
| 269 | /** |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 270 | * Determine if the two entries are equal. Equality is determined |
| 271 | * by the header names being equal. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 272 | * |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 273 | * @param it Entry to be checked for equality. |
| 274 | * @return True if the entries are equal. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 275 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 276 | public boolean equals(Object it) { |
| 277 | if (it == null || getClass() != it.getClass()) { |
| 278 | return false; |
| 279 | } |
| 280 | return equals((TarArchiveEntry) it); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 281 | } |
| 282 | |
| 283 | /** |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 284 | * Hashcodes are based on entry names. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 285 | * |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 286 | * @return the entry hashcode |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 287 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 288 | public int hashCode() { |
| 289 | return getName().hashCode(); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 290 | } |
| 291 | |
| 292 | /** |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 293 | * Determine if the given entry is a descendant of this entry. |
| 294 | * Descendancy is determined by the name of the descendant |
| 295 | * starting with this entry's name. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 296 | * |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 297 | * @param desc Entry to be checked as a descendent of this. |
| 298 | * @return True if entry is a descendant of this. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 299 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 300 | public boolean isDescendent(TarArchiveEntry desc) { |
| 301 | return desc.getName().startsWith(getName()); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 302 | } |
| 303 | |
| 304 | /** |
| 305 | * Get this entry's name. |
| 306 | * |
| 307 | * @return This entry's name. |
| 308 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 309 | public String getName() { |
| 310 | return name.toString(); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 311 | } |
| 312 | |
| 313 | /** |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 314 | * Set this entry's name. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 315 | * |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 316 | * @param name This entry's new name. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 317 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 318 | public void setName(String name) { |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 319 | this.name = normalizeFileName(name); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 320 | } |
| 321 | |
| 322 | /** |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 323 | * Set the mode for this entry |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 324 | * |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 325 | * @param mode the mode for this entry |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 326 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 327 | public void setMode(int mode) { |
| 328 | this.mode = mode; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 329 | } |
| 330 | |
| 331 | /** |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 332 | * Get this entry's link name. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 333 | * |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 334 | * @return This entry's link name. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 335 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 336 | public String getLinkName() { |
| 337 | return linkName.toString(); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 338 | } |
| 339 | |
| 340 | /** |
| 341 | * Get this entry's user id. |
| 342 | * |
| 343 | * @return This entry's user id. |
| 344 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 345 | public int getUserId() { |
| 346 | return userId; |
| 347 | } |
| 348 | |
| 349 | /** |
| 350 | * Set this entry's user id. |
| 351 | * |
| 352 | * @param userId This entry's new user id. |
| 353 | */ |
| 354 | public void setUserId(int userId) { |
| 355 | this.userId = userId; |
| 356 | } |
| 357 | |
| 358 | /** |
| 359 | * Get this entry's group id. |
| 360 | * |
| 361 | * @return This entry's group id. |
| 362 | */ |
| 363 | public int getGroupId() { |
| 364 | return groupId; |
| 365 | } |
| 366 | |
| 367 | /** |
| 368 | * Set this entry's group id. |
| 369 | * |
| 370 | * @param groupId This entry's new group id. |
| 371 | */ |
| 372 | public void setGroupId(int groupId) { |
| 373 | this.groupId = groupId; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 374 | } |
| 375 | |
| 376 | /** |
| 377 | * Get this entry's user name. |
| 378 | * |
| 379 | * @return This entry's user name. |
| 380 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 381 | public String getUserName() { |
| 382 | return userName.toString(); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 383 | } |
| 384 | |
| 385 | /** |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 386 | * Set this entry's user name. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 387 | * |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 388 | * @param userName This entry's new user name. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 389 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 390 | public void setUserName(String userName) { |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 391 | this.userName = userName; |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 392 | } |
| 393 | |
| 394 | /** |
| 395 | * Get this entry's group name. |
| 396 | * |
| 397 | * @return This entry's group name. |
| 398 | */ |
| 399 | public String getGroupName() { |
| 400 | return groupName.toString(); |
| 401 | } |
| 402 | |
| 403 | /** |
| 404 | * Set this entry's group name. |
| 405 | * |
| 406 | * @param groupName This entry's new group name. |
| 407 | */ |
| 408 | public void setGroupName(String groupName) { |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 409 | this.groupName = groupName; |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 410 | } |
| 411 | |
| 412 | /** |
| 413 | * Convenience method to set this entry's group and user ids. |
| 414 | * |
| 415 | * @param userId This entry's new user id. |
| 416 | * @param groupId This entry's new group id. |
| 417 | */ |
| 418 | public void setIds(int userId, int groupId) { |
| 419 | setUserId(userId); |
| 420 | setGroupId(groupId); |
| 421 | } |
| 422 | |
| 423 | /** |
| 424 | * Convenience method to set this entry's group and user names. |
| 425 | * |
| 426 | * @param userName This entry's new user name. |
| 427 | * @param groupName This entry's new group name. |
| 428 | */ |
| 429 | public void setNames(String userName, String groupName) { |
| 430 | setUserName(userName); |
| 431 | setGroupName(groupName); |
| 432 | } |
| 433 | |
| 434 | /** |
| 435 | * Set this entry's modification time. The parameter passed |
| 436 | * to this method is in "Java time". |
| 437 | * |
| 438 | * @param time This entry's new modification time. |
| 439 | */ |
| 440 | public void setModTime(long time) { |
| 441 | modTime = time / MILLIS_PER_SECOND; |
| 442 | } |
| 443 | |
| 444 | /** |
| 445 | * Set this entry's modification time. |
| 446 | * |
| 447 | * @param time This entry's new modification time. |
| 448 | */ |
| 449 | public void setModTime(Date time) { |
| 450 | modTime = time.getTime() / MILLIS_PER_SECOND; |
| 451 | } |
| 452 | |
| 453 | /** |
| 454 | * Set this entry's modification time. |
| 455 | * |
| 456 | * @return time This entry's new modification time. |
| 457 | */ |
| 458 | public Date getModTime() { |
| 459 | return new Date(modTime * MILLIS_PER_SECOND); |
| 460 | } |
| 461 | |
| 462 | /** |
| 463 | * Get this entry's file. |
| 464 | * |
| 465 | * @return This entry's file. |
| 466 | */ |
| 467 | public File getFile() { |
| 468 | return file; |
| 469 | } |
| 470 | |
| 471 | /** |
| 472 | * Get this entry's mode. |
| 473 | * |
| 474 | * @return This entry's mode. |
| 475 | */ |
| 476 | public int getMode() { |
| 477 | return mode; |
| 478 | } |
| 479 | |
| 480 | /** |
| 481 | * Get this entry's file size. |
| 482 | * |
| 483 | * @return This entry's file size. |
| 484 | */ |
| 485 | public long getSize() { |
| 486 | return size; |
| 487 | } |
| 488 | |
| 489 | /** |
| 490 | * Set this entry's file size. |
| 491 | * |
| 492 | * @param size This entry's new file size. |
Sebastian Bazley | 26d12c5 | 2009-03-31 18:45:14 +0000 | [diff] [blame] | 493 | * @throws IllegalArgumentException if the size is < 0 |
| 494 | * or > {@link TarConstants#MAXSIZE} (077777777777L). |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 495 | */ |
| 496 | public void setSize(long size) { |
Sebastian Bazley | 26d12c5 | 2009-03-31 18:45:14 +0000 | [diff] [blame] | 497 | if (size > MAXSIZE || size < 0){ |
| 498 | throw new IllegalArgumentException("Size is out of range: "+size); |
| 499 | } |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 500 | this.size = size; |
| 501 | } |
| 502 | |
| 503 | |
| 504 | /** |
| 505 | * Indicate if this entry is a GNU long name block |
| 506 | * |
| 507 | * @return true if this is a long name extension provided by GNU tar |
| 508 | */ |
| 509 | public boolean isGNULongNameEntry() { |
| 510 | return linkFlag == LF_GNUTYPE_LONGNAME |
Stefan Bodewig | 75f92f6 | 2009-03-17 12:14:17 +0000 | [diff] [blame] | 511 | && name.toString().equals(GNU_LONGLINK); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 512 | } |
| 513 | |
| 514 | /** |
| 515 | * Return whether or not this entry represents a directory. |
| 516 | * |
| 517 | * @return True if this entry is a directory. |
| 518 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 519 | public boolean isDirectory() { |
| 520 | if (file != null) { |
| 521 | return file.isDirectory(); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 522 | } |
| 523 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 524 | if (linkFlag == LF_DIR) { |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 525 | return true; |
| 526 | } |
| 527 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 528 | if (getName().endsWith("/")) { |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 529 | return true; |
| 530 | } |
| 531 | |
| 532 | return false; |
| 533 | } |
| 534 | |
| 535 | /** |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 536 | * If this entry represents a file, and the file is a directory, return |
| 537 | * an array of TarEntries for this entry's children. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 538 | * |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 539 | * @return An array of TarEntry's for this entry's children. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 540 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 541 | public TarArchiveEntry[] getDirectoryEntries() { |
| 542 | if (file == null || !file.isDirectory()) { |
| 543 | return new TarArchiveEntry[0]; |
| 544 | } |
| 545 | |
| 546 | String[] list = file.list(); |
| 547 | TarArchiveEntry[] result = new TarArchiveEntry[list.length]; |
| 548 | |
| 549 | for (int i = 0; i < list.length; ++i) { |
| 550 | result[i] = new TarArchiveEntry(new File(file, list[i])); |
| 551 | } |
| 552 | |
| 553 | return result; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 554 | } |
| 555 | |
| 556 | /** |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 557 | * Write an entry's header information to a header buffer. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 558 | * |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 559 | * @param outbuf The tar entry header buffer to fill in. |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 560 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 561 | public void writeEntryHeader(byte[] outbuf) { |
| 562 | int offset = 0; |
| 563 | |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 564 | offset = TarUtils.formatNameBytes(name, outbuf, offset, NAMELEN); |
| 565 | offset = TarUtils.formatOctalBytes(mode, outbuf, offset, MODELEN); |
| 566 | offset = TarUtils.formatOctalBytes(userId, outbuf, offset, UIDLEN); |
| 567 | offset = TarUtils.formatOctalBytes(groupId, outbuf, offset, GIDLEN); |
| 568 | offset = TarUtils.formatLongOctalBytes(size, outbuf, offset, SIZELEN); |
| 569 | offset = TarUtils.formatLongOctalBytes(modTime, outbuf, offset, MODTIMELEN); |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 570 | |
| 571 | int csOffset = offset; |
| 572 | |
| 573 | for (int c = 0; c < CHKSUMLEN; ++c) { |
| 574 | outbuf[offset++] = (byte) ' '; |
| 575 | } |
| 576 | |
| 577 | outbuf[offset++] = linkFlag; |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 578 | offset = TarUtils.formatNameBytes(linkName, outbuf, offset, NAMELEN); |
| 579 | offset = TarUtils.formatNameBytes(magic, outbuf, offset, MAGICLEN); |
| 580 | offset = TarUtils.formatNameBytes(userName, outbuf, offset, UNAMELEN); |
| 581 | offset = TarUtils.formatNameBytes(groupName, outbuf, offset, GNAMELEN); |
| 582 | offset = TarUtils.formatOctalBytes(devMajor, outbuf, offset, DEVLEN); |
| 583 | offset = TarUtils.formatOctalBytes(devMinor, outbuf, offset, DEVLEN); |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 584 | |
| 585 | while (offset < outbuf.length) { |
| 586 | outbuf[offset++] = 0; |
| 587 | } |
| 588 | |
| 589 | long chk = TarUtils.computeCheckSum(outbuf); |
| 590 | |
Sebastian Bazley | 1d55670 | 2009-04-02 18:45:02 +0000 | [diff] [blame^] | 591 | TarUtils.formatCheckSumOctalBytes(chk, outbuf, csOffset, CHKSUMLEN); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 592 | } |
| 593 | |
| 594 | /** |
| 595 | * Parse an entry's header information from a header buffer. |
| 596 | * |
| 597 | * @param header The tar entry header buffer to get information from. |
| 598 | */ |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 599 | public void parseTarHeader(byte[] header) { |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 600 | int offset = 0; |
| 601 | |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 602 | name = TarUtils.parseName(header, offset, NAMELEN); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 603 | offset += NAMELEN; |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 604 | mode = (int) TarUtils.parseOctal(header, offset, MODELEN); |
| 605 | offset += MODELEN; |
| 606 | userId = (int) TarUtils.parseOctal(header, offset, UIDLEN); |
| 607 | offset += UIDLEN; |
| 608 | groupId = (int) TarUtils.parseOctal(header, offset, GIDLEN); |
| 609 | offset += GIDLEN; |
| 610 | size = TarUtils.parseOctal(header, offset, SIZELEN); |
| 611 | offset += SIZELEN; |
| 612 | modTime = TarUtils.parseOctal(header, offset, MODTIMELEN); |
| 613 | offset += MODTIMELEN; |
| 614 | offset += CHKSUMLEN; |
| 615 | linkFlag = header[offset++]; |
| 616 | linkName = TarUtils.parseName(header, offset, NAMELEN); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 617 | offset += NAMELEN; |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 618 | magic = TarUtils.parseName(header, offset, MAGICLEN); |
| 619 | offset += MAGICLEN; |
| 620 | userName = TarUtils.parseName(header, offset, UNAMELEN); |
| 621 | offset += UNAMELEN; |
| 622 | groupName = TarUtils.parseName(header, offset, GNAMELEN); |
| 623 | offset += GNAMELEN; |
| 624 | devMajor = (int) TarUtils.parseOctal(header, offset, DEVLEN); |
| 625 | offset += DEVLEN; |
| 626 | devMinor = (int) TarUtils.parseOctal(header, offset, DEVLEN); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 627 | } |
Stefan Bodewig | 32eea1e | 2009-03-17 12:53:22 +0000 | [diff] [blame] | 628 | |
| 629 | /** |
| 630 | * Strips Windows' drive letter as well as any leading slashes, |
| 631 | * turns path separators into forward slahes. |
| 632 | */ |
| 633 | private static String normalizeFileName(String fileName) { |
| 634 | String osname = System.getProperty("os.name").toLowerCase(Locale.US); |
| 635 | |
| 636 | if (osname != null) { |
| 637 | |
| 638 | // Strip off drive letters! |
| 639 | // REVIEW Would a better check be "(File.separator == '\')"? |
| 640 | |
| 641 | if (osname.startsWith("windows")) { |
| 642 | if (fileName.length() > 2) { |
| 643 | char ch1 = fileName.charAt(0); |
| 644 | char ch2 = fileName.charAt(1); |
| 645 | |
| 646 | if (ch2 == ':' |
| 647 | && ((ch1 >= 'a' && ch1 <= 'z') |
| 648 | || (ch1 >= 'A' && ch1 <= 'Z'))) { |
| 649 | fileName = fileName.substring(2); |
| 650 | } |
| 651 | } |
| 652 | } else if (osname.indexOf("netware") > -1) { |
| 653 | int colon = fileName.indexOf(':'); |
| 654 | if (colon != -1) { |
| 655 | fileName = fileName.substring(colon + 1); |
| 656 | } |
| 657 | } |
| 658 | } |
| 659 | |
| 660 | fileName = fileName.replace(File.separatorChar, '/'); |
| 661 | |
| 662 | // No absolute pathnames |
| 663 | // Windows (and Posix?) paths can start with "\\NetworkDrive\", |
| 664 | // so we loop on starting /'s. |
| 665 | while (fileName.startsWith("/")) { |
| 666 | fileName = fileName.substring(1); |
| 667 | } |
| 668 | return fileName; |
| 669 | } |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 670 | } |
Torsten Curdt | 46ad24d | 2009-01-08 11:09:25 +0000 | [diff] [blame] | 671 | |