com.orangesignal.jlha.LhaImmediateOutputStream Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of orangesignal-csv Show documentation
Show all versions of orangesignal-csv Show documentation
OrangeSignal CSV is a very flexible csv (comma-separated values) read and write library for Java.
/**
* Copyright (C) 2002 Michel Ishizuka All rights reserved.
*
* 以下の条件に同意するならばソースとバイナリ形式の再配布と使用を
* 変更の有無にかかわらず許可する。
*
* １．ソースコードの再配布において著作権表示と この条件のリスト
* および下記の声明文を保持しなくてはならない。
*
* ２．バイナリ形式の再配布において著作権表示と この条件のリスト
* および下記の声明文を使用説明書もしくは その他の配布物内に
* 含む資料に記述しなければならない。
*
* このソフトウェアは石塚美珠瑠によって無保証で提供され、特定の目
* 的を達成できるという保証、商品価値が有るという保証にとどまらず、
* いかなる明示的および暗示的な保証もしない。
* 石塚美珠瑠は このソフトウェアの使用による直接的、間接的、偶発
* 的、特殊な、典型的な、あるいは必然的な損害(使用によるデータの
* 損失、業務の中断や見込まれていた利益の遺失、代替製品もしくは
* サービスの導入費等が考えられるが、決してそれだけに限定されない
* 損害)に対して、いかなる事態の原因となったとしても、契約上の責
* 任や無過失責任を含む いかなる責任があろうとも、たとえそれが不
* 正行為のためであったとしても、またはそのような損害の可能性が報
* 告されていたとしても一切の責任を負わないものとする。
*/
package com.orangesignal.jlha;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.OutputStream;
import java.io.RandomAccessFile;
import java.util.Properties;
/**
* 接続されたRandomAccessFileに 圧縮データを出力するためのユーティリティクラス。
* java.util.zip.ZipOutputStream と似たインターフェイスを持つように作った。
* 圧縮失敗時( 圧縮後サイズが圧縮前サイズを上回った場合 )の処理を 手動で行わなければならない。 以下に そのようなコードを示す。
*
*
* LhaCompressFiles( String arcfile, File[] files ){
* LhaImmediateOutputStream lio = new LhaImmediateOutputStream( arcfile );
*
* for( int i = 0 ; i < files.length ; i++ ){
* RandomAccessFile raf = new RandomAccessFile( files[i] );
* LhaHeader header = new LhaHeader( files[i].getName() );
* header.setLastModified( new Date( files.lastModified() ) );
* header.setOriginalSize( files.length() );
* byte[] buffer = new byte[8192];
* int length;
*
* while( 0 <= ( length = raf.read( buffer ) ) ){
* lio.write( buffer, 0, length );
* }
*
* if( !lio.closeEntry() ){
* header.setCompressMethod( CompressMethod.LH0 );
* lio.putNextEntry( lhaheader );
* raf.seek( 0 );
* while( 0 <= ( length = raf.read( buffer ) ) ){
* lio.write( buffer, 0, length );
* }
* lio.closeEntry();
* }
*
* lio.close();
* }
*
*
* 進捗報告を実装する場合、このような処理をクラス内に隠蔽すると進捗報告は何秒間か 時によっては何十分も応答しなくなる。(例えばギガバイト級のデータを扱った場合) LhaRetainedOutputStream で発生する、このような事態を避けるために設計されている。
* また、JDK 1.1 以前では RandomAccessFile が setLength を持たないため、 書庫データの後ろに他のデータがある場合でもファイルサイズを切り詰めることが出来ない。
* この問題点は常にサイズ0の新しいファイルを開く事によって回避する事ができる。
*
*
* -- revision history --
* $Log: LhaImmediateOutputStream.java,v $
* Revision 1.2 2002/12/11 02:25:06 dangan
* [bug fix]
* jdk1.2 でコンパイルできなかった箇所を修正。
*
* Revision 1.1 2002/12/08 00:00:00 dangan
* [maintenance]
* LhaConstants から CompressMethod へのクラス名の変更に合わせて修正。
*
* Revision 1.0 2002/08/05 00:00:00 dangan
* add to version control
* [change]
* コンストラクタから 引数に String encode を取るものを廃止、
* Properties を引数に取るものを追加。
* [maintenance]
* ソース整備
* タブ廃止
* ライセンス文の修正
*
*
*
* @author $Author: dangan $
* @version $Revision: 1.2 $
*/
public class LhaImmediateOutputStream extends OutputStream {
/**
* 書庫ファイル
*/
private RandomAccessFile archive;
/**
* 圧縮用出力ストリーム
*/
private OutputStream out;
/**
* 現在圧縮中のヘッダ
*/
private LhaHeader header;
/**
* ヘッダの出力に使用したエンコーディング
*/
private String encoding;
/**
* ヘッダ位置
*/
private long headerpos;
/**
* CRC値算出用
*/
private CRC16 crc;
/**
* 各圧縮形式に対応した符号器の生成式等が含まれるプロパティ
*/
private Properties property;
// ------------------------------------------------------------------
// Constructor
/**
* filename のファイルに 圧縮データを出力するOutputStreamを構築する。
* 各圧縮形式に対応した符号器の生成式等を持つプロパティには LhaProperty.getProperties() で得られたプロパティが使用される。
*
* @param filename 圧縮データを書きこむファイルの名前
* @exception FileNotFoundException filename で与えられたファイルが見つからない場合。
* @exception SecurityException セキュリティマネージャがファイルへのアクセスを許さない場合。
* @see LhaProperty#getProperties()
*/
public LhaImmediateOutputStream(final String filename) throws FileNotFoundException {
if (filename != null) {
final RandomAccessFile file = new RandomAccessFile(filename, "rw"); // throws FileNotFoundException, SecurityException
final Properties property = LhaProperty.getProperties();
constructerHelper(file, property);
} else {
throw new NullPointerException("filename");
}
}
/**
* filename のファイルに 圧縮データを出力するOutputStreamを構築する。
*
* @param filename 圧縮データを書きこむファイルの名前
* @param property 各圧縮形式に対応した符号器の生成式等が含まれるプロパティ
* @exception FileNotFoundException filename で与えられたファイルが見つからない場合。
* @exception SecurityException セキュリティマネージャがファイルへのアクセスを許さない場合。
* @see LhaProperty
*/
public LhaImmediateOutputStream(final String filename, final Properties property) throws FileNotFoundException {
if (filename != null) {
final RandomAccessFile file = new RandomAccessFile(filename, "rw"); // throws FileNotFoundException, SecurityException
constructerHelper(file, property);
} else {
throw new NullPointerException("filename");
}
}
/**
* filename のファイルに 圧縮データを出力するOutputStreamを構築する。
* 各圧縮形式に対応した符号器の生成式等を持つプロパティには LhaProperty.getProperties() で得られたプロパティが使用される。
*
* @param filename 圧縮データを書きこむファイルの名前
* @exception FileNotFoundException filename で与えられたファイルが見つからない場合。
* @exception SecurityException セキュリティマネージャがファイルへのアクセスを許さない場合。
* @exception IOException JDK1.2 でコンパイルするためだけに存在する。
* @see LhaProperty#getProperties()
*/
public LhaImmediateOutputStream(final File filename) throws IOException {
if (filename != null) {
final RandomAccessFile file = new RandomAccessFile(filename, "rw"); // throws FileNotFoundException, SecurityException, IOException(jdk1.2)
final Properties property = LhaProperty.getProperties();
constructerHelper(file, property);
} else {
throw new NullPointerException("filename");
}
}
/**
* filename のファイルに 圧縮データを出力するOutputStreamを構築する。
*
* @param filename 圧縮データを書きこむファイルの名前
* @param property 各圧縮形式に対応した符号器の生成式等が含まれるプロパティ
* @exception FileNotFoundException filename で与えられたファイルが見つからない場合。
* @exception SecurityException セキュリティマネージャがファイルへのアクセスを許さない場合。
* @exception IOException JDK1.2 でコンパイルするためだけに存在する。
* @see LhaProperty
*/
public LhaImmediateOutputStream(final File filename, final Properties property) throws IOException {
if (filename != null) {
final RandomAccessFile file = new RandomAccessFile(filename, "rw"); // throws FileNotFoundException, SecurityException, IOException(jdk1.2)
constructerHelper(file, property);
} else {
throw new NullPointerException("filename");
}
}
/**
* fileに 圧縮データを出力するOutputStreamを構築する。
* 各圧縮形式に対応した符号器の生成式等を持つプロパティには LhaProperty.getProperties() で得られたプロパティが使用される。
*
* @param file RandomAccessFile のインスタンス。
*
* - 既に close() されていない事。
*
- コンストラクタの mode には "rw" オプションを使用して、 読みこみと書きこみが出来るように生成されたインスタンスであること。
*
* の条件を満たすもの。
*
* @see LhaProperty#getProperties()
*/
public LhaImmediateOutputStream(final RandomAccessFile file) {
if (file != null) {
final Properties property = LhaProperty.getProperties();
constructerHelper(file, property);
} else {
throw new NullPointerException("out");
}
}
/**
* fileに 圧縮データを出力するOutputStreamを構築する。
* 各圧縮形式に対応した符号器の生成式等を持つプロパティには LhaProperty.getProperties() で得られたプロパティが使用される。
*
* @param file RandomAccessFile のインスタンス。
*
* - 既に close() されていない事。
*
- コンストラクタの mode には "rw" オプションを使用して、 読みこみと書きこみが出来るように生成されたインスタンスであること。
*
* の条件を満たすもの。
* @param property 各圧縮形式に対応した符号器の生成式等が含まれるプロパティ
*
* @see LhaProperty
*/
public LhaImmediateOutputStream(final RandomAccessFile file, final Properties property) {
if (file != null && property != null) {
constructerHelper(file, property); // throws UnsupportedEncodingException
} else if (file == null) {
throw new NullPointerException("null");
} else {
throw new NullPointerException("property");
}
}
/**
* コンストラクタの初期化処理を担当するメソッド。
*
* @param file RandomAccessFile のインスタンス。
*
* - 既に close() されていない事。
*
- コンストラクタの mode には "rw" オプションを使用して、 読みこみと書きこみが出来るように生成されたインスタンスであること。
*
* の条件を満たすもの。
* @param property 各圧縮形式に対応した符号器の生成式等が含まれるプロパティ
*/
private void constructerHelper(final RandomAccessFile file, final Properties property) {
archive = file;
out = null;
header = null;
headerpos = -1;
crc = new CRC16();
this.property = property;
}
// ------------------------------------------------------------------
// method of java.io.OutputStream
/**
* 現在のエントリに1バイトのデータを書きこむ。
*
* @param data 書きこむデータ
* @exception IOException 入出力エラーが発生した場合。
*/
@Override
public void write(final int data) throws IOException {
if (out != null) {
if (header != null) {
crc.update(data);
}
out.write(data);
} else {
throw new IOException("no entry");
}
}
/**
* 現在のエントリに bufferの内容を全て書き出す。
*
* @param buffer 書き出すデータの入ったバイト配列
* @exception IOException 入出力エラーが発生した場合。
*/
@Override
public void write(final byte[] buffer) throws IOException {
this.write(buffer, 0, buffer.length);
}
/**
* 現在のエントリに bufferの indexから lengthバイトのデータを書き出す。
*
* @param buffer 書き出すデータの入ったバイト配列
* @param index buffer内の書き出すべきデータの開始位置
* @param length データのバイト数
* @exception IOException 入出力エラーが発生した場合。
*/
@Override
public void write(final byte[] buffer, final int index, final int length) throws IOException {
if (out != null) {
if (header != null) {
crc.update(buffer, index, length);
}
out.write(buffer, index, length);
} else {
throw new IOException("no entry");
}
}
/**
* 現在書き込み中のエントリのデータを強制的に出力先に書き出す。 これは PostLzssEncoder, LzssOutputStream の規約どおり flush() しなかった場合とは別のデータを出力する。 (大抵の場合は 単に圧縮率が低下するだけである。)
*
* @exception IOException 入出力エラーが発生した場合
* @see PostLzssEncoder#flush()
* @see LzssOutputStream#flush()
*/
@Override
public void flush() throws IOException {
if (out != null) {
out.flush(); // throws IOException
} else {
throw new IOException("no entry");
}
}
/**
* 出力先に全てのデータを出力し、ストリームを閉じる。
* また、使用していた全てのリソースを解放する。
*
* @exception IOException 入出力エラーが発生した場合
*/
@Override
public void close() throws IOException {
if (out != null) {
closeEntry(); // throws IOException
}
// ターミネータを出力
archive.write(0); // throws IOException
try {
archive.setLength(archive.getFilePointer()); // After Java1.2 throws IOException
} catch (final NoSuchMethodError error) {
}
archive.close(); // throws IOException
archive = null;
crc = null;
property = null;
encoding = null;
}
// ------------------------------------------------------------------
// original method ( on the model of java.util.zip.ZipOutputStream )
/**
* 新しいエントリを書き込むようにストリームを設定する。
* このメソッドは 既に圧縮済みのエントリの場合は putNextEntryAlreadyCompressed(), 未だに圧縮されていない場合は putNextEntryNotYetCompressed() を呼び出す。
* 圧縮されているかの判定は、
*
* - header.getCompressedSize()
* - header.getCRC()
*
* のどれか一つでも LhaHeader.UNKNOWN であれば未だに圧縮されていないとする。
* header には正確な OriginalSize が指定されている必要がある。
*
* @param header 書きこむエントリについての情報を持つ LhaHeaderのインスタンス。
*
* @exception IOException 入出力エラーが発生した場合
* @exception IllegalArgumentException header.getOriginalSize() が LhaHeader.UNKNOWN を返す場合
*/
public void putNextEntry(final LhaHeader header) throws IOException {
if (header.getCompressedSize() == LhaHeader.UNKNOWN
|| header.getCrc() == LhaHeader.UNKNOWN) {
putNextEntryNotYetCompressed(header); // throws IOException
} else {
putNextEntryAlreadyCompressed(header); // throws IOException
}
}
/**
* 既に圧縮済みのエントリを書きこむようにストリームを設定する。
* 圧縮済みデータが正しい事は、呼び出し側が保証する事。
*
* @param header 書きこむエントリについての情報を持つ LhaHeaderのインスタンス。
*
* @exception IOException 入出力エラーが発生した場合
* @exception IllegalArgumentException
* - header.getOriginalSize() が LhaHeader.UNKNOWN を返す場合
*
- header.getComressedSize() が LhaHeader.UNKNOWN を返す場合
*
- header.getCRC() が LhaHeader.UNKNOWN を返す場合
*
* の何れか。
* @exception IllegalStateException 以前のエントリが未だに closeEntry() されていない場合
*/
public void putNextEntryAlreadyCompressed(final LhaHeader header) throws IOException {
if (out == null) {
if (header.getOriginalSize() != LhaHeader.UNKNOWN
&& header.getCompressedSize() != LhaHeader.UNKNOWN
&& header.getCrc() != LhaHeader.UNKNOWN) {
headerpos = archive.getFilePointer();
encoding = property.getProperty("lha.encoding");
if (encoding == null) {
encoding = LhaProperty.getProperty("lha.encoding");
}
archive.write(header.getBytes(encoding)); // throws IOException
out = new RandomAccessFileOutputStream(archive,header.getCompressedSize());
} else if (header.getOriginalSize() == LhaHeader.UNKNOWN) {
throw new IllegalArgumentException("OriginalSize must not \"LhaHeader.UNKNOWN\".");
} else if (header.getCompressedSize() == LhaHeader.UNKNOWN) {
throw new IllegalArgumentException("CompressedSize must not \"LhaHeader.UNKNOWN\".");
} else {
throw new IllegalArgumentException("CRC must not \"LhaHeader.UNKNOWN\".");
}
} else {
throw new IllegalStateException("entry is not closed.");
}
}
/**
* 未だに圧縮されていないエントリを書きこむようにストリームを 設定する。header に CompressedSize,CRCが指定されていても無 視される。このメソッドに渡される header には LhaHeader.setOriginalSize() を用いて 正確なオリジナルサイズ が指定されている必要がある。
*
* @param header 書きこむエントリについての情報を持つ LhaHeaderのインスタンス。
* @exception IOException 入出力エラーが発生した場合
* @exception IllegalArgumentException header.getOriginalSize() が LhaHeader.UNKNOWN を返した場合
* @exception IllegalStateException 以前のエントリが未だに closeEntry() されていない場合
*/
public void putNextEntryNotYetCompressed(final LhaHeader header) throws IOException {
if (out == null) {
if (header.getOriginalSize() != LhaHeader.UNKNOWN) {
crc.reset();
headerpos = archive.getFilePointer();
this.header = (LhaHeader) header.clone();
this.header.setCompressedSize(0);
this.header.setCrc(0);
encoding = property.getProperty("lha.encoding");
if (encoding == null) {
encoding = LhaProperty.getProperty("lha.encoding");
}
archive.write(this.header.getBytes(encoding));
out = new RandomAccessFileOutputStream(archive,
header.getOriginalSize());
out = CompressMethod.connectEncoder(out,
header.getCompressMethod(), property);
} else {
throw new IllegalArgumentException("OriginalSize must not \"LhaHeader.UNKNOWN\".");
}
} else {
throw new IllegalStateException("entry is not closed.");
}
}
/**
* 現在出力中のエントリを閉じ、次のエントリが出力可能な状態にする。
* putNextEntryNotYetCompressed() で開いたエントリを閉じる場合 このメソッドは圧縮に失敗した(圧縮後サイズが圧縮前サイズを上回った)場合、 エントリ全体を書き込み先 の RandomAccessFile から削除する。
* この削除処理は単に ファイルポインタを エントリ開始位置まで巻き戻すだけなので RandomAccessFile に setLength() が無い jdk1.1 以前では エントリを無圧縮(もしくは他の圧縮法)で再出力しない場合、 書庫データの終端以降に圧縮に失敗した不完全なデータが残ったままになる。
*
* @return エントリが出力された場合は true、 圧縮前よりも圧縮後の方がサイズが大きくなったため、 エントリが削除された場合は false。 また、現在処理中のエントリが無かった場合も true を返す。
*
* @exception IOException 入出力エラーが発生した場合
*/
public boolean closeEntry() throws IOException {
if (out != null) {
out.close();
if (header != null) {
final long pos = archive.getFilePointer();
final long size = pos - headerpos
- header.getBytes(encoding).length;
header.setCompressedSize(size);
if (header.getCrc() != LhaHeader.NO_CRC) {
header.setCrc((int) crc.getValue());
}
archive.seek(headerpos);
if (header.getCompressMethod().equals(CompressMethod.LH0)
|| header.getCompressMethod()
.equals(CompressMethod.LHD)
|| header.getCompressMethod()
.equals(CompressMethod.LZ4)
|| header.getCompressedSize() < header
.getOriginalSize()) {
archive.write(header.getBytes(encoding));
archive.seek(pos);
header = null;
out = null;
return true;
}
header = null;
out = null;
return false;
}
out = null;
return true;
}
return true;
}
// ------------------------------------------------------------------
// inner classes
// ------------------------------------------------------------------
// private static class RandomAccessFileOutputStream
// ------------------------------------------------------------------
/**
* RandomAccessFileをOutputStreamのインタフェイスに合わせるためのラッパクラス
*/
private static class RandomAccessFileOutputStream extends OutputStream {
/**
* 出力先RandomAccessFile
*/
private RandomAccessFile archive;
/**
* 現在処理位置
*/
private long pos;
/**
* 格納限界
*/
private final long limit;
// ------------------------------------------------------------------
// Consutructor
/**
* RandomAccessFile をラップした OutputStream を構築する。
*
* @param archive 出力先のRandomAccessFile
* @param length 出力限界長
* @exception IOException 入出力エラーエラーが発生した場合
*/
public RandomAccessFileOutputStream(final RandomAccessFile archive, final long length) throws IOException {
this.archive = archive;
pos = this.archive.getFilePointer(); // throws IOException
limit = pos + length;
}
// ------------------------------------------------------------------
// method of java.io.OutputStream
/**
* 接続されたRandomAccessFileに1バイト書きこむ。
* コンストラクタに渡された限界を超えて書き込もうとした場合は 何も行わない。
*
* @param data 書きこむ1byteのデータ
* @exception IOException 入出力エラーが発生した場合
*/
@Override
public void write(final int data) throws IOException {
if (pos < limit) {
pos++;
archive.write(data); // throws IOException
}
}
/**
* 接続されたRandomAccessFileにbufferの内容を全て書きこむ。 コンストラクタに渡された限界を超えて書き込もうとした場合は 何も行わない。
*
* @param buffer 書きこむデータの入ったバイト配列
* @exception IOException 入出力エラーが発生した場合
*/
@Override
public void write(final byte[] buffer) throws IOException {
this.write(buffer, 0, buffer.length); // throws IOException
}
/**
* 接続されたRandomAccessFileにbufferの内容をindexから lengthバイト書きこむ。 コンストラクタに渡された限界を超えて書き込もうとした場合は 何も行わない。
*
* @param buffer 書きこむデータの入ったバイト配列
* @param index buffer内の書きこむデータの開始位置
* @param length 書きこむデータ量
* @exception IOException 入出力エラーが発生した場合
*/
@Override
public void write(final byte[] buffer, final int index, int length) throws IOException {
if (limit < pos + length) {
length = (int) Math.max(limit - pos, 0);
}
archive.write(buffer, index, length); // throws IOException
pos += length;
}
/**
* このストリームを閉じて 使用していたリソースを開放する。
*/
@Override
public void close() {
archive = null;
}
}
}