/*
*
* 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.taobao.atlas.framework;
import android.os.Build;
import android.taobao.atlas.bundleInfo.AtlasBundleInfoManager;
import android.taobao.atlas.framework.bundlestorage.Archive;
import android.taobao.atlas.framework.bundlestorage.BundleArchiveRevision;
import android.taobao.atlas.hack.AtlasHacks;
import android.taobao.atlas.runtime.RuntimeVariables;
import android.taobao.atlas.util.FileUtils;
import android.util.Log;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleException;
import org.osgi.framework.Constants;
import java.io.File;
import java.io.IOException;
import java.lang.reflect.Method;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.Hashtable;
import java.util.List;
import java.util.Set;
import java.util.StringTokenizer;
import java.util.jar.Attributes;
import java.util.jar.Manifest;
import dalvik.system.BaseDexClassLoader;
public final class BundleClassLoader extends BaseDexClassLoader {
/**
* the archive file.
*/
final Archive archive;
/**
* the exports of this bundle.
*/
String[] exports = new String[0];
List<String> dependencies = null;
/**
* reference to the bundle object.
*/
BundleImpl bundle;
/**
* the location of the bundle
*/
String location = null;
/**
* an empty vector instance.
*/
private static final List<URL> EMPTY_LIST = new ArrayList<URL>();
public ClassLoadListener classLoadListener;
/**
* create a new bundle classloader.
*
* @param bundle the bundle object.
* @throws BundleException in case of IO errors.
*/
BundleClassLoader(final BundleImpl bundle,List<String> dependencies,String nativeLibPath) throws BundleException {
super(".",null,nativeLibPath,Object.class.getClassLoader());
Log.e("BundleClassLoader","nativeLibPath : "+nativeLibPath);
if(Build.VERSION.SDK_INT>=25) {
try {
Class PatchClassLoaderFactory = Class.forName("com.android.internal.os.PathClassLoaderFactory");
Method method = PatchClassLoaderFactory.getDeclaredMethod("createClassloaderNamespace",
ClassLoader.class, int.class, String.class, String.class, boolean.class);
method.setAccessible(true);
method.invoke(PatchClassLoaderFactory, this, 24, nativeLibPath, nativeLibPath, true);
} catch (Throwable e) {
e.printStackTrace();
}
}
this.bundle = bundle;
this.archive = bundle.archive;
this.location = bundle.location;
this.dependencies = dependencies;
try {
processManifest(archive.getManifest());
} catch (IOException ioe) {
// AtlasMonitor.getInstance().trace(AtlasMonitor.BUNDLE_INSTALL_FAIL, bundle.location, AtlasMonitor.OSGI_FAILED_MSG,
// FileUtils.getDataAvailableSpace());
ioe.printStackTrace();
throw new BundleException("Not a valid bundle: " + bundle.location);
}
}
public boolean validateClasses(){
if(archive == null ){
return false;
}
if(!archive.isDexOpted()){
return false;
}
List<String> dependencies = AtlasBundleInfoManager.instance().getBundleInfo(location).getTotalDependency();
for(String bundleName : dependencies){
BundleImpl dependencyBundle = (BundleImpl)Atlas.getInstance().getBundle(bundleName);
if(dependencyBundle==null || dependencyBundle.getArchive()==null || !dependencyBundle.getArchive().isDexOpted()){
return false;
}
}
return true;
}
public BundleImpl getBundle() {
return this.bundle;
}
public String[] getExports() {
return exports;
}
/**
* process the bundle manifest.
*
* @param manifest the Manifest.
* @throws BundleException in case of parse errors.
*/
private void processManifest(final Manifest manifest) throws BundleException {
final Attributes attrs = (manifest != null) ? manifest.getMainAttributes() : new Attributes();
checkEE(readProperty(attrs, Constants.BUNDLE_REQUIREDEXECUTIONENVIRONMENT),
splitString(System.getProperty(Constants.FRAMEWORK_EXECUTIONENVIRONMENT)));
// get the exports
exports = readProperty(attrs, Constants.EXPORT_PACKAGE);
if(exports!=null){
int pos = 0;
for(int x=0; x<exports.length; x++){
if((pos = exports[x].indexOf("*"))>-1){
exports[x] = exports[x].substring(0,pos);
}
Log.d("BundleClassLoader",String.format("%s dependency: %s",location,exports[x]));
}
}
// set the bundle headers
final Hashtable<String, String> headers = new Hashtable<String, String>(attrs.size());
final Object[] entries = attrs.keySet().toArray(new Object[attrs.keySet().size()]);
for (int i = 0; i < entries.length; i++) {
headers.put(entries[i].toString(), attrs.get(entries[i]).toString());
}
bundle.headers = headers;
}
private void checkEE(final String[] req, final String[] having) throws BundleException {
if (req.length == 0) {
return;
}
final Set<String> havingEEs = new HashSet<String>(Arrays.asList(having));
for (int i = 0; i < req.length; i++) {
if (havingEEs.contains(req[i])) {
return;
}
}
throw new BundleException("Platform does not provide EEs " + Arrays.asList(req));
}
/**
* 解决bundle循环依赖的问题
* @param className
* @return
* @throws ClassNotFoundException
*/
public Class<?> loadOwnClass(String className) throws ClassNotFoundException {
Class<?> clazz = findLoadedClass(className);
if (clazz == null) {
clazz = findOwnClass(className);
}
return clazz;
}
/**
* perform a cleanup
* todo
*/
void cleanup(final boolean full) {
}
/**
* find a class. The following order has to be used for loading classes:
* <ol>
* <li>The system class loader (already done by the loadClass method prior to this method call)</li>
* <li>The own bundle</li>
* <li>Possibly imported packages</li>
* </ol>
*
* @param classname the name of the class.
* @return the <code>Class</code> object, if the class could be found.
* @throws ClassNotFoundException if the class could not be found.
* @category ClassLoader
* @see java.lang.ClassLoader#findClass(java.lang.String)
*/
protected Class<?> findClass(final String classname) throws ClassNotFoundException {
Class<?> clazz;
// okay, check if it is in the scope of this classloader
clazz = findOwnClass(classname);
if (clazz != null) {
if(classLoadListener!=null){
classLoadListener.onClassLoaded(clazz);
}
return clazz;
}
// find class in PathClassLoader
try {
clazz = Framework.systemClassLoader.loadClass(classname);
if (clazz != null) {
return clazz;
}
} catch (Exception e) {
}
// find class in dependency bundle
if (dependencies != null) {
for (String dependencyBundle : dependencies) {
try {
BundleImpl impl = (BundleImpl) Atlas.getInstance().getBundle(dependencyBundle);
impl.startBundle();
String[] exports = ((BundleClassLoader) impl.getClassLoader()).getExports();
if (exports != null && exports.length > 0) {
//if has ,only loadclass when className in exports
for(String export : exports){
if(classname.startsWith(export)){
clazz = ((BundleClassLoader) impl.getClassLoader()).loadOwnClass(classname);
if(clazz!=null){
return clazz;
}
}
}
} else {
clazz = ((BundleClassLoader) impl.getClassLoader()).loadOwnClass(classname);
if(clazz!=null){
return clazz;
}
}
} catch (Throwable e) {
//e.printStackTrace();
}
}
}
throw new ClassNotFoundException("Can't find class " + classname + " in BundleClassLoader: " + bundle.getLocation());
}
/**
* Find a class in the scope of this classloader.
*
* @param classname the name of the class.
* @return the <code>Class</code> object if the class could be found. <code>null</code> otherwise.
* @throws Exception
*/
private Class<?> findOwnClass(final String classname) {
try {
Class<?> clazz = archive.findClass(classname, this);
return clazz;
} catch (Exception e) {
if (e instanceof BundleArchiveRevision.DexLoadException) {
throw (BundleArchiveRevision.DexLoadException) e;
}
}
return null;
}
/**
* Find a class that is delegated from a different classloader by package import.
*
* @param classname the name of the class.
* @return the <code>Class</code> object, if the class could be found. <code>null</code> otherwise.
*/
private static Class<?> findDelegatedClass(final BundleClassLoader delegation, final String classname) {
final Class<?> clazz;
synchronized (delegation) {
return ((clazz = delegation.findLoadedClass(classname)) == null) ? delegation.findOwnClass(classname) : clazz;
}
}
/**
* find a single resource.
*
* @param filename the name of the resource.
* @return the URL to the resource.
* @category ClassLoader
* @see java.lang.ClassLoader#findResource(java.lang.String)
*/
protected URL findResource(final String filename) {
final String name = stripTrailing(filename);
List<URL> results = findOwnResources(name, false);
if (results.size() > 0) {
return results.get(0);
}
try {
results = findImportedResources(name, false);
}catch(NullPointerException e){
return null;
}
return results.size() > 0 ? results.get(0) : null;
}
/**
* find multiple resources.
*
* @param filename the name of the resource.
* @return an <code>Enumeration</code> over <code>URL</code> objects.
* @category ClassLoader
* @see java.lang.ClassLoader#findResources(java.lang.String)
*/
protected Enumeration<URL> findResources(final String filename) {
final String name = stripTrailing(filename);
final List<URL> results = findOwnResources(name, true);
results.addAll(findImportedResources(name, true));
return Collections.enumeration(results);
}
/**
* find one or more resources in the scope of the own classloader.
*
* @param name the name of the resource
* @param multiple if false, the search terminates if the first result has been found.
* @return a <code>List</code> of <code>URL</code> elements.
*/
private List<URL> findOwnResources(final String name, boolean multiple) {
try {
return archive.getResources(name);
} catch (IOException e) {
e.printStackTrace();
}
return EMPTY_LIST;
}
/**
* find one or more resources imported from other bundles.
*
* @param name the name of the resource.
* @param multiple if false, the searching terminates if the first resource has been found.
* @return a <code>List</code> of <code>URL</code> elements.
*/
private List<URL> findImportedResources(final String name, final boolean multiple) {
if (bundle.state == Bundle.INSTALLED) {
return EMPTY_LIST;
}
BundleClassLoader delegation = null;
String packageName = packageOf(pseudoClassname(name));
if (dependencies != null) {
for (String dependencyBundle : dependencies) {
BundleClassLoader loader = (BundleClassLoader)((BundleImpl)Atlas.getInstance().getBundle(dependencyBundle)).getClassLoader();
String[] exports = loader.getExports();
if (exports != null && exports.length > 0) {
for (String export : exports) {
if (packageName.startsWith(export)) {
delegation = loader;
}
}
}
}
}
if (delegation == null) {
return EMPTY_LIST;
} else {
return delegation.findOwnResources(name, multiple);
}
}
/**
* find a native code library.
*
* @param libraryName the name of the library.
* @return the String of a path name to the library or <code>null</code>.
* @category ClassLoader
* @see java.lang.ClassLoader#findLibrary(java.lang.String)
*/
public String findLibrary(final String libraryName) {
String fileName = System.mapLibraryName(libraryName);
File soFile = archive.findLibrary(fileName);
if (soFile != null) {
return soFile.getAbsolutePath();
}
try {
return (String) AtlasHacks.ClassLoader_findLibrary.invoke(Framework.systemClassLoader, libraryName);
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
public void addRuntimeDependency(String bundleName){
if(dependencies==null){
dependencies = new ArrayList<String>();
}
if(!dependencies.contains(bundleName)){
AtlasBundleInfoManager.instance().getBundleInfo(location).addRuntimeDependency(bundleName);
dependencies.add(bundleName);
}
}
/**
* get a string representation of the object.
*
* @return a string.
* @category Object
* @see java.lang.Object#toString()
*/
public String toString() {
return "BundleClassLoader[Bundle" + bundle + "]";
}
/*
* static methods
*/
/**
* read a property from the manifest attributes.
*
* @param attrs the attributes.
* @param property the name of the property to read.
* @return the values.
* @throws BundleException if the manifest has an empty value for the key.
*/
private static String[] readProperty(final Attributes attrs, final String property) throws BundleException {
final String values = attrs.getValue(property);
if (values != null && values.equals("")) {
// throw new BundleException("Broken manifest, " + property + " is empty.");
return new String[0];
}
return splitString(values);
}
private static String[] splitString(final String values) {
if (values == null) {
return new String[0];
}
final StringTokenizer tokenizer = new StringTokenizer(values, ",");
if (tokenizer.countTokens() == 0) {
return new String[]{values};
}
final String[] result = new String[tokenizer.countTokens()];
for (int i = 0; i < result.length; i++) {
result[i] = tokenizer.nextToken().trim();
}
return result;
}
/**
* strip trailing spaces.
*
* @param filename the file name.
* @return the stripped file name.
*/
private static String stripTrailing(final String filename) {
return (filename.startsWith("/") || filename.startsWith("\\")) ? filename.substring(1) : filename;
}
/**
* get the package of a class.
*
* @param classname
* @return the package.
*/
private static String packageOf(final String classname) {
final int pos = classname.lastIndexOf('.');
return pos > -1 ? classname.substring(0, pos) : "";
}
/**
* create a pseudo classname from a file.
*
* @param filename the filename.
* @return the pseudo classname.
*/
private static String pseudoClassname(final String filename) {
return stripTrailing(filename).replace('.', '-').replace('/', '.').replace('\\', '.');
}
public interface ClassLoadListener{
public void onClassLoaded(Class clazz);
}
}