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.ar; |
| 20 | |
Sebastian Bazley | fec51a1 | 2009-03-31 00:35:56 +0000 | [diff] [blame] | 21 | import java.io.File; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 22 | import java.io.IOException; |
| 23 | import java.io.OutputStream; |
| 24 | |
| 25 | import org.apache.commons.compress.archivers.ArchiveEntry; |
| 26 | import org.apache.commons.compress.archivers.ArchiveOutputStream; |
Sebastian Bazley | 865686a | 2009-04-14 23:21:52 +0000 | [diff] [blame] | 27 | import org.apache.commons.compress.utils.ArchiveUtils; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 28 | |
Sebastian Bazley | 1d3d6ea | 2009-03-14 02:24:54 +0000 | [diff] [blame] | 29 | /** |
Sebastian Bazley | a91e7c7 | 2009-03-27 21:13:51 +0000 | [diff] [blame] | 30 | * Implements the "ar" archive format as an output stream. |
| 31 | * |
| 32 | * @NotThreadSafe |
Sebastian Bazley | 1d3d6ea | 2009-03-14 02:24:54 +0000 | [diff] [blame] | 33 | */ |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 34 | public class ArArchiveOutputStream extends ArchiveOutputStream { |
Stefan Bodewig | 1b915c7 | 2011-08-08 11:39:41 +0000 | [diff] [blame] | 35 | /** Fail if a long file name is required in the archive. */ |
| 36 | public static final int LONGFILE_ERROR = 0; |
| 37 | |
| 38 | /** BSD ar extensions are used to store long file names in the archive. */ |
| 39 | public static final int LONGFILE_BSD = 1; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 40 | |
Stefan Bodewig | c30b588 | 2009-02-10 15:35:35 +0000 | [diff] [blame] | 41 | private final OutputStream out; |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 42 | private long entryOffset = 0; |
| 43 | private ArArchiveEntry prevEntry; |
Sebastian Bazley | 13b90ae | 2009-04-27 20:57:10 +0000 | [diff] [blame] | 44 | private boolean haveUnclosedEntry = false; |
Stefan Bodewig | 1b915c7 | 2011-08-08 11:39:41 +0000 | [diff] [blame] | 45 | private int longFileMode = LONGFILE_ERROR; |
| 46 | |
Christian Grobmeier | 285ee87 | 2009-04-27 17:48:29 +0000 | [diff] [blame] | 47 | /** indicates if this archive is finished */ |
Christian Grobmeier | 545bfa8 | 2009-04-27 17:43:58 +0000 | [diff] [blame] | 48 | private boolean finished = false; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 49 | |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 50 | public ArArchiveOutputStream( final OutputStream pOut ) { |
Stefan Bodewig | c30b588 | 2009-02-10 15:35:35 +0000 | [diff] [blame] | 51 | this.out = pOut; |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 52 | } |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 53 | |
Stefan Bodewig | 1b915c7 | 2011-08-08 11:39:41 +0000 | [diff] [blame] | 54 | /** |
| 55 | * Set the long file mode. |
| 56 | * This can be LONGFILE_ERROR(0) or LONGFILE_BSD(1). |
| 57 | * This specifies the treatment of long file names (names >= 16). |
| 58 | * Default is LONGFILE_ERROR. |
| 59 | * @param longFileMode the mode to use |
Gary D. Gregory | 2bd0dd4 | 2012-04-01 13:02:39 +0000 | [diff] [blame] | 60 | * @since 1.3 |
Stefan Bodewig | 1b915c7 | 2011-08-08 11:39:41 +0000 | [diff] [blame] | 61 | */ |
| 62 | public void setLongFileMode(int longFileMode) { |
| 63 | this.longFileMode = longFileMode; |
| 64 | } |
| 65 | |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 66 | private long writeArchiveHeader() throws IOException { |
Sebastian Bazley | 865686a | 2009-04-14 23:21:52 +0000 | [diff] [blame] | 67 | byte [] header = ArchiveUtils.toAsciiBytes(ArArchiveEntry.HEADER); |
Sebastian Bazley | 6140bf0 | 2009-03-28 15:48:15 +0000 | [diff] [blame] | 68 | out.write(header); |
| 69 | return header.length; |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 70 | } |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 71 | |
Stefan Bodewig | 46628ef | 2011-08-06 16:30:40 +0000 | [diff] [blame] | 72 | @Override |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 73 | public void closeArchiveEntry() throws IOException { |
Christian Grobmeier | a45e9cb | 2009-04-27 17:58:04 +0000 | [diff] [blame] | 74 | if(finished) { |
| 75 | throw new IOException("Stream has already been finished"); |
| 76 | } |
Sebastian Bazley | 13b90ae | 2009-04-27 20:57:10 +0000 | [diff] [blame] | 77 | if (prevEntry == null || !haveUnclosedEntry){ |
| 78 | throw new IOException("No current entry to close"); |
| 79 | } |
| 80 | if ((entryOffset % 2) != 0) { |
Sebastian Bazley | 6140bf0 | 2009-03-28 15:48:15 +0000 | [diff] [blame] | 81 | out.write('\n'); // Pad byte |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 82 | } |
Stefan Bodewig | 29f1d08 | 2009-03-30 15:07:54 +0000 | [diff] [blame] | 83 | haveUnclosedEntry = false; |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 84 | } |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 85 | |
Stefan Bodewig | 46628ef | 2011-08-06 16:30:40 +0000 | [diff] [blame] | 86 | @Override |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 87 | public void putArchiveEntry( final ArchiveEntry pEntry ) throws IOException { |
Christian Grobmeier | a45e9cb | 2009-04-27 17:58:04 +0000 | [diff] [blame] | 88 | if(finished) { |
| 89 | throw new IOException("Stream has already been finished"); |
| 90 | } |
Stefan Bodewig | 1b915c7 | 2011-08-08 11:39:41 +0000 | [diff] [blame] | 91 | |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 92 | ArArchiveEntry pArEntry = (ArArchiveEntry)pEntry; |
| 93 | if (prevEntry == null) { |
Stefan Bodewig | 8038cf7 | 2011-10-26 15:35:05 +0000 | [diff] [blame] | 94 | writeArchiveHeader(); |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 95 | } else { |
| 96 | if (prevEntry.getLength() != entryOffset) { |
| 97 | throw new IOException("length does not match entry (" + prevEntry.getLength() + " != " + entryOffset); |
| 98 | } |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 99 | |
Sebastian Bazley | 13b90ae | 2009-04-27 20:57:10 +0000 | [diff] [blame] | 100 | if (haveUnclosedEntry) { |
| 101 | closeArchiveEntry(); |
| 102 | } |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 103 | } |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 104 | |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 105 | prevEntry = pArEntry; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 106 | |
Stefan Bodewig | 8038cf7 | 2011-10-26 15:35:05 +0000 | [diff] [blame] | 107 | writeEntryHeader(pArEntry); |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 108 | |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 109 | entryOffset = 0; |
Stefan Bodewig | 29f1d08 | 2009-03-30 15:07:54 +0000 | [diff] [blame] | 110 | haveUnclosedEntry = true; |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 111 | } |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 112 | |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 113 | private long fill( final long pOffset, final long pNewOffset, final char pFill ) throws IOException { |
| 114 | final long diff = pNewOffset - pOffset; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 115 | |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 116 | if (diff > 0) { |
| 117 | for (int i = 0; i < diff; i++) { |
| 118 | write(pFill); |
| 119 | } |
| 120 | } |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 121 | |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 122 | return pNewOffset; |
| 123 | } |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 124 | |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 125 | private long write( final String data ) throws IOException { |
| 126 | final byte[] bytes = data.getBytes("ascii"); |
| 127 | write(bytes); |
| 128 | return bytes.length; |
| 129 | } |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 130 | |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 131 | private long writeEntryHeader( final ArArchiveEntry pEntry ) throws IOException { |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 132 | |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 133 | long offset = 0; |
Stefan Bodewig | 1b915c7 | 2011-08-08 11:39:41 +0000 | [diff] [blame] | 134 | boolean mustAppendName = false; |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 135 | |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 136 | final String n = pEntry.getName(); |
Stefan Bodewig | 1b915c7 | 2011-08-08 11:39:41 +0000 | [diff] [blame] | 137 | if (LONGFILE_ERROR == longFileMode && n.length() > 16) { |
Sebastian Bazley | fec51a1 | 2009-03-31 00:35:56 +0000 | [diff] [blame] | 138 | throw new IOException("filename too long, > 16 chars: "+n); |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 139 | } |
Stefan Bodewig | 1b915c7 | 2011-08-08 11:39:41 +0000 | [diff] [blame] | 140 | if (LONGFILE_BSD == longFileMode && |
| 141 | (n.length() > 16 || n.indexOf(" ") > -1)) { |
| 142 | mustAppendName = true; |
| 143 | offset += write(ArArchiveInputStream.BSD_LONGNAME_PREFIX |
| 144 | + String.valueOf(n.length())); |
| 145 | } else { |
| 146 | offset += write(n); |
| 147 | } |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 148 | |
| 149 | offset = fill(offset, 16, ' '); |
Stefan Bodewig | cf76a53 | 2009-08-01 19:52:32 +0000 | [diff] [blame] | 150 | final String m = "" + (pEntry.getLastModified()); |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 151 | if (m.length() > 12) { |
| 152 | throw new IOException("modified too long"); |
| 153 | } |
| 154 | offset += write(m); |
| 155 | |
| 156 | offset = fill(offset, 28, ' '); |
| 157 | final String u = "" + pEntry.getUserId(); |
| 158 | if (u.length() > 6) { |
| 159 | throw new IOException("userid too long"); |
| 160 | } |
| 161 | offset += write(u); |
| 162 | |
| 163 | offset = fill(offset, 34, ' '); |
| 164 | final String g = "" + pEntry.getGroupId(); |
| 165 | if (g.length() > 6) { |
| 166 | throw new IOException("groupid too long"); |
| 167 | } |
| 168 | offset += write(g); |
| 169 | |
| 170 | offset = fill(offset, 40, ' '); |
| 171 | final String fm = "" + Integer.toString(pEntry.getMode(), 8); |
| 172 | if (fm.length() > 8) { |
| 173 | throw new IOException("filemode too long"); |
| 174 | } |
| 175 | offset += write(fm); |
| 176 | |
| 177 | offset = fill(offset, 48, ' '); |
Stefan Bodewig | 1b915c7 | 2011-08-08 11:39:41 +0000 | [diff] [blame] | 178 | final String s = |
| 179 | String.valueOf(pEntry.getLength() |
| 180 | + (mustAppendName ? n.length() : 0)); |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 181 | if (s.length() > 10) { |
| 182 | throw new IOException("size too long"); |
| 183 | } |
| 184 | offset += write(s); |
| 185 | |
| 186 | offset = fill(offset, 58, ' '); |
| 187 | |
Sebastian Bazley | 6140bf0 | 2009-03-28 15:48:15 +0000 | [diff] [blame] | 188 | offset += write(ArArchiveEntry.TRAILER); |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 189 | |
Stefan Bodewig | 1b915c7 | 2011-08-08 11:39:41 +0000 | [diff] [blame] | 190 | if (mustAppendName) { |
| 191 | offset += write(n); |
| 192 | } |
| 193 | |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 194 | return offset; |
| 195 | } |
| 196 | |
Stefan Bodewig | 46628ef | 2011-08-06 16:30:40 +0000 | [diff] [blame] | 197 | @Override |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 198 | public void write(byte[] b, int off, int len) throws IOException { |
| 199 | out.write(b, off, len); |
Christian Grobmeier | ab26943 | 2009-04-24 06:30:17 +0000 | [diff] [blame] | 200 | count(len); |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 201 | entryOffset += len; |
| 202 | } |
| 203 | |
Sebastian Bazley | 8006d31 | 2010-05-12 18:18:19 +0000 | [diff] [blame] | 204 | /** |
| 205 | * Calls finish if necessary, and then closes the OutputStream |
| 206 | */ |
Stefan Bodewig | 46628ef | 2011-08-06 16:30:40 +0000 | [diff] [blame] | 207 | @Override |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 208 | public void close() throws IOException { |
Christian Grobmeier | 545bfa8 | 2009-04-27 17:43:58 +0000 | [diff] [blame] | 209 | if(!finished) { |
| 210 | finish(); |
| 211 | } |
Stefan Bodewig | 3f9bcc6 | 2009-02-10 14:20:05 +0000 | [diff] [blame] | 212 | out.close(); |
| 213 | prevEntry = null; |
| 214 | } |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 215 | |
Stefan Bodewig | 46628ef | 2011-08-06 16:30:40 +0000 | [diff] [blame] | 216 | @Override |
Sebastian Bazley | fec51a1 | 2009-03-31 00:35:56 +0000 | [diff] [blame] | 217 | public ArchiveEntry createArchiveEntry(File inputFile, String entryName) |
| 218 | throws IOException { |
Christian Grobmeier | a45e9cb | 2009-04-27 17:58:04 +0000 | [diff] [blame] | 219 | if(finished) { |
| 220 | throw new IOException("Stream has already been finished"); |
| 221 | } |
Sebastian Bazley | fec51a1 | 2009-03-31 00:35:56 +0000 | [diff] [blame] | 222 | return new ArArchiveEntry(inputFile, entryName); |
| 223 | } |
| 224 | |
Stefan Bodewig | 46628ef | 2011-08-06 16:30:40 +0000 | [diff] [blame] | 225 | @Override |
Christian Grobmeier | 6dfdfb5 | 2009-04-22 05:19:58 +0000 | [diff] [blame] | 226 | public void finish() throws IOException { |
Christian Grobmeier | d170f34 | 2009-04-22 06:05:23 +0000 | [diff] [blame] | 227 | if(haveUnclosedEntry) { |
Sebastian Bazley | 13b90ae | 2009-04-27 20:57:10 +0000 | [diff] [blame] | 228 | throw new IOException("This archive contains unclosed entries."); |
Christian Grobmeier | 545bfa8 | 2009-04-27 17:43:58 +0000 | [diff] [blame] | 229 | } else if(finished) { |
| 230 | throw new IOException("This archive has already been finished"); |
Christian Grobmeier | d170f34 | 2009-04-22 06:05:23 +0000 | [diff] [blame] | 231 | } |
Christian Grobmeier | 545bfa8 | 2009-04-27 17:43:58 +0000 | [diff] [blame] | 232 | finished = true; |
Christian Grobmeier | 6dfdfb5 | 2009-04-22 05:19:58 +0000 | [diff] [blame] | 233 | } |
Torsten Curdt | ca16539 | 2008-07-10 10:17:44 +0000 | [diff] [blame] | 234 | } |