pink.madis.apk.arsc.PackageChunk Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016 Google Inc. All Rights Reserved.
 *
 * 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 pink.madis.apk.arsc;

import com.google.common.base.Preconditions;
import com.google.common.collect.HashMultimap;
import com.google.common.collect.Multimap;
import org.jetbrains.annotations.Nullable;

import java.io.DataOutput;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

/** A package chunk is a collection of resource data types within a package. */
public final class PackageChunk extends ChunkWithChunks {
  private static final int KNOWN_HEADER_SIZE = 284;

  /** Offset in bytes, from the start of the chunk, where {@code typeStringsOffset} can be found. */
  private static final int TYPE_OFFSET_OFFSET = 268;

  /** Offset in bytes, from the start of the chunk, where {@code keyStringsOffset} can be found. */
  private static final int KEY_OFFSET_OFFSET = 276;

  /** The package id if this is a base package, or 0 if not a base package. */
  private final int id;

  /** The name of the package. */
  private final String packageName;

  /** The offset (from {@code offset}) in the original buffer where type strings start. */
  private final int typeStringsOffset;

  /** The index into the type string pool of the last public type. */
  private final int lastPublicType;

  /** An offset to the string pool that contains the key strings for this package. */
  private final int keyStringsOffset;

  /** The index into the key string pool of the last public key. */
  private final int lastPublicKey;

  /** Extra blob data in the header. On API 21 and later this will contain at least
   * the typeIdOffset as the first 4 bytes and could potentially contain more data. */
  private final byte[] headerBlob;

  /** Contains a mapping of a type index to its {@link TypeSpecChunk}. */
  private final Map typeSpecs = new HashMap<>();

  /** Contains a mapping of a type index to all of the {@link TypeChunk} with that index. */
  private final Multimap types = HashMultimap.create();

  protected PackageChunk(ByteBuffer buffer, @Nullable Chunk parent) {
    super(buffer, parent);
    id = buffer.getInt();
    packageName = PackageUtils.readPackageName(buffer, buffer.position());
    typeStringsOffset = buffer.getInt();
    lastPublicType = buffer.getInt();
    keyStringsOffset = buffer.getInt();
    lastPublicKey = buffer.getInt();

    // if we have any extra bytes then read them
    int blobSz = getHeaderSize() - KNOWN_HEADER_SIZE;
    Preconditions.checkState(blobSz >= 0, String.format(
        "Header smaller than expected! Expected: %d got: %d", KNOWN_HEADER_SIZE, getHeaderSize()));
    headerBlob = new byte[blobSz];
    buffer.get(headerBlob, 0, blobSz);
  }

  @Override
  protected void init(ByteBuffer buffer) {
    super.init(buffer);
    for (Chunk chunk : getChunks().values()) {
      if (chunk instanceof TypeChunk) {
        TypeChunk typeChunk = (TypeChunk) chunk;
        types.put(typeChunk.getId(), typeChunk);
      } else if (chunk instanceof TypeSpecChunk) {
        TypeSpecChunk typeSpecChunk = (TypeSpecChunk) chunk;
        typeSpecs.put(typeSpecChunk.getId(), typeSpecChunk);
      } else if (!(chunk instanceof StringPoolChunk)) {
        throw new IllegalStateException(
            String.format("PackageChunk contains an unexpected chunk: %s", chunk.getClass()));
      }
    }
  }

  /** Returns the package id if this is a base package, or 0 if not a base package. */
  public int getId() {
    return id;
  }

  /**
   * Returns the string pool that contains the names of the resources in this package.
   */
  public StringPoolChunk getKeyStringPool() {
    Chunk chunk = Preconditions.checkNotNull(getChunks().get(keyStringsOffset + offset));
    Preconditions.checkState(chunk instanceof StringPoolChunk, "Key string pool not found.");
    return (StringPoolChunk) chunk;
  }

  /**
   * Returns the string pool that contains the type strings for this package, such as "layout",
   * "string", "color".
   */
  public StringPoolChunk getTypeStringPool() {
    Chunk chunk = Preconditions.checkNotNull(getChunks().get(typeStringsOffset + offset));
    Preconditions.checkState(chunk instanceof StringPoolChunk, "Type string pool not found.");
    return (StringPoolChunk) chunk;
  }

  /** Returns all {@link TypeChunk} in this package. */
  public Collection getTypeChunks() {
    return types.values();
  }

  /**
   * For a given type id, returns the {@link TypeChunk} objects that match that id. The type id is
   * the 1-based index of the type in the type string pool (returned by {@link #getTypeStringPool}).
   *
   * @param id The 1-based type id to return {@link TypeChunk} objects for.
   * @return The matching {@link TypeChunk} objects, or an empty collection if there are none.
   */
  public Collection getTypeChunks(int id) {
    return types.get(id);
  }

  /**
   * For a given type, returns the {@link TypeChunk} objects that match that type
   * (e.g. "attr", "id", "string", ...).
   *
   * @param type The type to return {@link TypeChunk} objects for.
   * @return The matching {@link TypeChunk} objects, or an empty collection if there are none.
   */
  public Collection getTypeChunks(String type) {
    StringPoolChunk typeStringPool = Preconditions.checkNotNull(getTypeStringPool());
    return getTypeChunks(typeStringPool.indexOf(type) + 1);  // Convert 0-based index to 1-based
  }

  /** Returns all {@link TypeSpecChunk} in this package. */
  public Collection getTypeSpecChunks() {
    return typeSpecs.values();
  }

  /** For a given (1-based) type id, returns the {@link TypeSpecChunk} matching it. */
  public TypeSpecChunk getTypeSpecChunk(int id) {
    return Preconditions.checkNotNull(typeSpecs.get(id));
  }

  /**
   * For a given {@code type}, returns the {@link TypeSpecChunk} that matches it
   * (e.g. "attr", "id", "string", ...).
   */
  public TypeSpecChunk getTypeSpecChunk(String type) {
    StringPoolChunk typeStringPool = Preconditions.checkNotNull(getTypeStringPool());
    return getTypeSpecChunk(typeStringPool.indexOf(type) + 1);  // Convert 0-based index to 1-based
  }

  /** Returns the name of this package. */
  public String getPackageName() {
    return packageName;
  }

  @Override
  protected Type getType() {
    return Chunk.Type.TABLE_PACKAGE;
  }

  @Override
  protected void writeHeader(ByteBuffer output) {
    output.putInt(id);
    PackageUtils.writePackageName(output, packageName);
    output.putInt(0);  // typeStringsOffset. This value can't be computed here.
    output.putInt(lastPublicType);
    output.putInt(0);  // keyStringsOffset. This value can't be computed here.
    output.putInt(lastPublicKey);
    output.put(headerBlob);
  }

  @Override
  protected void writePayload(DataOutput output, ByteBuffer header, boolean shrink)
      throws IOException {
    int typeOffset = typeStringsOffset;
    int keyOffset = keyStringsOffset;
    int payloadOffset = 0;
    for (Chunk chunk : getChunks().values()) {
      if (chunk == getTypeStringPool()) {
        typeOffset = payloadOffset + getHeaderSize();
      } else if (chunk == getKeyStringPool()) {
        keyOffset = payloadOffset + getHeaderSize();
      }
      byte[] chunkBytes = chunk.toByteArray(shrink);
      output.write(chunkBytes);
      payloadOffset = writePad(output, chunkBytes.length);
    }
    header.putInt(TYPE_OFFSET_OFFSET, typeOffset);
    header.putInt(KEY_OFFSET_OFFSET, keyOffset);
  }
}