7 files changed, 587 insertions, 0 deletions
diff --git a/src/java/org/apache/fop/store/FileStore.java b/src/java/org/apache/fop/store/FileStore.java
new file mode 100644
index 000000000..131daf32b
--- /dev/null
+++ b/src/java/org/apache/fop/store/FileStore.java
@@ -0,0 +1,166 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.store;
+
+import java.io.File;
+import java.io.FileDescriptor;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.io.RandomAccessFile;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.apache.xmlgraphics.image.loader.ImageManager;
+
+/**
+ * A useful class which is able to easily store and retrieve large resources (such as images)
+ */
+public class FileStore {
+
+    /** logger */
+    protected static Log log = LogFactory.getLog(ImageManager.class);
+
+    /** Internal temporary storage buffer size */
+    private static final int BUFFER_SIZE = 4096;
+
+    /** Used for storage of data objects */
+    protected RandomAccessFile raFile;
+
+    /** The temporary cache file */
+    private File tempFile;
+
+    /** The file outputstream */
+    protected FileOutputStream fos;
+
+    /**
+     * Default constructor
+     *
+     * @param prefix file store prefix
+     */
+    public FileStore(String prefix) {
+        try {
+            this.tempFile = File.createTempFile(prefix, null);
+            this.raFile = new RandomAccessFile(tempFile, "rw");
+            FileDescriptor fd = raFile.getFD();
+            this.fos = new FileOutputStream(fd);
+        } catch (IOException e) {
+            // TODO
+            log.error(e.getMessage());
+        }
+    }
+
+    /**
+     * Clears the resource store.
+     *
+     * @throws IOException if an error occurs while clearing the store
+     */
+    public void clear() throws IOException {
+        if (tempFile != null) {
+            raFile.close();
+            raFile = null;
+            fos = null;
+            if (tempFile.exists() && !tempFile.delete()) {
+                throw new IOException("Could not delete temporary file: " + tempFile);
+            }
+            tempFile = null;
+        }
+    }
+
+    /** {@inheritDoc} */
+    public void finalize() throws Throwable {
+        try {
+            clear();
+        } finally {
+            super.finalize();
+        }
+    }
+
+    /**
+     * Returns the storer of a given object
+     *
+     * @param object an object to be stored
+     * @return a storer of the object
+     */
+    protected Storer getStorer(Object object) {
+        Storer storer;
+        if (object instanceof Writable) {
+            storer = new WritableStorer(this, (Writable)object);
+        } else if (object instanceof InputStream) {
+            storer = new InputStreamStorer(this, (InputStream)object);
+        } else {
+            throw new IllegalArgumentException("Unsupported object " + object);
+        }
+        return storer;
+    }
+
+    /**
+     * Stores an object in the cache
+     *
+     * @param object the object to store
+     * @return a new save information record
+     *
+     * @throws java.io.IOException an I/O exception of some sort has occurred.
+     */
+    public StoreRecord write(Object object) throws IOException {
+        return getStorer(object).store();
+    }
+
+    /**
+     * Reads all the data from a given store information record
+     * and returns it in a byte array.
+     * This is potentially a memory hungry operation so use with care.
+     *
+     * @param storeInfo a store information record
+     * @return the stored data in a byte array.
+     * @throws java.io.IOException an I/O exception of some sort has occurred.
+     */
+    public byte[] read(StoreRecord storeInfo) throws IOException {
+        raFile.seek(storeInfo.position);
+        byte[] buff = new byte[storeInfo.size];
+        raFile.read(buff);
+        return buff;
+    }
+
+    /**
+     * Writes out the resource in full using the store information to the given outputstream.
+     *
+     * @param storeInfo the save information
+     * @param os the outputstream to write to
+     *
+     * @throws java.io.IOException an I/O exception of some sort has occurred.
+     */
+    public void writeToStream(StoreRecord storeInfo, OutputStream os) throws IOException {
+        if (storeInfo == null) {
+            throw new IllegalArgumentException("save is null");
+        }
+        double chunkCount = storeInfo.size / BUFFER_SIZE;
+        byte[] buffer = new byte[BUFFER_SIZE];
+        raFile.seek(storeInfo.position);
+        for (int cnt = 0; cnt < chunkCount; cnt++) {
+            raFile.read(buffer, 0, BUFFER_SIZE);
+            os.write(buffer, 0, BUFFER_SIZE);
+        }
+        int lastChunkLength = storeInfo.size % BUFFER_SIZE;
+        raFile.read(buffer, 0, lastChunkLength);
+        os.write(buffer, 0, lastChunkLength);
+    }
+}
diff --git a/src/java/org/apache/fop/store/InputStreamStorer.java b/src/java/org/apache/fop/store/InputStreamStorer.java
new file mode 100644
index 000000000..5d72c932f
--- /dev/null
+++ b/src/java/org/apache/fop/store/InputStreamStorer.java
@@ -0,0 +1,50 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.store;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import org.apache.commons.io.IOUtils;
+
+/**
+ * Storer of InputStreams
+ */
+public final class InputStreamStorer extends Storer {
+
+    /** an inputstream */
+    private final InputStream in;
+
+    /**
+     * Constructor
+     *
+     * @param store our resource store
+     * @param in an inputstream
+     */
+    protected InputStreamStorer(FileStore store, InputStream in) {
+        super(store);
+        this.in = in;
+    }
+
+    /** {@inheritDoc} */
+    protected void doStore() throws IOException {
+        IOUtils.copy(in, store.fos);
+    }
+}
+\ No newline at end of file
diff --git a/src/java/org/apache/fop/store/StoreRecord.java b/src/java/org/apache/fop/store/StoreRecord.java
new file mode 100644
index 000000000..f4dd8ff49
--- /dev/null
+++ b/src/java/org/apache/fop/store/StoreRecord.java
@@ -0,0 +1,90 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.store;
+
+import java.io.IOException;
+import java.io.OutputStream;
+
+/**
+ * Store save information
+ */
+public class StoreRecord {
+
+    /** the resource store associated with this store information */
+    private final FileStore store;
+
+    /** data position */
+    protected long position;
+
+    /** data chunk size */
+    protected int size;
+
+    /**
+     * Main constructor
+     *
+     * @param store our resource store
+     */
+    public StoreRecord(FileStore store) {
+        this.store = store;
+    }
+
+    /**
+     * Returns the storage position
+     *
+     * @return the storage position
+     */
+    public long getPosition() {
+        return this.position;
+    }
+
+    /**
+     * Returns the storage size
+     *
+     * @return the storage size
+     */
+    public int getLength() {
+        return this.size;
+    }
+
+    /**
+     * Returns the resource store associated with this store record
+     *
+     * @return the resource store associated with this store record
+     */
+    public FileStore getStore() {
+        return this.store;
+    }
+
+    /**
+     * Convenience method used to writes the data referenced
+     * by this storage record to an outputstream
+     *
+     * @param os the outputstream to write to
+     * @throws java.io.IOException an I/O exception of some sort has occurred.
+     */
+    public void writeToStream(OutputStream os) throws IOException {
+        store.writeToStream(this, os);
+    }
+
+    /** {@inheritDoc} */
+    public String toString() {
+        return "pos=" + position + ", size=" + size;
+    }
+}
+\ No newline at end of file
diff --git a/src/java/org/apache/fop/store/Storer.java b/src/java/org/apache/fop/store/Storer.java
new file mode 100644
index 000000000..d8dbab191
--- /dev/null
+++ b/src/java/org/apache/fop/store/Storer.java
@@ -0,0 +1,87 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.store;
+
+import java.io.IOException;
+
+/**
+ * Base storer class
+ */
+public class Storer {
+
+    /** write session */
+    protected final WriteSession session;
+
+    /** file store */
+    protected final FileStore store;
+
+    /**
+     * Constructor
+     *
+     * @param store our resource store
+     */
+    public Storer(FileStore store) {
+        this.store = store;
+        this.session = new WriteSession(this);
+    }
+
+    /**
+     * Instantiates the store information record
+     *
+     * @return a new store information record
+     */
+    protected StoreRecord createRecord() {
+        return new StoreRecord(store);
+    }
+
+    /**
+     * Stores the object
+     *
+     * @return a store information record
+     * @throws IOException thrown if an I/O exception of some sort has occurred.
+     */
+    public StoreRecord store() throws IOException {
+        StoreRecord record = null;
+        session.begin();
+        try {
+            doStore();
+        } finally {
+            record = session.end();
+        }
+        return record;
+    }
+
+    /**
+     * Actually performs the store operation
+     *
+     * @throws IOException thrown if an I/O exception of some sort has occurred.
+     */
+    protected void doStore() throws IOException {
+    }
+
+    /**
+     * Returns the file store associated with this storer
+     *
+     * @return the file store associated with this storer
+     */
+    protected FileStore getStore() {
+        return store;
+    }
+}
diff --git a/src/java/org/apache/fop/store/Writable.java b/src/java/org/apache/fop/store/Writable.java
new file mode 100644
index 000000000..8f6052261
--- /dev/null
+++ b/src/java/org/apache/fop/store/Writable.java
@@ -0,0 +1,38 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.store;
+
+import java.io.IOException;
+import java.io.OutputStream;
+
+/**
+ * Implementing object is able to write to an OutputStream
+ */
+public interface Writable {
+
+    /**
+     * DataStream objects must implement the writeToStream()
+     * method to write its data to the given OutputStream
+     *
+     * @param outputStream The outputsteam stream
+     * @throws java.io.IOException an I/O exception of some sort has occurred.
+     */
+    void writeToStream(OutputStream outputStream) throws IOException;
+}
diff --git a/src/java/org/apache/fop/store/WritableStorer.java b/src/java/org/apache/fop/store/WritableStorer.java
new file mode 100644
index 000000000..bba11287e
--- /dev/null
+++ b/src/java/org/apache/fop/store/WritableStorer.java
@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.store;
+
+import java.io.IOException;
+
+/**
+ * Storer of objects that implement the Writable interface
+ */
+public class WritableStorer extends Storer {
+
+    /** a Writable object */
+    protected final Writable writable;
+
+    /**
+     * Constructor
+     *
+     * @param store our resource store
+     * @param writable an object implementing the Writable interface
+     */
+    public WritableStorer(FileStore store, Writable writable) {
+        super(store);
+        this.writable = writable;
+    }
+
+    /** {@inheritDoc} */
+    protected void doStore() throws IOException {
+        writable.writeToStream(store.fos);
+    }
+}
diff --git a/src/java/org/apache/fop/store/WriteSession.java b/src/java/org/apache/fop/store/WriteSession.java
new file mode 100644
index 000000000..034357355
--- /dev/null
+++ b/src/java/org/apache/fop/store/WriteSession.java
@@ -0,0 +1,109 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.store;
+
+import java.io.IOException;
+import java.io.OutputStream;
+
+/**
+ * A Write session
+ */
+public class WriteSession {
+    /** true if the session output was flushed */
+    protected boolean flushed = false;
+
+    /** the session storer */
+    private final Storer storer;
+
+    /** the storer's file store */
+    private final FileStore store;
+
+    /** the store information record */
+    protected StoreRecord record;
+
+    /**
+     * Constructor
+     *
+     * @param store our store
+     */
+    public WriteSession(FileStore store) {
+        this.storer = new Storer(store);
+        this.store = store;
+    }
+
+    /**
+     * Constructor
+     *
+     * @param storer our storer
+     */
+    public WriteSession(Storer storer) {
+        this.storer = storer;
+        this.store = storer.getStore();
+    }
+
+    /**
+     * Begins the session
+     *
+     * @throws IOException thrown if an I/O exception of some sort has occurred.
+     */
+    public void begin() throws IOException {
+        // always write to the end of the store
+        long length = store.raFile.length();
+        if (store.raFile.getFilePointer() < length) {
+            store.raFile.seek(length);
+        }
+
+        this.record = storer.createRecord();
+        record.position = store.raFile.getFilePointer();
+    }
+
+    /**
+     * Ends the session
+     *
+     * @return a new store information record
+     * @throws IOException thrown if an I/O exception of some sort has occurred.
+     */
+    public StoreRecord end() throws IOException {
+        if (!flushed) {
+            store.fos.flush();
+            flushed = true;
+        }
+        record.size = (int)(store.raFile.getFilePointer() - record.position);
+        return record;
+    }
+
+    /**
+     * Returns the outputstream of this store
+     *
+     * @return the outputstream of this store
+     */
+    public OutputStream getOutputStream() {
+        return store.fos;
+    }
+
+    /**
+     * Returns the store record
+     *
+     * @return the store record
+     */
+    public StoreRecord getRecord() {
+        return record;
+    }
+}
+\ No newline at end of file