| /* ==================================================================== |
| 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. |
| ==================================================================== */ |
| |
| package org.apache.poi.hssf.record; |
| |
| import java.io.UnsupportedEncodingException; |
| import java.util.Map; |
| import java.util.function.Supplier; |
| |
| import org.apache.poi.common.usermodel.GenericRecord; |
| import org.apache.poi.hpsf.Property; |
| import org.apache.poi.util.CodePageUtil; |
| import org.apache.poi.util.GenericRecordJsonWriter; |
| import org.apache.poi.util.GenericRecordUtil; |
| import org.apache.poi.util.IOUtils; |
| |
| |
| /** |
| * Biff2 - Biff 4 Label Record (0x0007 / 0x0207) - read only support for |
| * formula string results. |
| */ |
| public final class OldStringRecord implements GenericRecord { |
| |
| //arbitrarily selected; may need to increase |
| private static final int MAX_RECORD_LENGTH = 100_000; |
| |
| public static final short biff2_sid = 0x0007; |
| public static final short biff345_sid = 0x0207; |
| |
| private short sid; |
| private short field_1_string_len; |
| private byte[] field_2_bytes; |
| private CodepageRecord codepage; |
| |
| /** |
| * @param in the RecordInputstream to read the record from |
| */ |
| public OldStringRecord(RecordInputStream in) { |
| sid = in.getSid(); |
| |
| if (in.getSid() == biff2_sid) { |
| field_1_string_len = (short)in.readUByte(); |
| } else { |
| field_1_string_len = in.readShort(); |
| } |
| |
| // Can only decode properly later when you know the codepage |
| field_2_bytes = IOUtils.safelyAllocate(field_1_string_len, MAX_RECORD_LENGTH); |
| in.read(field_2_bytes, 0, field_1_string_len); |
| } |
| |
| public boolean isBiff2() { |
| return sid == biff2_sid; |
| } |
| |
| public short getSid() { |
| return sid; |
| } |
| |
| public void setCodePage(CodepageRecord codepage) { |
| this.codepage = codepage; |
| } |
| |
| /** |
| * @return The string represented by this record. |
| */ |
| public String getString() |
| { |
| return getString(field_2_bytes, codepage); |
| } |
| |
| protected static String getString(byte[] data, CodepageRecord codepage) { |
| int cp = Property.DEFAULT_CODEPAGE; |
| if (codepage != null) { |
| cp = codepage.getCodepage() & 0xffff; |
| } |
| try { |
| return CodePageUtil.getStringFromCodePage(data, cp); |
| } catch (UnsupportedEncodingException uee) { |
| throw new IllegalArgumentException("Unsupported codepage requested", uee); |
| } |
| } |
| |
| @Override |
| public HSSFRecordTypes getGenericRecordType() { |
| return HSSFRecordTypes.STRING; |
| } |
| |
| @Override |
| public Map<String, Supplier<?>> getGenericProperties() { |
| return GenericRecordUtil.getGenericProperties("string", this::getString); |
| } |
| |
| public String toString() { |
| return GenericRecordJsonWriter.marshal(this); |
| } |
| } |