Move methods from DefaultCallbackAnalyzer to AndroidEntryPointUtils

Author: stefanie-koss

soot-infoflow-android/src/soot/jimple/infoflow/android/callbacks/DefaultCallbackAnalyzer.java

@@ -2,8 +2,6 @@
 
 import java.io.IOException;
 import java.util.ArrayList;
-import java.util.Collection;
-import java.util.Collections;
 import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
@@ -26,7 +24,6 @@
 import soot.jimple.infoflow.android.callbacks.filters.ICallbackFilter;
 import soot.jimple.infoflow.android.entryPointCreators.AndroidEntryPointConstants;
 import soot.jimple.infoflow.android.entryPointCreators.AndroidEntryPointUtils;
-import soot.jimple.infoflow.android.entryPointCreators.AndroidEntryPointUtils.ComponentType;
 import soot.jimple.infoflow.memory.IMemoryBoundedSolver;
 import soot.jimple.infoflow.memory.ISolverTerminationReason;
 import soot.jimple.infoflow.util.SystemClassHandler;
@@ -97,7 +94,7 @@ protected void internalTransform(String phaseName, @SuppressWarnings("rawtypes")
 							break;
 
 						List<MethodOrMethodContext> methods = new ArrayList<MethodOrMethodContext>(
-								getLifecycleMethods(sc));
+								entryPointUtils.getLifecycleMethods(sc));
 
 						// Check for callbacks registered in the code
 						analyzeRechableMethods(sc, methods);
@@ -155,77 +152,6 @@ protected void internalTransform(String phaseName, @SuppressWarnings("rawtypes")
 		PackManager.v().getPack("wjtp").add(transform);
 	}
 
