summaryrefslogtreecommitdiffstats
path: root/src/com/android/launcher3/stats/internal
diff options
context:
space:
mode:
Diffstat (limited to 'src/com/android/launcher3/stats/internal')
-rw-r--r--src/com/android/launcher3/stats/internal/db/DatabaseHelper.java159
-rw-r--r--src/com/android/launcher3/stats/internal/db/TrackingEventContract.java31
-rw-r--r--src/com/android/launcher3/stats/internal/model/CountAction.java73
-rw-r--r--src/com/android/launcher3/stats/internal/model/CountOriginByPackageAction.java91
-rw-r--r--src/com/android/launcher3/stats/internal/model/ITrackingAction.java45
-rw-r--r--src/com/android/launcher3/stats/internal/model/TrackingEvent.java204
-rw-r--r--src/com/android/launcher3/stats/internal/service/AggregationIntentService.java232
7 files changed, 835 insertions, 0 deletions
diff --git a/src/com/android/launcher3/stats/internal/db/DatabaseHelper.java b/src/com/android/launcher3/stats/internal/db/DatabaseHelper.java
new file mode 100644
index 000000000..7ffd509ff
--- /dev/null
+++ b/src/com/android/launcher3/stats/internal/db/DatabaseHelper.java
@@ -0,0 +1,159 @@
+package com.android.launcher3.stats.internal.db;
+
+import android.content.ContentValues;
+import android.content.Context;
+import android.database.Cursor;
+import android.database.sqlite.SQLiteDatabase;
+import android.database.sqlite.SQLiteOpenHelper;
+import com.android.launcher3.stats.internal.model.TrackingEvent;
+import com.android.launcher3.stats.util.Logger;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * <pre>
+ * Helper for accessing the database
+ * </pre>
+ *
+ * @see {@link SQLiteOpenHelper}
+ */
+public class DatabaseHelper extends SQLiteOpenHelper {
+
+ // Constants
+ private static final String TAG = DatabaseHelper.class.getSimpleName();
+ private static final String DATABASE_NAME = "events";
+ private static final int DATABASE_VERSION = 1;
+
+ // Instance
+ private static DatabaseHelper sInstance = null;
+
+ /**
+ * Constructor
+ *
+ * @param context {@link Context}
+ * @return {@link DatabaseHelper}
+ * @throws IllegalArgumentException {@link IllegalArgumentException}
+ */
+ public static DatabaseHelper createInstance(Context context) throws IllegalArgumentException {
+ if (sInstance == null) {
+ sInstance = new DatabaseHelper(context);
+ }
+ return sInstance;
+ }
+
+ /**
+ * Constructor
+ *
+ * @param context {@link Context}
+ */
+ public DatabaseHelper(Context context) {
+ super(context, DATABASE_NAME, null, DATABASE_VERSION);
+ }
+
+ /**
+ * Write an event to the database
+ *
+ * @param trackingEvent {@link TrackingEvent}
+ * @throws IllegalArgumentException {@link IllegalArgumentException}
+ */
+ public void writeEvent(TrackingEvent trackingEvent)
+ throws IllegalArgumentException {
+ if (trackingEvent == null) {
+ throw new IllegalArgumentException("'trackingEvent' cannot be null!");
+ }
+ Logger.logd(TAG, "Event written to database: " + trackingEvent);
+ SQLiteDatabase db = getWritableDatabase();
+ ContentValues contentValues = trackingEvent.toContentValues();
+ db.insert(TrackingEventContract.EVENT_TABLE_NAME, null, contentValues);
+ db.close();
+ }
+
+ /**
+ * Get a list of tracking events
+ *
+ * @param instanceId {@link Integer}
+ * @return {@link List}
+ * @throws IllegalArgumentException {@link IllegalArgumentException}
+ */
+ public List<TrackingEvent> getTrackingEventsByCategory(int instanceId,
+ TrackingEvent.Category category) throws IllegalArgumentException {
+ if (category == null) {
+ throw new IllegalArgumentException("'category' cannot be null!");
+ }
+
+ List<TrackingEvent> eventList = new ArrayList<TrackingEvent>();
+
+ // Get a writable database
+ SQLiteDatabase db = getWritableDatabase();
+
+ // Update unclaimed items for this instance
+ ContentValues contentValues = new ContentValues();
+ contentValues.put(TrackingEventContract.EVENT_COLUMN_INSTANCE, instanceId);
+ String whereClause = TrackingEventContract.EVENT_COLUMN_INSTANCE + " IS NULL AND "
+ + TrackingEventContract.EVENT_COLUMN_CATEGORY + " = ? ";
+ String[] whereArgs = new String[] {
+ category.name(),
+ };
+ int cnt = db.update(TrackingEventContract.EVENT_TABLE_NAME, contentValues, whereClause,
+ whereArgs);
+
+ // Short circuit empty update
+ if (cnt < 1) {
+ return eventList;
+ }
+
+ // Select all tagged items
+ String selection = TrackingEventContract.EVENT_COLUMN_CATEGORY + " = ? AND "
+ + TrackingEventContract.EVENT_COLUMN_INSTANCE + " = ? ";
+ String[] selectionArgs = new String[]{
+ category.name(),
+ String.valueOf(instanceId),
+ };
+ Cursor c = db.query(TrackingEventContract.EVENT_TABLE_NAME, null, selection, selectionArgs,
+ null, null, null);
+
+ // Build return list
+ while (c != null && c.getCount() > 0 && c.moveToNext()) {
+ eventList.add(new TrackingEvent(c));
+ }
+
+ db.close();
+
+ return eventList;
+ }
+
+ /**
+ * Deletes events related to the instance
+ *
+ * @param instanceId {@link Integer}
+ * @return {@link Integer}
+ */
+ public int deleteEventsByInstanceId(int instanceId) {
+ SQLiteDatabase db = getWritableDatabase();
+ String whereClause = TrackingEventContract.EVENT_COLUMN_INSTANCE + " = ?";
+ String[] whereArgs = new String[]{
+ String.valueOf(instanceId),
+ };
+ int cnt = db.delete(TrackingEventContract.EVENT_TABLE_NAME, whereClause, whereArgs);
+ db.close();
+ return cnt;
+ }
+
+ @Override
+ public void onCreate(SQLiteDatabase db) {
+ db.execSQL(TrackingEventContract.CREATE_EVENT_TABLE);
+ }
+
+ @Override
+ public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
+
+ // [NOTE][MSB]: This will lose data, need to make sure this is handled if/when database
+ // schema changes
+
+ // db.execSQL("DROP TABLE IF EXISTS " + TrackingEventContract.EVENT_TABLE_NAME);
+ // onCreate(db);
+
+ }
+
+}
diff --git a/src/com/android/launcher3/stats/internal/db/TrackingEventContract.java b/src/com/android/launcher3/stats/internal/db/TrackingEventContract.java
new file mode 100644
index 000000000..481a43193
--- /dev/null
+++ b/src/com/android/launcher3/stats/internal/db/TrackingEventContract.java
@@ -0,0 +1,31 @@
+package com.android.launcher3.stats.internal.db;
+
+import android.provider.BaseColumns;
+
+/**
+ * <pre>
+ * Table contract definition
+ * </pre>
+ *
+ * @see {@link BaseColumns}
+ */
+public class TrackingEventContract implements BaseColumns {
+
+ // Constants
+ public static final String EVENT_TABLE_NAME = "event";
+
+ // Columns
+ public static final String EVENT_COLUMN_CATEGORY = "category";
+ public static final String EVENT_COLUMN_METADATA = "metadata";
+ public static final String EVENT_COLUMN_INSTANCE = "instance";
+
+ // SQL
+ public static final String CREATE_EVENT_TABLE = "CREATE TABLE " + EVENT_TABLE_NAME
+ + " ( "
+ + " `" + _ID + "` INTEGER PRIMARY KEY AUTOINCREMENT, "
+ + " `" + EVENT_COLUMN_CATEGORY + "` TEXT, "
+ + " `" + EVENT_COLUMN_METADATA + "` TEXT, "
+ + " `" + EVENT_COLUMN_INSTANCE + "` INTEGER "
+ + ");";
+
+}
diff --git a/src/com/android/launcher3/stats/internal/model/CountAction.java b/src/com/android/launcher3/stats/internal/model/CountAction.java
new file mode 100644
index 000000000..d509d4d26
--- /dev/null
+++ b/src/com/android/launcher3/stats/internal/model/CountAction.java
@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) 2015. The CyanogenMod Project
+ *
+ * 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 com.android.launcher3.stats.internal.model;
+
+import android.os.Bundle;
+import android.text.TextUtils;
+import com.android.launcher3.stats.external.TrackingBundle;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * <pre>
+ * Handles the specific for sending a tracking event
+ * </pre>
+ *
+ * @see {@link ITrackingAction}
+ */
+public class CountAction implements ITrackingAction {
+
+ public static final String TRACKING_ACTION = "count";
+
+ @Override
+ public String toString() {
+ return TRACKING_ACTION;
+ }
+
+ @Override
+ public List<Bundle> createTrackingBundles(String trackingId, TrackingEvent.Category category,
+ List<TrackingEvent> eventList) {
+
+ Map<String, List<TrackingEvent>> eventPackageMap =
+ new HashMap<String, List<TrackingEvent>>();
+
+ for (TrackingEvent event : eventList) {
+ String pkg = event.getMetaData(TrackingEvent.KEY_PACKAGE);
+ pkg = (TextUtils.isEmpty(pkg)) ? trackingId : pkg;
+ if (!eventPackageMap.containsKey(pkg)) {
+ eventPackageMap.put(pkg, new ArrayList<TrackingEvent>());
+ }
+ eventPackageMap.get(pkg).add(event);
+ }
+
+ List<Bundle> bundleList = new ArrayList<Bundle>();
+ for (Map.Entry<String, List<TrackingEvent>> entry : eventPackageMap.entrySet()) {
+ Bundle bundle = TrackingBundle.createTrackingBundle(trackingId, category.name(),
+ TRACKING_ACTION);
+ bundle.putInt(TrackingBundle.KEY_METADATA_VALUE, entry.getValue().size());
+ String pkg = entry.getKey();
+ if (!pkg.equals(trackingId)) {
+ bundle.putString(TrackingBundle.KEY_METADATA_PACKAGE, pkg);
+ }
+ bundleList.add(bundle);
+ }
+ return bundleList;
+ }
+}
diff --git a/src/com/android/launcher3/stats/internal/model/CountOriginByPackageAction.java b/src/com/android/launcher3/stats/internal/model/CountOriginByPackageAction.java
new file mode 100644
index 000000000..fc04ca088
--- /dev/null
+++ b/src/com/android/launcher3/stats/internal/model/CountOriginByPackageAction.java
@@ -0,0 +1,91 @@
+/*
+ * Copyright (c) 2015. The CyanogenMod Project
+ *
+ * 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 com.android.launcher3.stats.internal.model;
+
+import android.os.Bundle;
+import android.text.TextUtils;
+import com.android.launcher3.stats.external.TrackingBundle;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * <pre>
+ * This is an action to send a count of events with common origins
+ * </pre>
+ */
+public class CountOriginByPackageAction implements ITrackingAction {
+
+ public static final String TRACKING_ACTION = "count_by_origin";
+
+ @Override
+ public String toString() {
+ return TRACKING_ACTION;
+ }
+
+ @Override
+ public List<Bundle> createTrackingBundles(String trackingId, TrackingEvent.Category category,
+ List<TrackingEvent> eventList) {
+ // Make an origin mapper
+ Map<String, Map<String, List<TrackingEvent>>> originEventMap =
+ new HashMap<String, Map<String, List<TrackingEvent>>>();
+
+ // Parse the event list and categorize by origin
+ for (TrackingEvent event : eventList) {
+ // We are parsing for things with origin, if no origin is set, discard it!
+ if (TextUtils.isEmpty(event.getMetaData(TrackingEvent.KEY_ORIGIN))) {
+ continue;
+ }
+ String originKey = event.getMetaData(TrackingEvent.KEY_ORIGIN);
+ if (!originEventMap.containsKey(originKey)) {
+ HashMap<String, List<TrackingEvent>> newMap =
+ new HashMap<String, List<TrackingEvent>>();
+ originEventMap.put(originKey, newMap);
+ }
+ String packageName = event.getMetaData(TrackingEvent.KEY_PACKAGE);
+ // Set a default so our iteration picks it up and just discard package metadata
+ packageName = (TextUtils.isEmpty(packageName)) ? trackingId : packageName;
+ if (!originEventMap.get(originKey).containsKey(packageName)) {
+ originEventMap.get(originKey).put(packageName, new ArrayList<TrackingEvent>());
+ }
+ originEventMap.get(originKey).get(packageName).add(event);
+ }
+
+ // Start building result tracking bundles
+ List<Bundle> bundleList = new ArrayList<Bundle>();
+ for (Map.Entry<String, Map<String, List<TrackingEvent>>> entry :
+ originEventMap.entrySet()) {
+ String origin = entry.getKey();
+ for (Map.Entry<String, List<TrackingEvent>> entry2 : entry.getValue().entrySet()) {
+ String pkg = entry2.getKey();
+ List<TrackingEvent> events = entry2.getValue();
+ Bundle bundle = TrackingBundle.createTrackingBundle(trackingId, category.name(),
+ TRACKING_ACTION);
+ bundle.putString(TrackingBundle.KEY_METADATA_ORIGIN, origin);
+ bundle.putInt(TrackingBundle.KEY_METADATA_VALUE, events.size());
+ if (!trackingId.equals(pkg)) {
+ bundle.putString(TrackingBundle.KEY_METADATA_PACKAGE, pkg);
+ }
+ bundleList.add(bundle);
+ }
+ }
+ return bundleList;
+ }
+
+}
diff --git a/src/com/android/launcher3/stats/internal/model/ITrackingAction.java b/src/com/android/launcher3/stats/internal/model/ITrackingAction.java
new file mode 100644
index 000000000..b577ed2d0
--- /dev/null
+++ b/src/com/android/launcher3/stats/internal/model/ITrackingAction.java
@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2015. The CyanogenMod Project
+ *
+ * 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 com.android.launcher3.stats.internal.model;
+
+import android.os.Bundle;
+
+import java.util.List;
+
+/**
+ * <pre>
+ * This is an action we want to perfrom from a report.
+ *
+ * e.g.
+ * 1. I want to get the COUNT of widgets added
+ * 2. I want to get the origin of app launches
+ * </pre>
+ */
+public interface ITrackingAction {
+
+ /**
+ * Creates a new bundle used to tracking events
+ *
+ * @param trackingId {@link String}
+ * @param category {@link com.android.launcher3.stats.internal.model.TrackingEvent.Category}
+ * @param eventList {@link List}
+ * @return {@link List}
+ */
+ List<Bundle> createTrackingBundles(String trackingId, TrackingEvent.Category category,
+ List<TrackingEvent> eventList);
+
+}
diff --git a/src/com/android/launcher3/stats/internal/model/TrackingEvent.java b/src/com/android/launcher3/stats/internal/model/TrackingEvent.java
new file mode 100644
index 000000000..91a9017be
--- /dev/null
+++ b/src/com/android/launcher3/stats/internal/model/TrackingEvent.java
@@ -0,0 +1,204 @@
+/*
+ * Copyright (c) 2015. The CyanogenMod Project
+ *
+ * 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 com.android.launcher3.stats.internal.model;
+
+import android.content.ContentValues;
+import android.database.Cursor;
+import android.os.Bundle;
+import android.text.TextUtils;
+import android.util.Log;
+import com.android.launcher3.stats.external.TrackingBundle;
+import com.android.launcher3.stats.internal.db.TrackingEventContract;
+import com.android.launcher3.stats.util.Logger;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * <pre>
+ * Model of an event to track
+ * </pre>
+ */
+public class TrackingEvent {
+
+ // Constants
+ private static final String TAG = TrackingEvent.class.getSimpleName();
+
+ // Members
+ private Category mCategory;
+ private final Map<String, String> mMetaData = new HashMap<String, String>();
+
+ public enum Category {
+ APP_LAUNCH,
+ WIDGET_ADD,
+ WIDGET_REMOVE,
+ SETTINGS_OPEN,
+ WALLPAPER_CHANGE,
+ HOMESCREEN_PAGE,
+ WIDGET,
+ }
+
+ public static final String KEY_ORIGIN = TrackingBundle.KEY_METADATA_ORIGIN;
+ public static final String KEY_VALUE = TrackingBundle.KEY_METADATA_VALUE;
+ public static final String KEY_PACKAGE = TrackingBundle.KEY_METADATA_PACKAGE;
+
+ /**
+ * Constructor
+ *
+ * @param category {@link TrackingEvent.Category}
+ * @throws IllegalArgumentException {@link IllegalArgumentException}
+ */
+ public TrackingEvent(Category category) throws IllegalArgumentException {
+ if (category == null) {
+ throw new IllegalArgumentException("'category' cannot be null or empty!");
+ }
+ mCategory = category;
+ }
+
+ /**
+ * Constructor
+ *
+ * @param cursor {@link Cursor}
+ * @throws IllegalArgumentException {@link IllegalArgumentException}
+ */
+ public TrackingEvent(Cursor cursor) throws IllegalArgumentException {
+ if (cursor == null) {
+ throw new IllegalArgumentException("'cursor' cannot be null!");
+ }
+ mCategory = Category.valueOf(cursor.getString(cursor.getColumnIndex(
+ TrackingEventContract.EVENT_COLUMN_CATEGORY)));
+ String metadata = cursor.getString(cursor.getColumnIndex(
+ TrackingEventContract.EVENT_COLUMN_METADATA));
+ if (!TextUtils.isEmpty(metadata)) {
+ String[] parts = metadata.split(",");
+ for (String part : parts) {
+ try {
+ String key = part.split("=")[0];
+ String val = part.split("=")[1];
+ mMetaData.put(key, val);
+ } catch (IndexOutOfBoundsException e) {
+ Log.w(TAG, e.getMessage(), e);
+ }
+ }
+ }
+ }
+
+ /**
+ * Get the category
+ *
+ * @return {@link TrackingEvent.Category}
+ */
+ public Category getCategory() {
+ return mCategory;
+ }
+
+ /**
+ * Get the set of meta data keys
+ *
+ * @return {@link Set}
+ */
+ public Set<String> getMetaDataKeySet() {
+ return mMetaData.keySet();
+ }
+
+ /**
+ * Set some meta data
+ *
+ * @param key {@link String}
+ * @param value {@link String}
+ * @throws IllegalArgumentException {@link IllegalArgumentException}
+ */
+ public void setMetaData(String key, String value) throws IllegalArgumentException {
+ if (TextUtils.isEmpty(key)) {
+ throw new IllegalArgumentException("'key' cannot be null or empty!");
+ }
+ if (TextUtils.isEmpty(value)) {
+ throw new IllegalArgumentException("'value' cannot be null or empty!");
+ }
+ mMetaData.put(key, value);
+ }
+
+ /**
+ * Get some meta data value
+ *
+ * @param key {@link String}
+ * @return {@link String}
+ * @throws IllegalArgumentException {@link IllegalArgumentException}
+ */
+ public String getMetaData(String key) throws IllegalArgumentException {
+ if (TextUtils.isEmpty(key)) {
+ throw new IllegalArgumentException("'key' cannot be null or empty!");
+ }
+ if (mMetaData.containsKey(key)) {
+ return mMetaData.get(key);
+ }
+ return null;
+ }
+
+ /**
+ * Remove some meta data
+ *
+ * @param key {@link String}
+ * @return {@link String} or null
+ * @throws IllegalArgumentException {@link IllegalArgumentException}
+ */
+ public String removeMetaData(String key) throws IllegalArgumentException {
+ if (TextUtils.isEmpty(key)) {
+ throw new IllegalArgumentException("'key' cannot be null or empty!");
+ }
+ if (mMetaData.containsKey(key)) {
+ return mMetaData.remove(key);
+ }
+ return null;
+ }
+
+ /**
+ * Converts this object into content values for use with sqlite
+ *
+ * @return {@link ContentValues}
+ */
+ public ContentValues toContentValues() {
+ ContentValues contentValues = new ContentValues();
+ contentValues.put(TrackingEventContract.EVENT_COLUMN_CATEGORY, mCategory.name());
+ StringBuilder sb = new StringBuilder();
+ for (String key : mMetaData.keySet()) {
+ sb.append(key).append("=").append(mMetaData.get(key)).append(",");
+ }
+ if (sb.length() > 0) {
+ String metadata = sb.toString();
+ metadata = metadata.substring(0, metadata.length() - 1);
+ Logger.logd(TAG, "MetaData: " + metadata);
+ contentValues.put(TrackingEventContract.EVENT_COLUMN_METADATA, metadata);
+ }
+ return contentValues;
+ }
+
+ /**
+ * Convert this object into a tracking bundle
+ *
+ * @param trackingId {@link String}
+ * @param action {@link ITrackingAction}
+ * @return {@link Bundle}
+ */
+ public Bundle toTrackingBundle(String trackingId, ITrackingAction action) {
+ Bundle bundle = TrackingBundle.createTrackingBundle(trackingId, mCategory.name(),
+ action.toString());
+ return bundle;
+ }
+
+}
diff --git a/src/com/android/launcher3/stats/internal/service/AggregationIntentService.java b/src/com/android/launcher3/stats/internal/service/AggregationIntentService.java
new file mode 100644
index 000000000..cd9eaf793
--- /dev/null
+++ b/src/com/android/launcher3/stats/internal/service/AggregationIntentService.java
@@ -0,0 +1,232 @@
+/*
+ * Copyright (c) 2015. The CyanogenMod Project
+ *
+ * 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 com.android.launcher3.stats.internal.service;
+
+import android.app.AlarmManager;
+import android.app.IntentService;
+import android.app.PendingIntent;
+import android.content.ComponentName;
+import android.content.Context;
+import android.content.Intent;
+import android.content.IntentFilter;
+import android.content.SharedPreferences;
+import android.content.pm.PackageManager;
+import android.os.Bundle;
+import android.preference.PreferenceManager;
+import android.util.Log;
+import com.android.launcher3.LauncherAppState;
+import com.android.launcher3.LauncherApplication;
+import com.android.launcher3.stats.external.StatsUtil;
+import com.android.launcher3.stats.external.TrackingBundle;
+import com.android.launcher3.stats.internal.db.DatabaseHelper;
+import com.android.launcher3.stats.internal.model.CountAction;
+import com.android.launcher3.stats.internal.model.CountOriginByPackageAction;
+import com.android.launcher3.stats.internal.model.ITrackingAction;
+import com.android.launcher3.stats.internal.model.TrackingEvent;
+import com.android.launcher3.stats.util.Logger;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * <pre>
+ * Service that starts on a timer and handles aggregating events and sending them to
+ * CyanogenStats
+ * </pre>
+ *
+ * @see {@link IntentService}
+ */
+public class AggregationIntentService extends IntentService {
+
+ // Constants
+ private static final String TAG = AggregationIntentService.class.getSimpleName();
+ private static final String TRACKING_ID = "com.cyanogenmod.trebuchet";
+ public static final String ACTION_AGGREGATE_AND_TRACK =
+ "com.cyanogenmod.trebuchet.AGGREGATE_AND_TRACK";
+ private static final List<ITrackingAction> TRACKED_ACTIONS = new ArrayList<ITrackingAction>() {
+ {
+ add(new CountAction());
+ add(new CountOriginByPackageAction());
+ }
+ };
+ private static final int INVALID_COUNT = -1;
+ private static final String KEY_LAST_TIME_RAN = "last_time_stats_ran";
+ public static final String PREF_KEY_PAGE_COUNT = "page_count";
+ public static final String PREF_KEY_WIDGET_COUNT = "widget_count";
+
+ // Members
+ private DatabaseHelper mDatabaseHelper = null;
+ private int mInstanceId = -1;
+ private SharedPreferences mPrefs = null;
+
+ /**
+ * Creates an IntentService. Invoked by your subclass's constructor.
+ */
+ public AggregationIntentService() {
+ super(AggregationIntentService.class.getSimpleName());
+ }
+
+ @Override
+ protected void onHandleIntent(Intent intent) {
+ if (!isTrebuchetDefaultLauncher()) {
+ // Cancel repeating schedule
+ unscheduleService();
+ // don't return b/c we still want to upload whatever metrics are left.
+ }
+ String action = intent.getAction();
+ if (ACTION_AGGREGATE_AND_TRACK.equals(action)) {
+ mPrefs = getSharedPreferences(LauncherAppState.getSharedPreferencesKey(),
+ Context.MODE_PRIVATE);
+ mPrefs.edit().putLong(KEY_LAST_TIME_RAN, System.currentTimeMillis()).apply();
+ mInstanceId = (int) System.currentTimeMillis();
+ mDatabaseHelper = DatabaseHelper.createInstance(this);
+ performAggregation();
+ deleteTrackingEventsForInstance();
+ handleNonEventMetrics();
+ }
+ }
+
+ private void performAggregation() {
+
+ // Iterate available categories
+ for (TrackingEvent.Category category : TrackingEvent.Category.values()) {
+
+ // Fetch the events from the database based on the category
+ List<TrackingEvent> eventList =
+ mDatabaseHelper.getTrackingEventsByCategory(mInstanceId, category);
+
+ Logger.logd(TAG, "Event list size: " + eventList.size());
+ // Short circuit if no events for the category
+ if (eventList.size() < 1) {
+ continue;
+ }
+
+ // Now crunch the data into actionable events for the server
+ for (ITrackingAction action : TRACKED_ACTIONS) {
+ try {
+ for (Bundle bundle : action.createTrackingBundles(TRACKING_ID, category,
+ eventList)) {
+ performTrackingCall(bundle);
+ }
+ } catch (NullPointerException e) {
+ Log.e(TAG, "NPE fetching bundle list!", e);
+ } catch (IllegalArgumentException e) {
+ Log.e(TAG, "Illegal argument!", e);
+ }
+ }
+
+ }
+ }
+
+ private void deleteTrackingEventsForInstance() {
+ mDatabaseHelper.deleteEventsByInstanceId(mInstanceId);
+ }
+
+ /**
+ * These are metrics that are not event based and need a snapshot every INTERVAL
+ */
+ private void handleNonEventMetrics() {
+ sendPageCountStats();
+ sendWidgetCountStats();
+
+ }
+
+ private void sendPageCountStats() {
+ int pageCount = mPrefs.getInt(PREF_KEY_PAGE_COUNT, INVALID_COUNT);
+ if (pageCount == INVALID_COUNT) {
+ return;
+ }
+ Bundle bundle = TrackingBundle
+ .createTrackingBundle(TRACKING_ID, TrackingEvent.Category.HOMESCREEN_PAGE.name(),
+ "count");
+ bundle.putString(TrackingEvent.KEY_VALUE, String.valueOf(pageCount));
+ StatsUtil.sendEvent(this, bundle);
+ }
+
+ private void sendWidgetCountStats() {
+ int widgetCount = mPrefs.getInt(PREF_KEY_WIDGET_COUNT, INVALID_COUNT);
+ if (widgetCount == INVALID_COUNT) {
+ return;
+ }
+ Bundle bundle = TrackingBundle
+ .createTrackingBundle(TRACKING_ID, TrackingEvent.Category.WIDGET.name(), "count");
+ bundle.putString(TrackingEvent.KEY_VALUE, String.valueOf(widgetCount));
+ StatsUtil.sendEvent(this, bundle);
+ }
+
+ private void performTrackingCall(Bundle bundle) throws IllegalArgumentException {
+ StatsUtil.sendEvent(this, bundle);
+ }
+
+ private void unscheduleService() {
+ Intent intent = new Intent(this, AggregationIntentService.class);
+ intent.setAction(ACTION_AGGREGATE_AND_TRACK);
+ PendingIntent pi = PendingIntent.getService(this, 0, intent,
+ PendingIntent.FLAG_UPDATE_CURRENT);
+ AlarmManager alarmManager = (AlarmManager) this.getSystemService(Context.ALARM_SERVICE);
+ alarmManager.cancel(pi);
+ }
+
+ private boolean isTrebuchetDefaultLauncher() {
+ final IntentFilter filter = new IntentFilter(Intent.ACTION_MAIN);
+ filter.addCategory(Intent.CATEGORY_HOME);
+
+ List<IntentFilter> filters = new ArrayList<IntentFilter>();
+ filters.add(filter);
+
+ final String myPackageName = getPackageName();
+ List<ComponentName> activities = new ArrayList<ComponentName>();
+ final PackageManager packageManager = getPackageManager();
+
+ // You can use name of your package here as third argument
+ packageManager.getPreferredActivities(filters, activities, null);
+
+ for (ComponentName activity : activities) {
+ if (myPackageName.equals(activity.getPackageName())) {
+ Logger.logd(TAG, "Trebuchet IS default launcher!");
+ return true;
+ }
+ }
+ Logger.logd(TAG, "Trebuchet IS NOT default launcher!");
+ return false;
+ }
+
+ private static final long ALARM_INTERVAL = 86400000; // 1 day
+
+ /**
+ * Schedule an alarm service, will cancel existing
+ *
+ * @param context {@link Context}
+ * @throws IllegalArgumentException {@link IllegalArgumentException}
+ */
+ public static void scheduleService(Context context) throws IllegalArgumentException {
+ if (context == null) {
+ throw new IllegalArgumentException("'context' cannot be null!");
+ }
+ SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(context);
+ long lastTimeRan = prefs.getLong(KEY_LAST_TIME_RAN, 0);
+ Intent intent = new Intent(context, AggregationIntentService.class);
+ intent.setAction(ACTION_AGGREGATE_AND_TRACK);
+ PendingIntent pi = PendingIntent.getService(context, 0, intent,
+ PendingIntent.FLAG_UPDATE_CURRENT);
+ AlarmManager alarmManager = (AlarmManager) context.getSystemService(Context.ALARM_SERVICE);
+ alarmManager.cancel(pi);
+ alarmManager.setRepeating(AlarmManager.RTC_WAKEUP, lastTimeRan + ALARM_INTERVAL,
+ ALARM_INTERVAL, pi);
+ }
+
+}