/*
*
*
* Apache License
* Version 2.0, January 2004
* http://www.apache.org/licenses/
*
* TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
*
* 1. Definitions.
*
* "License" shall mean the terms and conditions for use, reproduction,
* and distribution as defined by Sections 1 through 9 of this document.
*
* "Licensor" shall mean the copyright owner or entity authorized by
* the copyright owner that is granting the License.
*
* "Legal Entity" shall mean the union of the acting entity and all
* other entities that control, are controlled by, or are under common
* control with that entity. For the purposes of this definition,
* "control" means (i) the power, direct or indirect, to cause the
* direction or management of such entity, whether by contract or
* otherwise, or (ii) ownership of fifty percent (50%) or more of the
* outstanding shares, or (iii) beneficial ownership of such entity.
*
* "You" (or "Your") shall mean an individual or Legal Entity
* exercising permissions granted by this License.
*
* "Source" form shall mean the preferred form for making modifications,
* including but not limited to software source code, documentation
* source, and configuration files.
*
* "Object" form shall mean any form resulting from mechanical
* transformation or translation of a Source form, including but
* not limited to compiled object code, generated documentation,
* and conversions to other media types.
*
* "Work" shall mean the work of authorship, whether in Source or
* Object form, made available under the License, as indicated by a
* copyright notice that is included in or attached to the work
* (an example is provided in the Appendix below).
*
* "Derivative Works" shall mean any work, whether in Source or Object
* form, that is based on (or derived from) the Work and for which the
* editorial revisions, annotations, elaborations, or other modifications
* represent, as a whole, an original work of authorship. For the purposes
* of this License, Derivative Works shall not include works that remain
* separable from, or merely link (or bind by name) to the interfaces of,
* the Work and Derivative Works thereof.
*
* "Contribution" shall mean any work of authorship, including
* the original version of the Work and any modifications or additions
* to that Work or Derivative Works thereof, that is intentionally
* submitted to Licensor for inclusion in the Work by the copyright owner
* or by an individual or Legal Entity authorized to submit on behalf of
* the copyright owner. For the purposes of this definition, "submitted"
* means any form of electronic, verbal, or written communication sent
* to the Licensor or its representatives, including but not limited to
* communication on electronic mailing lists, source code control systems,
* and issue tracking systems that are managed by, or on behalf of, the
* Licensor for the purpose of discussing and improving the Work, but
* excluding communication that is conspicuously marked or otherwise
* designated in writing by the copyright owner as "Not a Contribution."
*
* "Contributor" shall mean Licensor and any individual or Legal Entity
* on behalf of whom a Contribution has been received by Licensor and
* subsequently incorporated within the Work.
*
* 2. Grant of Copyright License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* copyright license to reproduce, prepare Derivative Works of,
* publicly display, publicly perform, sublicense, and distribute the
* Work and such Derivative Works in Source or Object form.
*
* 3. Grant of Patent License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* (except as stated in this section) patent license to make, have made,
* use, offer to sell, sell, import, and otherwise transfer the Work,
* where such license applies only to those patent claims licensable
* by such Contributor that are necessarily infringed by their
* Contribution(s) alone or by combination of their Contribution(s)
* with the Work to which such Contribution(s) was submitted. If You
* institute patent litigation against any entity (including a
* cross-claim or counterclaim in a lawsuit) alleging that the Work
* or a Contribution incorporated within the Work constitutes direct
* or contributory patent infringement, then any patent licenses
* granted to You under this License for that Work shall terminate
* as of the date such litigation is filed.
*
* 4. Redistribution. You may reproduce and distribute copies of the
* Work or Derivative Works thereof in any medium, with or without
* modifications, and in Source or Object form, provided that You
* meet the following conditions:
*
* (a) You must give any other recipients of the Work or
* Derivative Works a copy of this License; and
*
* (b) You must cause any modified files to carry prominent notices
* stating that You changed the files; and
*
* (c) You must retain, in the Source form of any Derivative Works
* that You distribute, all copyright, patent, trademark, and
* attribution notices from the Source form of the Work,
* excluding those notices that do not pertain to any part of
* the Derivative Works; and
*
* (d) If the Work includes a "NOTICE" text file as part of its
* distribution, then any Derivative Works that You distribute must
* include a readable copy of the attribution notices contained
* within such NOTICE file, excluding those notices that do not
* pertain to any part of the Derivative Works, in at least one
* of the following places: within a NOTICE text file distributed
* as part of the Derivative Works; within the Source form or
* documentation, if provided along with the Derivative Works; or,
* within a display generated by the Derivative Works, if and
* wherever such third-party notices normally appear. The contents
* of the NOTICE file are for informational purposes only and
* do not modify the License. You may add Your own attribution
* notices within Derivative Works that You distribute, alongside
* or as an addendum to the NOTICE text from the Work, provided
* that such additional attribution notices cannot be construed
* as modifying the License.
*
* You may add Your own copyright statement to Your modifications and
* may provide additional or different license terms and conditions
* for use, reproduction, or distribution of Your modifications, or
* for any such Derivative Works as a whole, provided Your use,
* reproduction, and distribution of the Work otherwise complies with
* the conditions stated in this License.
*
* 5. Submission of Contributions. Unless You explicitly state otherwise,
* any Contribution intentionally submitted for inclusion in the Work
* by You to the Licensor shall be under the terms and conditions of
* this License, without any additional terms or conditions.
* Notwithstanding the above, nothing herein shall supersede or modify
* the terms of any separate license agreement you may have executed
* with Licensor regarding such Contributions.
*
* 6. Trademarks. This License does not grant permission to use the trade
* names, trademarks, service marks, or product names of the Licensor,
* except as required for reasonable and customary use in describing the
* origin of the Work and reproducing the content of the NOTICE file.
*
* 7. Disclaimer of Warranty. Unless required by applicable law or
* agreed to in writing, Licensor provides the Work (and each
* Contributor provides its Contributions) on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied, including, without limitation, any warranties or conditions
* of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
* PARTICULAR PURPOSE. You are solely responsible for determining the
* appropriateness of using or redistributing the Work and assume any
* risks associated with Your exercise of permissions under this License.
*
* 8. Limitation of Liability. In no event and under no legal theory,
* whether in tort (including negligence), contract, or otherwise,
* unless required by applicable law (such as deliberate and grossly
* negligent acts) or agreed to in writing, shall any Contributor be
* liable to You for damages, including any direct, indirect, special,
* incidental, or consequential damages of any character arising as a
* result of this License or out of the use or inability to use the
* Work (including but not limited to damages for loss of goodwill,
* work stoppage, computer failure or malfunction, or any and all
* other commercial damages or losses), even if such Contributor
* has been advised of the possibility of such damages.
*
* 9. Accepting Warranty or Additional Liability. While redistributing
* the Work or Derivative Works thereof, You may choose to offer,
* and charge a fee for, acceptance of support, warranty, indemnity,
* or other liability obligations and/or rights consistent with this
* License. However, in accepting such obligations, You may act only
* on Your own behalf and on Your sole responsibility, not on behalf
* of any other Contributor, and only if You agree to indemnify,
* defend, and hold each Contributor harmless for any liability
* incurred by, or claims asserted against, such Contributor by reason
* of your accepting any such warranty or additional liability.
*
* END OF TERMS AND CONDITIONS
*
* APPENDIX: How to apply the Apache License to your work.
*
* To apply the Apache License to your work, attach the following
* boilerplate notice, with the fields enclosed by brackets "[]"
* replaced with your own identifying information. (Don't include
* the brackets!) The text should be enclosed in the appropriate
* comment syntax for the file format. We also recommend that a
* file or class name and description of purpose be included on the
* same "printed page" as the copyright notice for easier
* identification within third-party archives.
*
* Copyright 2016 Alibaba Group
*
* Licensed 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 android.content.res.chunk.sections;
import android.content.res.IntReader;
import android.content.res.chunk.ChunkType;
import android.content.res.chunk.PoolItem;
import android.content.res.chunk.types.Chunk;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.ByteOrder;
import java.util.ArrayList;
import java.util.Arrays;
public class StringSection extends GenericChunkSection implements Chunk, ChunkSection {
// This specific tag appears unused but might need to be implemented? or used as an unknown?
@SuppressWarnings("unused")
private final int SORTED_FLAG = 1 << 0;
private final int UTF8_FLAG = 1 << 8;
private int stringChunkCount;
private int styleChunkCount;
private int stringChunkFlags;
private int stringChunkPoolOffset;
private int styleChunkPoolOffset;
// FIXME:
// This likely could just be an ordered array of Strings if the Integer is just ordered and the key..
private ArrayList<PoolItem> stringChunkPool;
private ArrayList<PoolItem> styleChunkPool;
public StringSection(ChunkType chunkType, IntReader inputReader) {
super(chunkType, inputReader);
}
@Override
public void readHeader(IntReader inputReader) throws IOException {
stringChunkCount = inputReader.readInt();
styleChunkCount = inputReader.readInt();
stringChunkFlags = inputReader.readInt();
stringChunkPoolOffset = inputReader.readInt();
stringChunkPool = new ArrayList<PoolItem>();
styleChunkPoolOffset = inputReader.readInt();
styleChunkPool = new ArrayList<PoolItem>();
}
@Override
public void readSection(IntReader inputReader) throws IOException {
for (int i = 0; i < stringChunkCount; i++) {
stringChunkPool.add(new PoolItem(inputReader.readInt(), null));
}
if (!stringChunkPool.isEmpty()) {
readPool(stringChunkPool, stringChunkFlags, inputReader);
}
// TODO : Does this need the flags?
// FIXME: This is potentially wrong
for (int i = 0; i < styleChunkCount; i++) {
styleChunkPool.add(new PoolItem(inputReader.readInt(), null));
}
if (!styleChunkPool.isEmpty()) {
readPool(styleChunkPool, stringChunkFlags, inputReader);
}
}
// TODO : Ensure we goto the proper offset in the case it isn't in proper order
private void readPool(ArrayList<PoolItem> pool, int flags, IntReader inputReader) throws IOException {
int offset = 0;
for (PoolItem item : pool) {
// TODO: This assumes that the pool is ordered...
inputReader.skip(item.getOffset() - offset);
offset = item.getOffset();
int length = 0;
if ((flags & UTF8_FLAG) != 0) {
length = inputReader.readByte();
offset += 1;
} else {
length = inputReader.readShort();
offset += 2;
}
StringBuilder result = new StringBuilder(length);
for (; length != 0; length -= 1) {
if ((flags & UTF8_FLAG) != 0) {
result.append((char) inputReader.readByte());
offset += 1;
} else {
result.append((char) inputReader.readShort());
offset += 2;
}
}
item.setString(result.toString());
}
}
public int getStringIndex(String string) {
if (string != null) {
for (PoolItem item : stringChunkPool) {
if (item.getString().equals(string)) {
return stringChunkPool.indexOf(item);
}
}
}
return -1;
}
public int putStringIndex(String string) {
int currentPosition = getStringIndex(string);
if (currentPosition != -1) {
return currentPosition;
}
stringChunkPool.add(new PoolItem(-1, string));
return getStringIndex(string);
}
public String getString(int index) {
if ((index > -1) && (index < stringChunkPool.size())) {
return stringChunkPool.get(index).getString();
}
return "";
}
public String getStyle(int index) {
return styleChunkPool.get(index).getString();
}
@Override
public String toXML(StringSection stringSection, ResourceSection resourceSection, int indent) {
return null;
}
@Override
public int getSize() {
int stringDataSize = 0;
int previousSize;
for (PoolItem item : stringChunkPool) {
previousSize = stringDataSize;
// TODO: This is potentially wrong
// length identifier
stringDataSize += ((stringChunkFlags & UTF8_FLAG) == 0) ? 2 : 1;
// actual string data
stringDataSize += item.getString().length() * (((stringChunkFlags & UTF8_FLAG) == 0) ? 2 : 1);
// buffer
int bufferSize = 4 - (stringDataSize - previousSize) % 4;
if (bufferSize > 0 && bufferSize < 4) {
stringDataSize += bufferSize;
}
}
int styleDataSize = 0;
for (PoolItem item : styleChunkPool) {
styleDataSize += item.getString().length() * (((stringChunkFlags & UTF8_FLAG) == 0) ? 2 : 1);
}
return (2 * 4) + // Header
(5 * 4) + // static sections
(stringChunkPool.size() * 4) + // string table offset size
stringDataSize +
(styleChunkPool.size() * 4) + // style table offset size
styleDataSize;
}
/*
* (non-Javadoc)
*
* @see android.content.res.chunk.types.Chunk#toBytes()
*/
@Override
public byte[] toBytes() {
byte[] header = super.toBytes();
// TODO : We need to ensure these are already "sorted"
ByteBuffer offsetBuffer = ByteBuffer.allocate(stringChunkPool.size() * 4)
.order(ByteOrder.LITTLE_ENDIAN);
int offset = 0;
int previousOffset;
ArrayList<byte[]> stringData = new ArrayList<>();
for (PoolItem item : stringChunkPool) {
offsetBuffer.putInt(offset);
previousOffset = offset;
// TODO : Ensure this is properly handled, potentially a ULEB128?
// Add string length bytes
if (item.getString().length() > 255) {
System.err.println("Error, string length is greater than the current expected lengths!");
}
offset += ((stringChunkFlags & UTF8_FLAG) == 0) ? 2 : 1;
// Add length of string based on if UTF-8 flag is enabled
offset += item.getString().length() * (((stringChunkFlags & UTF8_FLAG) == 0) ? 2 : 1);
// Add buffer
int bufferSize = 4 - ((offset - previousOffset) % 4);
if (bufferSize > 0 && bufferSize < 4) {
offset += bufferSize;
}
// Append actual length + data
ByteBuffer length;
if ((stringChunkFlags & UTF8_FLAG) == 0) {
length = ByteBuffer.allocate(2)
.order(ByteOrder.LITTLE_ENDIAN)
.putShort((short) item.getString().length());
} else {
length = ByteBuffer.allocate(1)
.put((byte) item.getString().length());
}
ByteBuffer string = ByteBuffer.allocate(item.getString().length() * (((stringChunkFlags & UTF8_FLAG) == 0) ? 2 : 1))
.order(ByteOrder.LITTLE_ENDIAN);
for (byte character : item.getString().getBytes()) {
if ((stringChunkFlags & UTF8_FLAG) == 0) {
string.putShort(character);
} else {
string.put(character);
}
}
ByteBuffer stringDataBuffer = ByteBuffer.allocate(offset - previousOffset)
.order(ByteOrder.LITTLE_ENDIAN)
.put(length.array())
.put(string.array());
if (bufferSize > 0 && bufferSize < 4) {
// TODO : fix this
byte[] buffer = new byte[bufferSize];
Arrays.fill(buffer, (byte) 0x00);
stringDataBuffer.put(buffer);
}
stringData.add(stringDataBuffer.array());
}
// Combine strings into one buffer
ByteBuffer stringsBuffer = ByteBuffer.allocate(offsetBuffer.capacity() + offset)
.order(ByteOrder.LITTLE_ENDIAN)
.put(offsetBuffer.array());
for (byte[] data : stringData) {
stringsBuffer.put(data);
}
byte[] strings = stringsBuffer.array();
// byte[] styles = new byte[]{0x00};
int newStringChunkOffset = 0;
if (!stringChunkPool.isEmpty()) {
newStringChunkOffset = (5 * 4) /* header + 3 other ints above it */
+ stringChunkPool.size() * 4 /* index table size */
+ 8 /* (this space and the style chunk offset */;
}
int newStyleChunkOffset = 0;
if (!styleChunkPool.isEmpty()) {
newStyleChunkOffset = (6 * 4) /* header + 4 other ints above it */
+ styleChunkPool.size() * 4 /* index table size */
+ 8 /* (this space and the style chunk offset */;
}
byte[] body = ByteBuffer.allocate(5 * 4)
.order(ByteOrder.LITTLE_ENDIAN)
.putInt(stringChunkPool.size())
.putInt(styleChunkPool.size())
.putInt(stringChunkFlags)
.putInt(newStringChunkOffset)
.putInt(newStyleChunkOffset)
.array();
return ByteBuffer.allocate(header.length + body.length + strings.length /*+ styles.length*/)
.order(ByteOrder.LITTLE_ENDIAN)
.put(header)
.put(body)
.put(strings)
// .put(styles)
.array();
}
}