-	/**
-	 * Gets all lifecycle methods in the given entry point class
-	 * 
-	 * @param sc The class in which to look for lifecycle methods
-	 * @return The set of lifecycle methods in the given class
-	 */
-	private Collection<? extends MethodOrMethodContext> getLifecycleMethods(SootClass sc) {
-		return getLifecycleMethods(entryPointUtils.getComponentType(sc), sc);
-	}
-
-	/**
-	 * Gets all lifecycle methods in the given entry point class
-	 * 
-	 * @param componentType the component type
-	 * @param sc            The class in which to look for lifecycle methods
-	 * @return The set of lifecycle methods in the given class
-	 */
-	public static Collection<? extends MethodOrMethodContext> getLifecycleMethods(ComponentType componentType,
-			SootClass sc) {
-		switch (componentType) {
-		case Activity:
-			return getLifecycleMethods(sc, AndroidEntryPointConstants.getActivityLifecycleMethods());
-		case Service:
-			return getLifecycleMethods(sc, AndroidEntryPointConstants.getServiceLifecycleMethods());
-		case Application:
-			return getLifecycleMethods(sc, AndroidEntryPointConstants.getApplicationLifecycleMethods());
-		case BroadcastReceiver:
-			return getLifecycleMethods(sc, AndroidEntryPointConstants.getBroadcastLifecycleMethods());
-		case Fragment:
-			return getLifecycleMethods(sc, AndroidEntryPointConstants.getFragmentLifecycleMethods());
-		case ContentProvider:
-			return getLifecycleMethods(sc, AndroidEntryPointConstants.getContentproviderLifecycleMethods());
-		case GCMBaseIntentService:
-			return getLifecycleMethods(sc, AndroidEntryPointConstants.getGCMIntentServiceMethods());
-		case GCMListenerService:
-			return getLifecycleMethods(sc, AndroidEntryPointConstants.getGCMListenerServiceMethods());
-		case ServiceConnection:
-			return getLifecycleMethods(sc, AndroidEntryPointConstants.getServiceConnectionMethods());
-		case Plain:
-			return Collections.emptySet();
-		}
-		return Collections.emptySet();
-	}
-
-	/**
-	 * This method takes a lifecycle class and the list of lifecycle method
-	 * subsignatures. For each subsignature, it checks whether the given class or
-	 * one of its superclass overwrites the respective methods. All findings are
-	 * collected in a set and returned.
-	 * 
-	 * @param sc      The class in which to look for lifecycle method
-	 *                implementations
-	 * @param methods The list of lifecycle method subsignatures for the type of
-	 *                component that the given class corresponds to
-	 * @return The set of implemented lifecycle methods in the given class
-	 */
-	private static Collection<? extends MethodOrMethodContext> getLifecycleMethods(SootClass sc, List<String> methods) {
-		Set<MethodOrMethodContext> lifecycleMethods = new HashSet<>();
-		SootClass currentClass = sc;
-		while (currentClass != null) {
-			for (String sig : methods) {
-				SootMethod sm = currentClass.getMethodUnsafe(sig);
-				if (sm != null)
-					if (!SystemClassHandler.v().isClassInSystemPackage(sm.getDeclaringClass().getName()))
-						lifecycleMethods.add(sm);
-			}
-			currentClass = currentClass.hasSuperclass() ? currentClass.getSuperclass() : null;
-		}
-		return lifecycleMethods;
-	}
-
 	private void analyzeRechableMethods(SootClass lifecycleElement, List<MethodOrMethodContext> methods) {
 		// Make sure to exclude all other edges in the callgraph except for the
 		// edges start in the lifecycle methods we explicitly pass in

soot-infoflow-android/src/soot/jimple/infoflow/android/entryPointCreators/AndroidEntryPointUtils.java

@@ -1,15 +1,22 @@
 package soot.jimple.infoflow.android.entryPointCreators;
 
+import java.util.Collection;
+import java.util.Collections;
 import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
 import java.util.Map;
+import java.util.Set;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import soot.FastHierarchy;
+import soot.MethodOrMethodContext;
 import soot.Scene;
 import soot.SootClass;
 import soot.SootMethod;
+import soot.jimple.infoflow.util.SystemClassHandler;
 
 /**
  * Class containing common utility methods for dealing with Android entry points
@@ -184,4 +191,75 @@ public boolean isEntryPointMethod(SootMethod method) {
 		return false;
 	}
 
+	/**
+	 * Gets all lifecycle methods in the given entry point class
+	 * 
+	 * @param sc The class in which to look for lifecycle methods
+	 * @return The set of lifecycle methods in the given class
+	 */
+	public Collection<? extends MethodOrMethodContext> getLifecycleMethods(SootClass sc) {
+		return getLifecycleMethods(getComponentType(sc), sc);
+	}
+
+	/**
+	 * Gets all lifecycle methods in the given entry point class
+	 * 
+	 * @param componentType the component type
+	 * @param sc            The class in which to look for lifecycle methods
+	 * @return The set of lifecycle methods in the given class
+	 */
+	public static Collection<? extends MethodOrMethodContext> getLifecycleMethods(ComponentType componentType,
+			SootClass sc) {
+		switch (componentType) {
+		case Activity:
+			return getLifecycleMethods(sc, AndroidEntryPointConstants.getActivityLifecycleMethods());
+		case Service:
+			return getLifecycleMethods(sc, AndroidEntryPointConstants.getServiceLifecycleMethods());
+		case Application:
+			return getLifecycleMethods(sc, AndroidEntryPointConstants.getApplicationLifecycleMethods());
+		case BroadcastReceiver:
+			return getLifecycleMethods(sc, AndroidEntryPointConstants.getBroadcastLifecycleMethods());
+		case Fragment:
+			return getLifecycleMethods(sc, AndroidEntryPointConstants.getFragmentLifecycleMethods());
+		case ContentProvider:
+			return getLifecycleMethods(sc, AndroidEntryPointConstants.getContentproviderLifecycleMethods());
+		case GCMBaseIntentService:
+			return getLifecycleMethods(sc, AndroidEntryPointConstants.getGCMIntentServiceMethods());
+		case GCMListenerService:
+			return getLifecycleMethods(sc, AndroidEntryPointConstants.getGCMListenerServiceMethods());
+		case ServiceConnection:
+			return getLifecycleMethods(sc, AndroidEntryPointConstants.getServiceConnectionMethods());
+		case Plain:
+			return Collections.emptySet();
+		}
+		return Collections.emptySet();
+	}
+
+	/**
+	 * This method takes a lifecycle class and the list of lifecycle method
+	 * subsignatures. For each subsignature, it checks whether the given class or
+	 * one of its superclass overwrites the respective methods. All findings are
+	 * collected in a set and returned.
+	 * 
+	 * @param sc      The class in which to look for lifecycle method
+	 *                implementations
+	 * @param methods The list of lifecycle method subsignatures for the type of
+	 *                component that the given class corresponds to
+	 * @return The set of implemented lifecycle methods in the given class
+	 */
+	private static Collection<? extends MethodOrMethodContext> getLifecycleMethods(SootClass sc, List<String> methods) {
+		Set<MethodOrMethodContext> lifecycleMethods = new HashSet<>();
+		SootClass currentClass = sc;
+		while (currentClass != null) {
+			for (String sig : methods) {
+				SootMethod sm = currentClass.getMethodUnsafe(sig);
+				if (sm != null)
+					if (!SystemClassHandler.v().isClassInSystemPackage(sm.getDeclaringClass().getName()))
+						lifecycleMethods.add(sm);
+			}
+			currentClass = currentClass.hasSuperclass() ? currentClass.getSuperclass() : null;
+		}
+		return lifecycleMethods;
+	}
+
 }