Not running upgrade logic when app starts

- Run the DB upgrade on PRE_BOOT_COMPLETED like other system providers.
  (e.g. ag/52589, ag/129329)
- Do not run DB operation, which may trigger upgrade, in TvProvider.onCreate.

Bug: 27615817
Change-Id: I5a034ce20e5c01fc89539eac1f76dd4a3d5a3103

3 files changed, 119 insertions, 5 deletions

diff --git a/AndroidManifest.xml b/AndroidManifest.xml
index b7637ce..7f94aea 100644
--- a/AndroidManifest.xml
+++ b/AndroidManifest.xml
@@ -70,5 +70,15 @@
         </provider>
 
         <service android:name="EpgDataCleanupService" />
+
+        <!-- Handles database upgrades after OTAs -->
+        <receiver android:name="TvProviderUpgradeReceiver">
+            <!-- This broadcast is sent after the core system has finished
+                 booting, before the home app is launched or BOOT_COMPLETED
+                 is sent. -->
+            <intent-filter>
+                <action android:name="android.intent.action.PRE_BOOT_COMPLETED"/>
+            </intent-filter>
+        </receiver>
     </application>
 </manifest>
diff --git a/src/com/android/providers/tv/TvProvider.java b/src/com/android/providers/tv/TvProvider.java
index 9664354..c8c8dd3 100644
--- a/src/com/android/providers/tv/TvProvider.java
+++ b/src/com/android/providers/tv/TvProvider.java
@@ -81,7 +81,7 @@ public class TvProvider extends ContentProvider {
     private static final String OP_UPDATE = "update";
     private static final String OP_DELETE = "delete";
 
-    private static final int DATABASE_VERSION = 29;
+    static final int DATABASE_VERSION = 29;
     private static final String DATABASE_NAME = "tv.db";
     private static final String CHANNELS_TABLE = "channels";
     private static final String PROGRAMS_TABLE = "programs";
@@ -378,8 +378,17 @@ public class TvProvider extends ContentProvider {
             + RecordedPrograms.COLUMN_INTERNAL_PROVIDER_FLAG4 + " INTEGER,"
             + RecordedPrograms.COLUMN_VERSION_NUMBER + " INTEGER);";
 
-    private static class DatabaseHelper extends SQLiteOpenHelper {
-        DatabaseHelper(Context context) {
+    static class DatabaseHelper extends SQLiteOpenHelper {
+        private static DatabaseHelper sSingleton = null;
+
+        public static synchronized DatabaseHelper getInstance(Context context) {
+            if (sSingleton == null) {
+                sSingleton = new DatabaseHelper(context);
+            }
+            return sSingleton;
+        }
+
+        private DatabaseHelper(Context context) {
             super(context, DATABASE_NAME, null, DATABASE_VERSION);
         }
 
@@ -561,6 +570,7 @@ public class TvProvider extends ContentProvider {
                         Programs.COLUMN_EPISODE_DISPLAY_NUMBER);
                 oldVersion = 29;
             }
+            Log.i(TAG, "Upgrading from version " + oldVersion + " to " + newVersion + " is done.");
         }
 
         private static void migrateIntegerColumnToTextColumn(SQLiteDatabase db, String table,
@@ -580,10 +590,18 @@ public class TvProvider extends ContentProvider {
         if (DEBUG) {
             Log.d(TAG, "Creating TvProvider");
         }
-        mOpenHelper = new DatabaseHelper(getContext());
-        deleteUnconsolidatedWatchedProgramsRows();
+        mOpenHelper = DatabaseHelper.getInstance(getContext());
         scheduleEpgDataCleanup();
         buildGenreMap();
+
+        // DB operation, which may trigger upgrade, should not happen in onCreate.
+        new AsyncTask<Object, Object, Object>() {
+            @Override
+            protected Object doInBackground(Object... params) {
+                deleteUnconsolidatedWatchedProgramsRows();
+                return null;
+            }
+        }.execute();
         return true;
     }
 
diff --git a/src/com/android/providers/tv/TvProviderUpgradeReceiver.java b/src/com/android/providers/tv/TvProviderUpgradeReceiver.java
new file mode 100644
index 0000000..36d48dc
--- /dev/null
+++ b/src/com/android/providers/tv/TvProviderUpgradeReceiver.java
@@ -0,0 +1,86 @@
+/*
+ * Copyright (C) 2016 The Android Open Source 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.providers.tv;
+
+import android.app.ActivityManagerNative;
+import android.content.BroadcastReceiver;
+import android.content.ComponentName;
+import android.content.Context;
+import android.content.Intent;
+import android.content.SharedPreferences;
+import android.content.pm.PackageManager;
+import android.os.RemoteException;
+import android.util.EventLog;
+import android.util.Log;
+
+import com.android.providers.tv.TvProvider.DatabaseHelper;
+
+/**
+ * This will be launched during system boot, after the core system has
+ * been brought up but before any non-persistent processes have been
+ * started.  It is launched in a special state, with no content provider
+ * or custom application class associated with the process running.
+ *
+ * It's job is to prime the tv provider database. Either create it
+ * if it doesn't exist, or open it and force any necessary upgrades.
+ * All of this heavy lifting happens before the boot animation ends.
+ */
+public class TvProviderUpgradeReceiver extends BroadcastReceiver {
+    static final String TAG = "TvProviderUpgradeReceiver";
+    static final String PREF_DB_VERSION = "db_version";
+
+    @Override
+    public void onReceive(Context context, Intent intent) {
+        // We are now running with the system up, but no apps started,
+        // so can do whatever cleanup after an upgrade that we want.
+
+        try {
+            long startTime = System.currentTimeMillis();
+
+            // Lookup the last known database version
+            SharedPreferences prefs = context.getSharedPreferences(TAG, Context.MODE_PRIVATE);
+            int prefVersion = prefs.getInt(PREF_DB_VERSION, 0);
+
+            // If the version is old go ahead and attempt to create or upgrade the database.
+            if (prefVersion != TvProvider.DATABASE_VERSION) {
+                // Store the current version so this receiver isn't run again until the database
+                // version number changes. This is intentionally done even before the upgrade path
+                // is attempted to be conservative. If the upgrade fails for some reason and we
+                // crash and burn we don't want to get into a loop doing so.
+                prefs.edit().putInt(PREF_DB_VERSION, TvProvider.DATABASE_VERSION).commit();
+
+                // Ask for a reference to the database to force the helper to either
+                // create the database or open it up, performing any necessary upgrades
+                // in the process.
+                DatabaseHelper helper = DatabaseHelper.getInstance(context);
+                if (context.getDatabasePath(helper.getDatabaseName()).exists()) {
+                    Log.i(TAG, "Creating or opening tv provider database");
+                    helper.getWritableDatabase();
+                }
+                helper.close();
+            }
+        } catch (Throwable t) {
+            // Something has gone terribly wrong. Disable this receiver for good so we can't
+            // possibly end up in a reboot loop.
+            Log.wtf(TAG, "Error during upgrade attempt. Disabling receiver.", t);
+            context.getPackageManager().setComponentEnabledSetting(
+                    new ComponentName(context, getClass()),
+                    PackageManager.COMPONENT_ENABLED_STATE_DISABLED,
+                    PackageManager.DONT_KILL_APP);
+        }
+    }
+}