@@ -53,10 +53,10 @@
*/ */
/* /*
* This package is based on the work done by Timothy Gerard Endres
* This package is based on the work done by Timothy Gerard Endres
* (time@ice.com) to whom the Ant project is very grateful for his great code. * (time@ice.com) to whom the Ant project is very grateful for his great code.
*/ */
package org.apache.tools.tar; package org.apache.tools.tar;
import java.io.InputStream; import java.io.InputStream;
@@ -73,15 +73,15 @@ import java.io.IOException;
* <p> * <p>
* You should never have a need to access this class directly. * You should never have a need to access this class directly.
* TarBuffers are created by Tar IO Streams. * TarBuffers are created by Tar IO Streams.
*
*
* @author Timothy Gerard Endres <a href="mailto:time@ice.com">time@ice.com</a> * @author Timothy Gerard Endres <a href="mailto:time@ice.com">time@ice.com</a>
*/ */
public class TarBuffer { public class TarBuffer {
public static final int DEFAULT_RCDSIZE = (512); public static final int DEFAULT_RCDSIZE = (512);
public static final int DEFAULT_BLKSIZE = (DEFAULT_RCDSIZE * 20); public static final int DEFAULT_BLKSIZE = (DEFAULT_RCDSIZE * 20);
private InputStream inStream; private InputStream inStream;
private OutputStream outStream; private OutputStream outStream;
private byte[] blockBuffer; private byte[] blockBuffer;
@@ -138,101 +138,101 @@ public class TarBuffer {
} else { } else {
this.currBlkIdx = 0; this.currBlkIdx = 0;
this.currRecIdx = 0; this.currRecIdx = 0;
}
}
}
}
/** /**
* Get the TAR Buffer's block size. Blocks consist of multiple records. * Get the TAR Buffer's block size. Blocks consist of multiple records.
*/ */
public int getBlockSize() { public int getBlockSize() {
return this.blockSize; return this.blockSize;
}
}
/** /**
* Get the TAR Buffer's record size. * Get the TAR Buffer's record size.
*/ */
public int getRecordSize() { public int getRecordSize() {
return this.recordSize; return this.recordSize;
}
}
/** /**
* Set the debugging flag for the buffer. * Set the debugging flag for the buffer.
*
*
* @param debug If true, print debugging output. * @param debug If true, print debugging output.
*/ */
public void setDebug(boolean debug) { public void setDebug(boolean debug) {
this.debug = debug; this.debug = debug;
}
}
/** /**
* Determine if an archive record indicate End of Archive. End of * Determine if an archive record indicate End of Archive. End of
* archive is indicated by a record that consists entirely of null bytes. * archive is indicated by a record that consists entirely of null bytes.
*
*
* @param record The record data to check. * @param record The record data to check.
*/ */
public boolean isEOFRecord(byte[] record) { public boolean isEOFRecord(byte[] record) {
for (int i = 0, sz = this.getRecordSize(); i < sz; ++i) { for (int i = 0, sz = this.getRecordSize(); i < sz; ++i) {
if (record[i] != 0) { if (record[i] != 0) {
return false; return false;
}
}
} }
return true; return true;
}
}
/** /**
* Skip over a record on the input stream. * Skip over a record on the input stream.
*/ */
public void skipRecord() throws IOException { public void skipRecord() throws IOException {
if (this.debug) { if (this.debug) {
System.err.println("SkipRecord: recIdx = " + this.currRecIdx
System.err.println("SkipRecord: recIdx = " + this.currRecIdx
+ " blkIdx = " + this.currBlkIdx); + " blkIdx = " + this.currBlkIdx);
}
}
if (this.inStream == null) { if (this.inStream == null) {
throw new IOException("reading (via skip) from an output buffer"); throw new IOException("reading (via skip) from an output buffer");
}
}
if (this.currRecIdx >= this.recsPerBlock) { if (this.currRecIdx >= this.recsPerBlock) {
if (!this.readBlock()) { if (!this.readBlock()) {
return; // UNDONE return; // UNDONE
}
}
}
}
this.currRecIdx++; this.currRecIdx++;
}
}
/** /**
* Read a record from the input stream and return the data. * Read a record from the input stream and return the data.
*
*
* @return The record data. * @return The record data.
*/ */
public byte[] readRecord() throws IOException { public byte[] readRecord() throws IOException {
if (this.debug) { if (this.debug) {
System.err.println("ReadRecord: recIdx = " + this.currRecIdx
System.err.println("ReadRecord: recIdx = " + this.currRecIdx
+ " blkIdx = " + this.currBlkIdx); + " blkIdx = " + this.currBlkIdx);
}
}
if (this.inStream == null) { if (this.inStream == null) {
throw new IOException("reading from an output buffer"); throw new IOException("reading from an output buffer");
}
}
if (this.currRecIdx >= this.recsPerBlock) { if (this.currRecIdx >= this.recsPerBlock) {
if (!this.readBlock()) { if (!this.readBlock()) {
return null; return null;
}
}
}
}
byte[] result = new byte[this.recordSize]; byte[] result = new byte[this.recordSize];
System.arraycopy(this.blockBuffer,
(this.currRecIdx * this.recordSize), result, 0,
System.arraycopy(this.blockBuffer,
(this.currRecIdx * this.recordSize), result, 0,
this.recordSize); this.recordSize);
this.currRecIdx++; this.currRecIdx++;
return result; return result;
}
}
/** /**
* @return false if End-Of-File, else true * @return false if End-Of-File, else true
@@ -240,11 +240,11 @@ public class TarBuffer {
private boolean readBlock() throws IOException { private boolean readBlock() throws IOException {
if (this.debug) { if (this.debug) {
System.err.println("ReadBlock: blkIdx = " + this.currBlkIdx); System.err.println("ReadBlock: blkIdx = " + this.currBlkIdx);
}
}
if (this.inStream == null) { if (this.inStream == null) {
throw new IOException("reading from an output buffer"); throw new IOException("reading from an output buffer");
}
}
this.currRecIdx = 0; this.currRecIdx = 0;
@@ -252,130 +252,130 @@ public class TarBuffer {
int bytesNeeded = this.blockSize; int bytesNeeded = this.blockSize;
while (bytesNeeded > 0) { while (bytesNeeded > 0) {
long numBytes = this.inStream.read(this.blockBuffer, offset,
long numBytes = this.inStream.read(this.blockBuffer, offset,
bytesNeeded); bytesNeeded);
//
//
// NOTE // NOTE
// We have fit EOF, and the block is not full! // We have fit EOF, and the block is not full!
//
//
// This is a broken archive. It does not follow the standard // This is a broken archive. It does not follow the standard
// blocking algorithm. However, because we are generous, and // blocking algorithm. However, because we are generous, and
// it requires little effort, we will simply ignore the error // it requires little effort, we will simply ignore the error
// and continue as if the entire block were read. This does // and continue as if the entire block were read. This does
// not appear to break anything upstream. We used to return // not appear to break anything upstream. We used to return
// false in this case. // false in this case.
//
//
// Thanks to 'Yohann.Roussel@alcatel.fr' for this fix. // Thanks to 'Yohann.Roussel@alcatel.fr' for this fix.
//
//
if (numBytes == -1) { if (numBytes == -1) {
break; break;
}
}
offset += numBytes; offset += numBytes;
bytesNeeded -= numBytes; bytesNeeded -= numBytes;
if (numBytes != this.blockSize) { if (numBytes != this.blockSize) {
if (this.debug) { if (this.debug) {
System.err.println("ReadBlock: INCOMPLETE READ "
+ numBytes + " of " + this.blockSize
System.err.println("ReadBlock: INCOMPLETE READ "
+ numBytes + " of " + this.blockSize
+ " bytes read."); + " bytes read.");
}
}
}
}
}
}
this.currBlkIdx++; this.currBlkIdx++;
return true; return true;
}
}
/** /**
* Get the current block number, zero based. * Get the current block number, zero based.
*
*
* @return The current zero based block number. * @return The current zero based block number.
*/ */
public int getCurrentBlockNum() { public int getCurrentBlockNum() {
return this.currBlkIdx; return this.currBlkIdx;
}
}
/** /**
* Get the current record number, within the current block, zero based. * Get the current record number, within the current block, zero based.
* Thus, current offset = (currentBlockNum * recsPerBlk) + currentRecNum. * Thus, current offset = (currentBlockNum * recsPerBlk) + currentRecNum.
*
*
* @return The current zero based record number. * @return The current zero based record number.
*/ */
public int getCurrentRecordNum() { public int getCurrentRecordNum() {
return this.currRecIdx - 1; return this.currRecIdx - 1;
}
}
/** /**
* Write an archive record to the archive. * Write an archive record to the archive.
*
*
* @param record The record data to write to the archive. * @param record The record data to write to the archive.
*/ */
public void writeRecord(byte[] record) throws IOException { public void writeRecord(byte[] record) throws IOException {
if (this.debug) { if (this.debug) {
System.err.println("WriteRecord: recIdx = " + this.currRecIdx
System.err.println("WriteRecord: recIdx = " + this.currRecIdx
+ " blkIdx = " + this.currBlkIdx); + " blkIdx = " + this.currBlkIdx);
}
}
if (this.outStream == null) { if (this.outStream == null) {
throw new IOException("writing to an input buffer"); throw new IOException("writing to an input buffer");
}
}
if (record.length != this.recordSize) { if (record.length != this.recordSize) {
throw new IOException("record to write has length '"
+ record.length
+ "' which is not the record size of '"
throw new IOException("record to write has length '"
+ record.length
+ "' which is not the record size of '"
+ this.recordSize + "'"); + this.recordSize + "'");
}
}
if (this.currRecIdx >= this.recsPerBlock) { if (this.currRecIdx >= this.recsPerBlock) {
this.writeBlock(); this.writeBlock();
}
}
System.arraycopy(record, 0, this.blockBuffer,
(this.currRecIdx * this.recordSize),
System.arraycopy(record, 0, this.blockBuffer,
(this.currRecIdx * this.recordSize),
this.recordSize); this.recordSize);
this.currRecIdx++; this.currRecIdx++;
}
}
/** /**
* Write an archive record to the archive, where the record may be * Write an archive record to the archive, where the record may be
* inside of a larger array buffer. The buffer must be "offset plus * inside of a larger array buffer. The buffer must be "offset plus
* record size" long. * record size" long.
*
*
* @param buf The buffer containing the record data to write. * @param buf The buffer containing the record data to write.
* @param offset The offset of the record data within buf. * @param offset The offset of the record data within buf.
*/ */
public void writeRecord(byte[] buf, int offset) throws IOException { public void writeRecord(byte[] buf, int offset) throws IOException {
if (this.debug) { if (this.debug) {
System.err.println("WriteRecord: recIdx = " + this.currRecIdx
System.err.println("WriteRecord: recIdx = " + this.currRecIdx
+ " blkIdx = " + this.currBlkIdx); + " blkIdx = " + this.currBlkIdx);
}
}
if (this.outStream == null) { if (this.outStream == null) {
throw new IOException("writing to an input buffer"); throw new IOException("writing to an input buffer");
}
}
if ((offset + this.recordSize) > buf.length) { if ((offset + this.recordSize) > buf.length) {
throw new IOException("record has length '" + buf.length
+ "' with offset '" + offset
+ "' which is less than the record size of '"
throw new IOException("record has length '" + buf.length
+ "' with offset '" + offset
+ "' which is less than the record size of '"
+ this.recordSize + "'"); + this.recordSize + "'");
}
}
if (this.currRecIdx >= this.recsPerBlock) { if (this.currRecIdx >= this.recsPerBlock) {
this.writeBlock(); this.writeBlock();
}
}
System.arraycopy(buf, offset, this.blockBuffer,
(this.currRecIdx * this.recordSize),
System.arraycopy(buf, offset, this.blockBuffer,
(this.currRecIdx * this.recordSize),
this.recordSize); this.recordSize);
this.currRecIdx++; this.currRecIdx++;
}
}
/** /**
* Write a TarBuffer block to the archive. * Write a TarBuffer block to the archive.
@@ -383,18 +383,18 @@ public class TarBuffer {
private void writeBlock() throws IOException { private void writeBlock() throws IOException {
if (this.debug) { if (this.debug) {
System.err.println("WriteBlock: blkIdx = " + this.currBlkIdx); System.err.println("WriteBlock: blkIdx = " + this.currBlkIdx);
}
}
if (this.outStream == null) { if (this.outStream == null) {
throw new IOException("writing to an input buffer"); throw new IOException("writing to an input buffer");
}
}
this.outStream.write(this.blockBuffer, 0, this.blockSize); this.outStream.write(this.blockBuffer, 0, this.blockSize);
this.outStream.flush(); this.outStream.flush();
this.currRecIdx = 0; this.currRecIdx = 0;
this.currBlkIdx++; this.currBlkIdx++;
}
}
/** /**
* Flush the current data block if it has any data in it. * Flush the current data block if it has any data in it.
@@ -402,16 +402,16 @@ public class TarBuffer {
private void flushBlock() throws IOException { private void flushBlock() throws IOException {
if (this.debug) { if (this.debug) {
System.err.println("TarBuffer.flushBlock() called."); System.err.println("TarBuffer.flushBlock() called.");
}
}
if (this.outStream == null) { if (this.outStream == null) {
throw new IOException("writing to an input buffer"); throw new IOException("writing to an input buffer");
}
}
if (this.currRecIdx > 0) { if (this.currRecIdx > 0) {
this.writeBlock(); this.writeBlock();
}
}
}
}
/** /**
* Close the TarBuffer. If this is an output buffer, also flush the * Close the TarBuffer. If this is an output buffer, also flush the
@@ -420,23 +420,23 @@ public class TarBuffer {
public void close() throws IOException { public void close() throws IOException {
if (this.debug) { if (this.debug) {
System.err.println("TarBuffer.closeBuffer()."); System.err.println("TarBuffer.closeBuffer().");
}
}
if (this.outStream != null) { if (this.outStream != null) {
this.flushBlock(); this.flushBlock();
if (this.outStream != System.out
if (this.outStream != System.out
&& this.outStream != System.err) { && this.outStream != System.err) {
this.outStream.close(); this.outStream.close();
this.outStream = null; this.outStream = null;
}
}
} else if (this.inStream != null) { } else if (this.inStream != null) {
if (this.inStream != System.in) { if (this.inStream != System.in) {
this.inStream.close(); this.inStream.close();
this.inStream = null; this.inStream = null;
}
}
}
}
}
}
} }
Conor MacNeill