package org.apache.poi.hssf.record;
import java.util.ArrayList;
import java.util.List;
import org.apache.poi.ddf.DefaultEscherRecordFactory;
import org.apache.poi.ddf.EscherContainerRecord;
import org.apache.poi.ddf.EscherRecord;
import org.apache.poi.ddf.EscherRecordFactory;
import org.apache.poi.ddf.NullEscherSerializationListener;
import org.apache.poi.util.LittleEndian;
import org.apache.poi.hssf.util.LazilyConcatenatedByteArray;
public abstract class AbstractEscherHolderRecord extends Record implements Cloneable {
private static boolean DESERIALISE;
static {
try {
DESERIALISE = (System.getProperty("poi.deserialize.escher") != null);
} catch (SecurityException e) {
DESERIALISE = false;
}
}
private final List<EscherRecord> escherRecords;
private final LazilyConcatenatedByteArray rawDataContainer = new LazilyConcatenatedByteArray();
public AbstractEscherHolderRecord()
{
escherRecords = new ArrayList<>();
}
public AbstractEscherHolderRecord(RecordInputStream in)
{
escherRecords = new ArrayList<>();
if (! DESERIALISE ) {
rawDataContainer.concatenate(in.readRemainder());
} else {
byte[] data = in.readAllContinuedRemainder();
convertToEscherRecords( 0, data.length, data );
}
}
protected void convertRawBytesToEscherRecords() {
if (! DESERIALISE ) {
byte[] rawData = getRawData();
convertToEscherRecords(0, rawData.length, rawData);
}
}
private void convertToEscherRecords( int offset, int size, byte[] data )
{
escherRecords.clear();
EscherRecordFactory recordFactory = new DefaultEscherRecordFactory();
int pos = offset;
while ( pos < offset + size )
{
EscherRecord r = recordFactory.createRecord(data, pos);
int bytesRead = r.fillFields(data, pos, recordFactory );
escherRecords.add(r);
pos += bytesRead;
}
}
@Override
public String toString()
{
StringBuffer buffer = new StringBuffer();
final String nl = System.getProperty("line.separator");
buffer.append('[' + getRecordName() + ']' + nl);
if (escherRecords.size() == 0)
buffer.append("No Escher Records Decoded" + nl);
for (EscherRecord r : escherRecords) {
buffer.append(r);
}
buffer.append("[/" + getRecordName() + ']' + nl);
return buffer.toString();
}
protected abstract String getRecordName();
@Override
public int serialize(int offset, byte[] data)
{
LittleEndian.putShort( data, 0 + offset, getSid() );
LittleEndian.putShort( data, 2 + offset, (short) ( getRecordSize() - 4 ) );
byte[] rawData = getRawData();
if ( escherRecords.size() == 0 && rawData != null )
{
LittleEndian.putShort(data, 0 + offset, getSid());
LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
System.arraycopy( rawData, 0, data, 4 + offset, rawData.length);
return rawData.length + 4;
}
LittleEndian.putShort(data, 0 + offset, getSid());
LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));
int pos = offset + 4;
for (EscherRecord r : escherRecords) {
pos += r.serialize( pos, data, new NullEscherSerializationListener() );
}
return getRecordSize();
}
@Override
public int getRecordSize() {
byte[] rawData = getRawData();
if (escherRecords.size() == 0 && rawData != null) {
return rawData.length;
}
int size = 0;
for (EscherRecord r : escherRecords) {
size += r.getRecordSize();
}
return size;
}
@Override
public abstract short getSid();
@Override
public AbstractEscherHolderRecord clone() {
return (AbstractEscherHolderRecord)cloneViaReserialise();
}
public void addEscherRecord(int index, EscherRecord element)
{
escherRecords.add( index, element );
}
public boolean addEscherRecord(EscherRecord element)
{
return escherRecords.add( element );
}
public List<EscherRecord> getEscherRecords()
{
return escherRecords;
}
public void clearEscherRecords()
{
escherRecords.clear();
}
public EscherContainerRecord getEscherContainer() {
for (EscherRecord er : escherRecords) {
if(er instanceof EscherContainerRecord) {
return (EscherContainerRecord)er;
}
}
return null;
}
public EscherRecord findFirstWithId(short id) {
return findFirstWithId(id, getEscherRecords());
}
private EscherRecord findFirstWithId(short id, List<EscherRecord> records) {
for (EscherRecord r : records) {
if(r.getRecordId() == id) {
return r;
}
}
for (EscherRecord r : records) {
if(r.isContainerRecord()) {
EscherRecord found = findFirstWithId(id, r.getChildRecords());
if(found != null) {
return found;
}
}
}
return null;
}
public EscherRecord getEscherRecord(int index)
{
return escherRecords.get(index);
}
public void join( AbstractEscherHolderRecord record )
{
rawDataContainer.concatenate(record.getRawData());
}
public void processContinueRecord( byte[] record )
{
rawDataContainer.concatenate(record);
}
public byte[] getRawData()
{
return rawDataContainer.toArray();
}
public void setRawData( byte[] rawData )
{
rawDataContainer.clear();
rawDataContainer.concatenate(rawData);
}
public void decode()
{
if (null == escherRecords || 0 == escherRecords.size()){
byte[] rawData = getRawData();
convertToEscherRecords(0, rawData.length, rawData );
}
}
}