com.tencent.tinker.build.patch.Configuration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tinker-patch-lib Show documentation
Show all versions of tinker-patch-lib Show documentation
Tinker is a hot-fix solution library for Android, it supports dex, library and resources update without reinstalling apk.
/*
* Tencent is pleased to support the open source community by making Tinker available.
*
* Copyright (C) 2016 THL A29 Limited, a Tencent company. All rights reserved.
*
* Licensed under the BSD 3-Clause License (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
*
* https://opensource.org/licenses/BSD-3-Clause
*
* 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 com.tencent.tinker.build.patch;
import com.tencent.tinker.build.util.FileOperation;
import com.tencent.tinker.build.util.TinkerPatchException;
import com.tencent.tinker.build.util.TypedValue;
import com.tencent.tinker.build.util.Utils;
import com.tencent.tinker.commons.util.IOHelper;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.EntityResolver;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.HashMap;
import java.util.HashSet;
import java.util.regex.Pattern;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
/**
* @author zhangshaowen
* do not use Logger here
*/
public class Configuration {
protected static final String TAG_ISSUE = "issue";
protected static final String DEX_ISSUE = "dex";
protected static final String SO_ISSUE = "lib";
protected static final String RES_ISSUE = "resource";
protected static final String ARKHOT_ISSUE = "arkHot";
protected static final String SIGN_ISSUE = "sign";
protected static final String PACKAGE_CONFIG_ISSUE = "packageConfig";
protected static final String PROPERTY_ISSUE = "property";
protected static final String ATTR_ID = "id";
protected static final String ATTR_VALUE = "value";
protected static final String ATTR_NAME = "name";
protected static final String ATTR_IGNORE_WARNING = "ignoreWarning";
protected static final String ATTR_ALLOW_LOADER_IN_ANY_DEX = "allowLoaderInAnyDex";
protected static final String ATTR_REMOVE_LOADER_FOR_ALL_DEX = "removeLoaderForAllDex";
protected static final String ATTR_IS_PROTECTED_APP = "isProtectedApp";
protected static final String ATTR_SUPPORT_HOTPLUG_COMPONENT = "supportHotplugComponent";
protected static final String ATTR_USE_SIGN = "useSign";
protected static final String ATTR_SEVEN_ZIP_PATH = "sevenZipPath";
protected static final String ATTR_DEX_MODE = "dexMode";
protected static final String ATTR_PATTERN = "pattern";
protected static final String ATTR_IGNORE_CHANGE = "ignoreChange";
protected static final String ATTR_IGNORE_CHANGE_WARNING = "ignoreChangeWarning";
protected static final String ATTR_RES_LARGE_MOD = "largeModSize";
protected static final String ATTR_ARKHOT_PATH = "path";
protected static final String ATTR_ARKHOT_NAME = "name";
protected static final String ATTR_LOADER = "loader";
protected static final String ATTR_CONFIG_FIELD = "configField";
protected static final String ATTR_SIGN_FILE_PATH = "path";
protected static final String ATTR_SIGN_FILE_KEYPASS = "keypass";
protected static final String ATTR_SIGN_FILE_STOREPASS = "storepass";
protected static final String ATTR_SIGN_FILE_ALIAS = "alias";
/**
* base config data
*/
public String mOldApkPath;
public String mNewApkPath;
public String mOutFolder;
public File mOldApkFile;
public File mNewApkFile;
public boolean mIgnoreWarning;
public boolean mAllowLoaderInAnyDex;
public boolean mIsProtectedApp;
public boolean mRemoveLoaderForAllDex;
public boolean mSupportHotplugComponent;
/**
* lib config
*/
public HashSet mSoFilePattern;
/**
* dex config
*/
public HashSet mDexFilePattern;
public HashSet mDexLoaderPattern;
public HashSet mDexIgnoreWarningLoaderPattern;
public boolean mDexRaw;
/**
* resource config
*/
public HashSet mResFilePattern;
public HashSet mResIgnoreChangePattern;
public HashSet mResIgnoreChangeWarningPattern;
public HashSet mResRawPattern;
public int mLargeModSize;
/**
* only gradle have the param
*/
public boolean mUseApplyResource;
/**
* package file config
*/
public HashMap mPackageFields;
/**
* sevenZip path config
*/
public String mSevenZipPath;
/**
* sign data
*/
public boolean mUseSignAPk;
public File mSignatureFile;
public String mKeyPass;
public String mStoreAlias;
public String mStorePass;
/**
* temp files
*/
public File mTempResultDir;
public File mTempUnzipOldDir;
public File mTempUnzipNewDir;
public boolean mUsingGradle;
/**
* ark patch
*/
public String mArkHotPatchPath;
public String mArkHotPatchName;
/**
* use by command line with xml config
*/
public Configuration(File config, File outputFile, File oldApkFile, File newApkFile)
throws IOException, ParserConfigurationException, SAXException, TinkerPatchException {
mUsingGradle = false;
mSoFilePattern = new HashSet<>();
mDexFilePattern = new HashSet<>();
mDexLoaderPattern = new HashSet<>();
mDexIgnoreWarningLoaderPattern = new HashSet<>();
mResFilePattern = new HashSet<>();
mResRawPattern = new HashSet<>();
mResIgnoreChangePattern = new HashSet<>();
mResIgnoreChangeWarningPattern = new HashSet<>();
mPackageFields = new HashMap<>();
mOutFolder = outputFile.getAbsolutePath();
FileOperation.cleanDir(outputFile);
mOldApkFile = oldApkFile;
mOldApkPath = oldApkFile.getAbsolutePath();
mNewApkFile = newApkFile;
mNewApkPath = newApkFile.getAbsolutePath();
mLargeModSize = 100;
readXmlConfig(config);
createTempDirectory();
checkInputPatternParameter();
}
/**
* use by gradle
*/
public Configuration(InputParam param) throws IOException, TinkerPatchException {
mUsingGradle = true;
mSoFilePattern = new HashSet<>();
mDexFilePattern = new HashSet<>();
mDexLoaderPattern = new HashSet<>();
mDexIgnoreWarningLoaderPattern = new HashSet<>();
mResFilePattern = new HashSet<>();
mResRawPattern = new HashSet<>();
mResIgnoreChangePattern = new HashSet<>();
mResIgnoreChangeWarningPattern = new HashSet<>();
mPackageFields = new HashMap<>();
for (String item : param.soFilePattern) {
addToPatterns(item, mSoFilePattern);
}
for (String item : param.dexFilePattern) {
addToPatterns(item, mDexFilePattern);
}
for (String item : param.resourceFilePattern) {
mResRawPattern.add(item);
addToPatterns(item, mResFilePattern);
}
for (String item : param.resourceIgnoreChangePattern) {
addToPatterns(item, mResIgnoreChangePattern);
}
for (String item : param.resourceIgnoreChangeWarningPattern) {
addToPatterns(item, mResIgnoreChangeWarningPattern);
}
mLargeModSize = param.largeModSize;
//only gradle have the param
mUseApplyResource = param.useApplyResource;
mDexLoaderPattern.addAll(param.dexLoaderPattern);
mDexIgnoreWarningLoaderPattern.addAll(param.dexIgnoreWarningLoaderPattern);
//can be only raw or jar
if (param.dexMode.equals("raw")) {
mDexRaw = true;
}
mOldApkPath = param.oldApk;
mOldApkFile = new File(mOldApkPath);
mNewApkPath = param.newApk;
mNewApkFile = new File(mNewApkPath);
mOutFolder = param.outFolder;
mIgnoreWarning = param.ignoreWarning;
mAllowLoaderInAnyDex = param.allowLoaderInAnyDex;
mRemoveLoaderForAllDex= param.removeLoaderForAllDex;
mIsProtectedApp = param.isProtectedApp;
mSupportHotplugComponent = param.supportHotplugComponent;
mSevenZipPath = param.sevenZipPath;
mPackageFields = param.configFields;
mUseSignAPk = param.useSign;
setSignData(param.signFile, param.keypass, param.storealias, param.storepass);
FileOperation.cleanDir(new File(mOutFolder));
createTempDirectory();
checkInputPatternParameter();
mArkHotPatchName = param.arkHotPatchName;
mArkHotPatchPath = param.arkHotPatchPath;
}
@Override
public String toString() {
StringBuffer sb = new StringBuffer();
sb.append("configuration: \n");
sb.append("oldApk:" + mOldApkPath + "\n");
sb.append("newApk:" + mNewApkPath + "\n");
sb.append("outputFolder:" + mOutFolder + "\n");
sb.append("isIgnoreWarning:" + mIgnoreWarning + "\n");
sb.append("isAllowLoaderClassInAnyDex:" + mAllowLoaderInAnyDex + "\n");
sb.append("isRemoveLoaderForAllDex:" + mRemoveLoaderForAllDex + "\n");
sb.append("isProtectedApp:" + mIsProtectedApp + "\n");
sb.append("7-ZipPath:" + mSevenZipPath + "\n");
sb.append("useSignAPk:" + mUseSignAPk + "\n");
sb.append("package meta fields: \n");
for (String name : mPackageFields.keySet()) {
sb.append("filed name:" + name + ", filed value:" + mPackageFields.get(name) + "\n");
}
sb.append("dex configs: \n");
if (mDexRaw) {
sb.append("dexMode: raw" + "\n");
} else {
sb.append("dexMode: jar" + "\n");
}
for (Pattern name : mDexFilePattern) {
sb.append("dexPattern:" + name.toString() + "\n");
}
for (String name : mDexLoaderPattern) {
sb.append("dex loader:" + name + "\n");
}
for (String name : mDexIgnoreWarningLoaderPattern) {
sb.append("dex ignore warning loader:" + name.toString() + "\n");
}
sb.append("lib configs: \n");
for (Pattern name : mSoFilePattern) {
sb.append("libPattern:" + name.toString() + "\n");
}
sb.append("resource configs: \n");
for (Pattern name : mResFilePattern) {
sb.append("resPattern:" + name.toString() + "\n");
}
for (Pattern name : mResIgnoreChangePattern) {
sb.append("resIgnore change:" + name.toString() + "\n");
}
for (Pattern name : mResIgnoreChangeWarningPattern) {
sb.append("resIgnore change warning:" + name.toString() + "\n");
}
sb.append("largeModSize:" + mLargeModSize + "kb\n");
sb.append("useApplyResource:" + mUseApplyResource + "\n");
sb.append("ArkHot: " + mArkHotPatchPath + " / " + mArkHotPatchName + "\n");
return sb.toString();
}
private void createTempDirectory() throws TinkerPatchException {
mTempResultDir = new File(mOutFolder + File.separator + TypedValue.PATH_PATCH_FILES);
FileOperation.deleteDir(mTempResultDir);
if (!mTempResultDir.exists()) {
mTempResultDir.mkdir();
}
String oldApkName = mOldApkFile.getName();
if (!oldApkName.endsWith(TypedValue.FILE_APK)) {
throw new TinkerPatchException(
String.format("input apk file path must end with .apk, yours %s\n", oldApkName)
);
}
String newApkName = mNewApkFile.getName();
if (!newApkName.endsWith(TypedValue.FILE_APK)) {
throw new TinkerPatchException(
String.format("input apk file path must end with .apk, yours %s\n", newApkName)
);
}
String tempOldName = oldApkName.substring(0, oldApkName.indexOf(TypedValue.FILE_APK));
String tempNewName = newApkName.substring(0, newApkName.indexOf(TypedValue.FILE_APK));
// Bugfix: For windows user, filename is case-insensitive.
if (tempNewName.equalsIgnoreCase(tempOldName)) {
tempOldName += "-old";
tempNewName += "-new";
}
mTempUnzipOldDir = new File(mOutFolder, tempOldName);
mTempUnzipNewDir = new File(mOutFolder, tempNewName);
}
public void setSignData(File signatureFile, String keypass, String storealias, String storepass) throws IOException {
if (mUseSignAPk) {
mSignatureFile = signatureFile;
if (!mSignatureFile.exists()) {
throw new IOException(
String.format("the signature file do not exit, raw path= %s\n", mSignatureFile.getAbsolutePath())
);
}
mKeyPass = keypass;
mStoreAlias = storealias;
mStorePass = storepass;
}
}
private void checkInputPatternParameter() throws TinkerPatchException {
if (mSoFilePattern.isEmpty() && mDexFilePattern.isEmpty() && mResFilePattern.isEmpty()) {
throw new TinkerPatchException("no dex, so or resource pattern are found");
}
if (mLargeModSize <= 0) {
throw new TinkerPatchException("largeModSize must be larger than 0");
}
}
/**
* read args from xml
**/
void readXmlConfig(File xmlConfigFile)
throws IOException, ParserConfigurationException, SAXException {
if (!xmlConfigFile.exists()) {
return;
}
System.out.printf("reading config file, %s\n", xmlConfigFile.getAbsolutePath());
BufferedInputStream input = null;
try {
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
input = new BufferedInputStream(new FileInputStream(xmlConfigFile));
InputSource source = new InputSource(input);
factory.setNamespaceAware(false);
factory.setValidating(false);
DocumentBuilder builder = factory.newDocumentBuilder();
// Block any external content resolving actions since we don't need them and a report
// says these actions may cause security problems.
builder.setEntityResolver(new EntityResolver() {
@Override
public InputSource resolveEntity(String publicId, String systemId) throws SAXException, IOException {
return new InputSource();
}
});
Document document = builder.parse(source);
NodeList issues = document.getElementsByTagName(TAG_ISSUE);
for (int i = 0, count = issues.getLength(); i < count; i++) {
Node node = issues.item(i);
Element element = (Element) node;
String id = element.getAttribute(ATTR_ID);
if (id.length() == 0) {
System.err.println("Invalid config file: Missing required issue id attribute");
continue;
}
if (id.equals(PROPERTY_ISSUE)) {
readPropertyFromXml(node);
} else if (id.equals(DEX_ISSUE)) {
readDexPatternsFromXml(node);
} else if (id.equals(SO_ISSUE)) {
readLibPatternsFromXml(node);
} else if (id.equals(RES_ISSUE)) {
readResPatternsFromXml(node);
} else if (id.equals(PACKAGE_CONFIG_ISSUE)) {
readPackageConfigFromXml(node);
} else if (id.equals(SIGN_ISSUE)) {
if (mUseSignAPk) {
readSignFromXml(node);
}
} else if (id.equals(ARKHOT_ISSUE)) {
readArkHotPropertyFromXml(node);
} else {
System.err.println("unknown issue " + id);
}
}
} finally {
IOHelper.closeQuietly(input);
}
}
private void readPropertyFromXml(Node node) throws IOException {
NodeList childNodes = node.getChildNodes();
if (childNodes.getLength() > 0) {
for (int j = 0, n = childNodes.getLength(); j < n; j++) {
Node child = childNodes.item(j);
if (child.getNodeType() == Node.ELEMENT_NODE) {
Element check = (Element) child;
String tagName = check.getTagName();
String value = check.getAttribute(ATTR_VALUE);
if (value.length() == 0) {
throw new IOException(
String.format("Invalid config file: Missing required attribute %s\n", ATTR_VALUE)
);
}
if (tagName.equals(ATTR_IGNORE_WARNING)) {
mIgnoreWarning = value.equals("true");
} else if (tagName.equals(ATTR_ALLOW_LOADER_IN_ANY_DEX)) {
mAllowLoaderInAnyDex = value.equals("true");
} else if (tagName.equals(ATTR_REMOVE_LOADER_FOR_ALL_DEX)) {
mRemoveLoaderForAllDex = value.equals("true");
} else if (tagName.equals(ATTR_IS_PROTECTED_APP)) {
mIsProtectedApp = value.equals("true");
} else if (tagName.equals(ATTR_SUPPORT_HOTPLUG_COMPONENT)) {
mSupportHotplugComponent = value.equals("true");
} else if (tagName.equals(ATTR_USE_SIGN)) {
mUseSignAPk = value.equals("true");
} else if (tagName.equals(ATTR_SEVEN_ZIP_PATH)) {
File sevenZipFile = new File(value);
if (sevenZipFile.exists()) {
mSevenZipPath = value;
} else {
mSevenZipPath = "7za";
}
} else {
System.err.println("unknown property tag " + tagName);
}
}
}
}
}
private void readArkHotPropertyFromXml(Node node) throws IOException {
NodeList childNodes = node.getChildNodes();
if (childNodes.getLength() > 0) {
for (int j = 0, n = childNodes.getLength(); j < n; j++) {
Node child = childNodes.item(j);
if (child.getNodeType() == Node.ELEMENT_NODE) {
Element check = (Element) child;
String tagName = check.getTagName();
String value = check.getAttribute(ATTR_VALUE);
if (tagName.equals(ATTR_ARKHOT_PATH)) {
mArkHotPatchPath = value;
mArkHotPatchPath.trim();
} else if (tagName.equals(ATTR_ARKHOT_NAME)) {
mArkHotPatchName = value;
mArkHotPatchName.trim();
} else {
System.err.println("unknown dex tag " + tagName);
}
}
}
}
}
private void readSignFromXml(Node node) throws IOException {
if (mSignatureFile != null) {
System.err.println("already set the sign info from command line, ignore this");
return;
}
NodeList childNodes = node.getChildNodes();
if (childNodes.getLength() > 0) {
for (int j = 0, n = childNodes.getLength(); j < n; j++) {
Node child = childNodes.item(j);
if (child.getNodeType() == Node.ELEMENT_NODE) {
Element check = (Element) child;
String tagName = check.getTagName();
String value = check.getAttribute(ATTR_VALUE);
if (value.length() == 0) {
throw new IOException(
String.format("Invalid config file: Missing required attribute %s\n", ATTR_VALUE)
);
}
if (tagName.equals(ATTR_SIGN_FILE_PATH)) {
mSignatureFile = new File(value);
if (!mSignatureFile.exists()) {
throw new IOException(
String.format("the signature file do not exit, raw path= %s\n", mSignatureFile.getAbsolutePath())
);
}
} else if (tagName.equals(ATTR_SIGN_FILE_STOREPASS)) {
mStorePass = value;
mStorePass = mStorePass.trim();
} else if (tagName.equals(ATTR_SIGN_FILE_KEYPASS)) {
mKeyPass = value;
mKeyPass = mKeyPass.trim();
} else if (tagName.equals(ATTR_SIGN_FILE_ALIAS)) {
mStoreAlias = value;
mStoreAlias = mStoreAlias.trim();
} else {
System.err.println("unknown sign tag " + tagName);
}
}
}
}
}
private void readDexPatternsFromXml(Node node) throws IOException {
NodeList childNodes = node.getChildNodes();
if (childNodes.getLength() > 0) {
for (int j = 0, n = childNodes.getLength(); j < n; j++) {
Node child = childNodes.item(j);
if (child.getNodeType() == Node.ELEMENT_NODE) {
Element check = (Element) child;
String tagName = check.getTagName();
String value = check.getAttribute(ATTR_VALUE);
if (tagName.equals(ATTR_DEX_MODE)) {
if (value.equals("raw")) {
mDexRaw = true;
}
} else if (tagName.equals(ATTR_PATTERN)) {
addToPatterns(value, mDexFilePattern);
} else if (tagName.equals(ATTR_LOADER)) {
mDexLoaderPattern.add(value);
} else if (tagName.equals(ATTR_IGNORE_CHANGE)) {
mDexIgnoreWarningLoaderPattern.add(value);
} else {
System.err.println("unknown dex tag " + tagName);
}
}
}
}
}
private void readLibPatternsFromXml(Node node) throws IOException {
NodeList childNodes = node.getChildNodes();
if (childNodes.getLength() > 0) {
for (int j = 0, n = childNodes.getLength(); j < n; j++) {
Node child = childNodes.item(j);
if (child.getNodeType() == Node.ELEMENT_NODE) {
Element check = (Element) child;
String tagName = check.getTagName();
String value = check.getAttribute(ATTR_VALUE);
if (tagName.equals(ATTR_PATTERN)) {
addToPatterns(value, mSoFilePattern);
} else {
System.err.println("unknown dex tag " + tagName);
}
}
}
}
}
private void readResPatternsFromXml(Node node) throws IOException {
NodeList childNodes = node.getChildNodes();
if (childNodes.getLength() > 0) {
for (int j = 0, n = childNodes.getLength(); j < n; j++) {
Node child = childNodes.item(j);
if (child.getNodeType() == Node.ELEMENT_NODE) {
Element check = (Element) child;
String tagName = check.getTagName();
String value = check.getAttribute(ATTR_VALUE);
if (tagName.equals(ATTR_PATTERN)) {
mResRawPattern.add(value);
addToPatterns(value, mResFilePattern);
} else if (tagName.equals(ATTR_IGNORE_CHANGE)) {
if (!Utils.isBlank(value)) {
addToPatterns(value, mResIgnoreChangePattern);
}
} else if (tagName.equals(ATTR_IGNORE_CHANGE_WARNING)) {
if (!Utils.isBlank(value)) {
addToPatterns(value, mResIgnoreChangeWarningPattern);
}
} else if (tagName.equals(ATTR_RES_LARGE_MOD)) {
mLargeModSize = Integer.valueOf(value);
} else {
System.err.println("unknown dex tag " + tagName);
}
}
}
}
}
private void readPackageConfigFromXml(Node node) throws IOException {
NodeList childNodes = node.getChildNodes();
if (childNodes.getLength() > 0) {
for (int j = 0, n = childNodes.getLength(); j < n; j++) {
Node child = childNodes.item(j);
if (child.getNodeType() == Node.ELEMENT_NODE) {
Element check = (Element) child;
String tagName = check.getTagName();
String value = check.getAttribute(ATTR_VALUE);
String name = check.getAttribute(ATTR_NAME);
if (tagName.equals(ATTR_CONFIG_FIELD)) {
mPackageFields.put(name, value);
} else {
System.err.println("unknown package config tag " + tagName);
}
}
}
}
}
private void addToPatterns(String value, HashSet patterns) throws IOException {
if (value.length() == 0) {
throw new IOException(
String.format("Invalid config file: Missing required attribute %s\n", ATTR_VALUE)
);
}
value = Utils.convertToPatternString(value);
Pattern pattern = Pattern.compile(value);
patterns.add(pattern);
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy