+ * Monitor an android activity. Call this class via + * AndroidMonitor.getInstanceOfAndroidMonitor().startMonitor(this); at the end of the + * onCreate(Bundle savedInstanceState) method. + *
+ * + * @author Florian Unger + * @version 1.0 + */ +public class AndroidMonitor { + + /** + *+ * Name of the Activity that starts the monitor. + *
+ */ + String activityName; + + /** + *+ * Represents the operations to the log file. + *
+ */ + private AndroidMonitorLogFile logFile; + + /** + * Constructor method to get a monitor object. + * + * @return monitor + */ + public static AndroidMonitor getInstanceOfAndroidMonitor() { + AndroidMonitor monitor = new AndroidMonitor(); + return monitor; + } + + /** + * starts tracking an activity + * + * @param activity + */ + public void startMonitor(Activity activity) { + activityName = activity.getClass().getSimpleName(); + + logFile = new AndroidMonitorLogFile(getAppLable(activity), activity.getFilesDir()); + + addLogListenerToView(getRootView(activity)); + + // TODO + // listen to changes and update own listener + // find out if it is possible to directly call addLogListenerToView + // again + // activity.onContentChanged(); + + // write backPresss as event to xml file + // activity.onBackPressed(); + + // handle onStop() method of the activity + // add a function that end up tracking if onStop() is given otherwise + // create onStop() + // http://developer.android.com/training/basics/activity-lifecycle/stopping.html + } + + /** + * get the root view of an activity + * + * @param activity + * @return + */ + public View getRootView(Activity activity) { + // get root view of the activity as start point + View view = activity.getWindow().getDecorView().getRootView(); + // try out if the given node is the upper one in the tree and return the + // first node of the tree + // The root of the decorView could be embedded into another layout + // element. + return findFirstView(view); + } + + /** + * returns first view element of the tree + * + * @param view + * @return + */ + private View findFirstView(View view) { + if (view.getParent() != null && (view.getParent() instanceof ViewGroup)) { + return findFirstView((View) view.getParent()); + } + else { + return view; + } + } + + /** + * Replace the listener of each view with a composite listener which collects several listeners + * for one view. + * + * @param view + * to be monitored + */ + public void addLogListenerToView(View view) { + addLogListenerToView(view, 0); + } + + /** + * Replace the listener of each view with a composite listener which collects several listeners + * for one view. + * + * @param view + * to be monitored + * @param parentHash + * hash of the parent view element + */ + private void addLogListenerToView(View view, int parentHash) { + + if (!logFile.isComponentLogged(view.hashCode())) { + logFile.addComponent(view, parentHash, activityName); + } + + // hash code of the actual view element. Problem in using + // view.getParent().hashCode() is described in + // de.ugoe.cs.autoquest.androidmonitor#addComponent() + parentHash = view.hashCode(); + // traverse all views of the activity + if (view instanceof ViewGroup) { + ViewGroup group = (ViewGroup) view; + for (int i = 0; i < group.getChildCount(); i++) { + View child = group.getChildAt(i); + addLogListenerToView(child, parentHash); + } + } + + // save original listener to add it later on to the groupLisatener + View.OnClickListener onClickListener = getOnClickListener(view); + + if (onClickListener != null) { + // create new compositeOnClickListener to handle multiple listeners + // for one view + AndroidMonitorCompositeOnClickListener groupListener = + new AndroidMonitorCompositeOnClickListener(); + // replace the original onClickListener with the + // compositeOnClickListener + view.setOnClickListener(groupListener); + // add the tracking part as a several listener + groupListener.addOnClickListener(new View.OnClickListener() { + public void onClick(View v) { + + logFile.addEvent(v, "onClick"); + } + }); + + groupListener.addOnClickListener(onClickListener); + } + // if view is a TextView add a addTextChangedListener to this view + if (view instanceof TextView) { + final int hashOfView = view.hashCode(); + TextView textView = (TextView) view; + textView.addTextChangedListener(new TextWatcher() { + public void beforeTextChanged(CharSequence s, int start, int count, int after) { + // do nothing + } + + public void onTextChanged(CharSequence s, int start, int before, int count) { + // do nothing + } + + public void afterTextChanged(Editable s) { + logFile.addEvent(hashOfView, "text", s.toString()); + } + + }); + } + } + + /** + * finds out if a listener exists + * + * @param view + * @return the listener of the view or null if no listener exists + */ + public View.OnClickListener getOnClickListener(View view) { + // http://stackoverflow.com/questions/11186960/getonclicklistener-in-android-views + if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.ICE_CREAM_SANDWICH) { + return getOnClickListenerV14(view); + } + else { + return getOnClickListenerV(view); + } + } + + // Used for APIs lower than ICS (API 14) + private View.OnClickListener getOnClickListenerV(View view) { + View.OnClickListener retrievedListener = null; + String viewStr = "android.view.View"; + Field field; + + try { + field = Class.forName(viewStr).getDeclaredField("mOnClickListener"); + retrievedListener = (View.OnClickListener) field.get(view); + } + catch (NoSuchFieldException ex) { + Log.e("Reflection", "No Such Field."); + } + catch (IllegalAccessException ex) { + Log.e("Reflection", "Illegal Access."); + } + catch (ClassNotFoundException ex) { + Log.e("Reflection", "Class Not Found."); + } + + return retrievedListener; + } + + // Used for new ListenerInfo class structure used beginning with API 14 + // (ICS) + private View.OnClickListener getOnClickListenerV14(View view) { + View.OnClickListener retrievedListener = null; + String viewStr = "android.view.View"; + String lInfoStr = "android.view.View$ListenerInfo"; + + try { + Field listenerField = Class.forName(viewStr).getDeclaredField("mListenerInfo"); + Object listenerInfo = null; + + if (listenerField != null) { + listenerField.setAccessible(true); + listenerInfo = listenerField.get(view); + } + + Field clickListenerField = Class.forName(lInfoStr).getDeclaredField("mOnClickListener"); + + if (clickListenerField != null && listenerInfo != null) { + retrievedListener = (View.OnClickListener) clickListenerField.get(listenerInfo); + } + } + catch (NoSuchFieldException ex) { + Log.e("Reflection", "No Such Field."); + } + catch (IllegalAccessException ex) { + Log.e("Reflection", "Illegal Access."); + } + catch (ClassNotFoundException ex) { + Log.e("Reflection", "Class Not Found."); + } + + return retrievedListener; + } + + /** + * get application name as defined in Package Name + * + * @param pContext + * package context; could also be an activity + * @return app name + */ + public String getAppLable(Context pContext) { + // source (2014-09-04): + // http://stackoverflow.com/questions/11229219/android-get-application-name-not-package-name + PackageManager lPackageManager = pContext.getPackageManager(); + ApplicationInfo lApplicationInfo = null; + try { + lApplicationInfo = + lPackageManager.getApplicationInfo(pContext.getApplicationInfo().packageName, 0); + } + catch (final NameNotFoundException e) {} + return (String) (lApplicationInfo != null ? lPackageManager + .getApplicationLabel(lApplicationInfo) : "Unknown"); + } +} Index: /trunk/autoquest-androidmonitor/src/main/java/de/ugoe/cs/autoquest/androidmonitor/AndroidMonitorCompositeOnClickListener.java =================================================================== --- /trunk/autoquest-androidmonitor/src/main/java/de/ugoe/cs/autoquest/androidmonitor/AndroidMonitorCompositeOnClickListener.java (revision 1833) +++ /trunk/autoquest-androidmonitor/src/main/java/de/ugoe/cs/autoquest/androidmonitor/AndroidMonitorCompositeOnClickListener.java (revision 1833) @@ -0,0 +1,87 @@ +// Copyright 2012 Georg-August-Universität Göttingen, Germany +// +// 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 de.ugoe.cs.autoquest.androidmonitor; + +import java.util.ArrayList; +import java.util.List; + +import android.view.View; + +/** + *+ * TODO comment + *
+ * + * @author Florian Unger + * @version 1.0 + */ +public class AndroidMonitorCompositeOnClickListener implements + View.OnClickListener { + + /** + *+ * Save all listeners which belongs to a single view in a list. + *
+ */ + private List+ * Constructor. Creates a new AndroidMonitorCompositeOnClickListener. + *
+ * + */ + public AndroidMonitorCompositeOnClickListener() { + listeners = new ArrayList+ * Add a listener to a single view. + *
+ * + * @param listener + */ + public void addOnClickListener(View.OnClickListener listener) { + listeners.add(listener); + } + + /* (non-Javadoc) + * @see android.view.View.OnClickListener#onClick(android.view.View) + */ + public void onClick(View v) { + for (View.OnClickListener listener : listeners) { + listener.onClick(v); + } + } +} + +/* +* (non-Javadoc) +* In Android it is not possible to have multiple onCliclListener for one view. +* This is also stated in +* http://books.google.de/books?id=bKo_1uED72EC&pg=PA178&lpg +* =PA178&dq=android+setonclicklistener +* +call+old+listener&source=bl&ots=g45T5ikRVK +* &sig=blIqJGMywqJEGNATe3WW5DZyS6M&hl +* =de&sa=X&ei=cl3rU6_8Ec2KOIzqgNgM&ved=0CEYQ6AEwBA +* #v=onepage&q=android%20setonclicklistener%20call%20old%20listener&f=false +* +* Therefore it is necessary to have a custom class to handle a single onClick() +* and pass in handlers for it to call. +* http://stackoverflow.com/questions/7587299 +* /android-multi-onclick-listener-in-one-button +*/ Index: /trunk/autoquest-androidmonitor/src/main/java/de/ugoe/cs/autoquest/androidmonitor/AndroidMonitorLogFile.java =================================================================== --- /trunk/autoquest-androidmonitor/src/main/java/de/ugoe/cs/autoquest/androidmonitor/AndroidMonitorLogFile.java (revision 1833) +++ /trunk/autoquest-androidmonitor/src/main/java/de/ugoe/cs/autoquest/androidmonitor/AndroidMonitorLogFile.java (revision 1833) @@ -0,0 +1,493 @@ +// Copyright 2012 Georg-August-Universität Göttingen, Germany +// +// 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 de.ugoe.cs.autoquest.androidmonitor; + +import java.io.File; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.StringWriter; +import java.util.ArrayList; +import java.util.List; + +import org.xmlpull.v1.XmlSerializer; + +import android.util.Log; +import android.util.Xml; +import android.view.View; +import android.view.ViewGroup; + +/** + *+ * TODO comment + *
+ * + * @author Florian Unger + * @version 1.0 + */ +public class AndroidMonitorLogFile { + + /** + *+ * Name of the log file which is stored in the internal space of the device. + *
+ */ + private String name; + + /** + *+ * File representation to store monitored information. + *
+ */ + private File file; + + /** + *+ * List representing all components which was written to log file before. + *
+ */ + private List+ * Constructor. Creates a new AndroidmonitorLogFile. + *
+ * + * @param appName + * Name of the calling application. + * @param dir + * Folder to store the log file. + */ + public AndroidMonitorLogFile(String appName, File dir) { + + currentLoggedComponents = new ArrayList+ * Get file name which is in use. + *
+ * + * @return filename + */ + public String getFileName() { + return this.name; + } + + /** + * + *+ * Writes information about the application to the log file. + *
+ * + */ + private void setAppInformation() { + // TODO create app information in the same manner as coded in + // getDeviceInformation + + } + + /** + *+ * Query device information and store it to log file. + *
+ * + */ + private void setDeviceInformation() { + + XmlSerializer serializer = Xml.newSerializer(); + StringWriter writer = new StringWriter(); + try { + serializer.setOutput(writer); + serializer.startTag("", "device"); + serializer.startTag("", "param"); + serializer.attribute("", "value", "" + + android.os.Build.VERSION.SDK_INT); + serializer.attribute("", "name", "sdk_version"); + serializer.endTag("", "param"); + + serializer.startTag("", "param"); + serializer.attribute("", "value", android.os.Build.DEVICE); + serializer.attribute("", "name", "device"); + serializer.endTag("", "param"); + + serializer.startTag("", "param"); + serializer.attribute("", "value", android.os.Build.MANUFACTURER); + serializer.attribute("", "name", "manufacturer"); + serializer.endTag("", "param"); + + serializer.startTag("", "param"); + serializer.attribute("", "value", android.os.Build.MODEL); + serializer.attribute("", "name", "model"); + serializer.endTag("", "param"); + + // TODO get resolution ... + + serializer.endTag("", "device"); + serializer.endDocument(); + + writeToFile(writer.toString()); + + } catch (IllegalArgumentException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + Log.e("file", "outputstream: " + e.getMessage()); + } catch (IllegalStateException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + Log.e("file", "outputstream: " + e.getMessage()); + } catch (IOException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + Log.e("file", "outputstream: " + e.getMessage()); + } + + + } + + /** + *+ * Adds some information of an component of an activity (view) to the file. + *
+ * + * @param view + * view to be logged + * @param parentHash + * hash of the parent view + * @param activityName + * name of the activity that is analyzed + */ + public void addComponent(View view, int parentHash, String activityName) { + XmlSerializer serializer = Xml.newSerializer(); + StringWriter writer = new StringWriter(); + + try { + serializer.setOutput(writer); + serializer.startTag("", "component"); + // TODO find a way in that the hash code is unique over time and + // target + /* + * (non-Javadoc) view.getId() seems to be unique over time and + * targets but there is a problem. In some cases there is no ID + * (value: -1). + */ + serializer.attribute("", "hash", "" + view.hashCode()); + + + serializer.startTag("", "param"); + serializer.attribute("", "name", "id"); + serializer.attribute("", "value", "" + view.getId()); + serializer.endTag("", "param"); + + serializer.startTag("", "param"); + serializer.attribute("", "name", "path"); + serializer.attribute("", "value", activityName + "/" + + getViewPath(view) + view.getClass().getSimpleName()); + serializer.endTag("", "param"); + + serializer.startTag("", "param"); + serializer.attribute("", "name", "class"); + serializer.attribute("", "value", view.getClass().getName()); + serializer.endTag("", "param"); + + serializer.startTag("", "param"); + serializer.attribute("", "name", "parent"); + // Problem in using view.getParent().hashCode(): + // http://developer.android.com/reference/android/view/View.html#getParent() + // tells: "... parent is a ViewParent and not necessarily a View." + // ViewParent does not have a method hashCode(). Solution is done + // add parentHash as parameter to method addComponent() and + // Androidmonitor-> addLogListenerToView. + serializer.attribute("", "value", "" + parentHash); + serializer.endTag("", "param"); + + // TODO add title e.g. android:text="Button" + + serializer.startTag("", "ancestors"); + + Class classobject = view.getClass(); + + while((classobject != null)){ + serializer.startTag("", "ancestor"); + serializer.attribute("", "name", classobject.getName()); + serializer.endTag("", "ancestor"); + classobject = classobject.getSuperclass(); + } + serializer.endTag("", "ancestors"); + + serializer.endTag("", "component"); + serializer.endDocument(); + + writeToFile(writer.toString()); + + } catch (IllegalArgumentException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + Log.e("file", "outputstream: " + e.getMessage()); + } catch (IllegalStateException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + Log.e("file", "outputstream: " + e.getMessage()); + } catch (IOException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + Log.e("file", "outputstream: " + e.getMessage()); + } + + } + + /** + *+ * Add an event to the log file + *
+ * + * @param hash + * hash value of the calling view of the listener + * @param type + * the type of listener e.g. textView ... + * @param message + * message typed in + */ + public void addEvent(int hash, String type, String message){ + XmlSerializer serializer = Xml.newSerializer(); + StringWriter writer = new StringWriter(); + + try { + serializer.setOutput(writer); + + serializer.startTag("", "event"); + serializer.attribute("", "id", type); + + serializer.startTag("", "param"); + serializer.attribute("", "value", "" + hash); + serializer.attribute("", "name", "source"); + serializer.endTag("", "param"); + + serializer.startTag("", "param"); + serializer.attribute("", "value", message); + serializer.attribute("", "name", "message"); + serializer.endTag("", "param"); + + serializer.startTag("", "param"); + serializer.attribute("", "value", "" + System.currentTimeMillis()); + serializer.attribute("", "name", "timestamp"); + serializer.endTag("", "param"); + + serializer.endTag("", "event"); + serializer.endDocument(); + + writeToFile(writer.toString()); + } catch (IllegalArgumentException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + Log.e("file", "outputstream: " + e.getMessage()); + } catch (IllegalStateException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + Log.e("file", "outputstream: " + e.getMessage()); + } catch (IOException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + Log.e("file", "outputstream: " + e.getMessage()); + } + } + + /** + *+ * Add an event to the log file + *
+ * + * @param view + * the calling view of the listener + * @param type + * the type of listener e.g. onClick ... + */ + public void addEvent(View view, String type) { + + String x = "" + view.getX(); + String y = "" + view.getY(); + + XmlSerializer serializer = Xml.newSerializer(); + StringWriter writer = new StringWriter(); + + try { + serializer.setOutput(writer); + + serializer.startTag("", "event"); + serializer.attribute("", "id", type); + + serializer.startTag("", "param"); + serializer.attribute("", "value", x); + serializer.attribute("", "name", "X"); + serializer.endTag("", "param"); + + serializer.startTag("", "param"); + serializer.attribute("", "value", y); + serializer.attribute("", "name", "Y"); + serializer.endTag("", "param"); + + serializer.startTag("", "param"); + serializer.attribute("", "value", "" + view.hashCode()); + serializer.attribute("", "name", "source"); + serializer.endTag("", "param"); + + serializer.startTag("", "param"); + serializer.attribute("", "value", "" + System.currentTimeMillis()); + serializer.attribute("", "name", "timestamp"); + serializer.endTag("", "param"); + + serializer.endTag("", "event"); + serializer.endDocument(); + + writeToFile(writer.toString()); + } catch (IllegalArgumentException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + Log.e("file", "outputstream: " + e.getMessage()); + } catch (IllegalStateException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + Log.e("file", "outputstream: " + e.getMessage()); + } catch (IOException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + Log.e("file", "outputstream: " + e.getMessage()); + } + } + + /** + *+ * Writes given information to the file. e.g. previous produced XML + * statements. + *
+ * + * @param data + * content to add to the file + */ + private void writeToFile(String data) { + + FileOutputStream outputStream; + try { + outputStream = new FileOutputStream(file, true); + outputStream.write(data.getBytes()); + outputStream.close(); + } catch (FileNotFoundException e) { + e.printStackTrace(); + Log.e("file", "outputstream: " + e.getMessage()); + } catch (IOException e) { + e.printStackTrace(); + Log.e("file", "outputstream: " + e.getMessage()); + } + + } + + /** + *+ * Generates the path of an view element. + *
+ * + * @param view + * @return path path to the element + */ + private String getViewPath(View view) { + return getViewPath(view, null); + } + + /** + *+ * Generates the path of an view element. + *
+ * + * @param view + * @param path + * @return path path to the element + */ + private String getViewPath(View view, String path) { + if (path == null) { + path = ""; + } else { + path = view.getClass().getSimpleName() + "/" + path; + } + if (view.getParent() != null && (view.getParent() instanceof ViewGroup)) { + return getViewPath((View) view.getParent(), path); + } else { + return path; + } + } + + /** + * + *+ * Check whether a component is still written to log file. + *
+ * + * @param hashCode + * hash code of the view + * @return + */ + public Boolean isComponentLogged(Integer hashCode){ + return currentLoggedComponents.contains(hashCode); + } + + +}