mirror of
https://github.com/moparisthebest/k-9
synced 2024-12-25 00:58:50 -05:00
Add file missing in last commit
This commit is contained in:
parent
b2098c8d1c
commit
fcc9e37f66
232
src/com/fsck/k9/service/DatabaseUpgradeService.java
Normal file
232
src/com/fsck/k9/service/DatabaseUpgradeService.java
Normal file
@ -0,0 +1,232 @@
|
||||
package com.fsck.k9.service;
|
||||
|
||||
import java.util.concurrent.atomic.AtomicBoolean;
|
||||
|
||||
import android.app.Service;
|
||||
import android.content.Context;
|
||||
import android.content.Intent;
|
||||
import android.os.IBinder;
|
||||
import android.os.PowerManager;
|
||||
import android.support.v4.content.LocalBroadcastManager;
|
||||
import android.util.Log;
|
||||
|
||||
import com.fsck.k9.Account;
|
||||
import com.fsck.k9.K9;
|
||||
import com.fsck.k9.Preferences;
|
||||
import com.fsck.k9.activity.UpgradeDatabases;
|
||||
import com.fsck.k9.helper.power.TracingPowerManager;
|
||||
import com.fsck.k9.helper.power.TracingPowerManager.TracingWakeLock;
|
||||
import com.fsck.k9.mail.store.UnavailableStorageException;
|
||||
|
||||
/**
|
||||
* Service used to upgrade the accounts' databases and/or track the progress of the upgrade.
|
||||
*
|
||||
* <p>
|
||||
* See {@link UpgradeDatabases} for a detailed explanation of the database upgrade process.
|
||||
* </p>
|
||||
*/
|
||||
public class DatabaseUpgradeService extends Service {
|
||||
/**
|
||||
* Broadcast intent reporting the current progress of the database upgrade.
|
||||
*
|
||||
* <p>Extras:</p>
|
||||
* <ul>
|
||||
* <li>{@link #EXTRA_ACCOUNT_UUID}</li>
|
||||
* <li>{@link #EXTRA_PROGRESS}</li>
|
||||
* <li>{@link #EXTRA_PROGRESS_END}</li>
|
||||
* </ul>
|
||||
*/
|
||||
public static final String ACTION_UPGRADE_PROGRESS = "DatabaseUpgradeService.upgradeProgress";
|
||||
|
||||
/**
|
||||
* Broadcast intent sent when the upgrade has been completed.
|
||||
*/
|
||||
public static final String ACTION_UPGRADE_COMPLETE = "DatabaseUpgradeService.upgradeComplete";
|
||||
|
||||
/**
|
||||
* UUID of the account whose database is currently being upgraded.
|
||||
*/
|
||||
public static final String EXTRA_ACCOUNT_UUID = "account_uuid";
|
||||
|
||||
/**
|
||||
* The current progress.
|
||||
*
|
||||
* <p>Integer from {@code 0} (inclusive) to the value in {@link #EXTRA_PROGRESS_END}
|
||||
* (exclusive).</p>
|
||||
*/
|
||||
public static final String EXTRA_PROGRESS = "progress";
|
||||
|
||||
/**
|
||||
* Number of items that will be upgraded.
|
||||
*
|
||||
* <p>Currently this is the number of accounts.</p>
|
||||
*/
|
||||
public static final String EXTRA_PROGRESS_END = "progress_end";
|
||||
|
||||
|
||||
/**
|
||||
* Action used to start this service.
|
||||
*/
|
||||
private static final String ACTION_START_SERVICE =
|
||||
"com.fsck.k9.service.DatabaseUpgradeService.startService";
|
||||
|
||||
private static final String WAKELOCK_TAG = "DatabaseUpgradeService";
|
||||
private static final long WAKELOCK_TIMEOUT = 10 * 60 * 1000; // 10 minutes
|
||||
|
||||
|
||||
/**
|
||||
* Start {@link DatabaseUpgradeService}.
|
||||
*
|
||||
* @param context
|
||||
* The {@link Context} used to start this service.
|
||||
*/
|
||||
public static void startService(Context context) {
|
||||
Intent i = new Intent();
|
||||
i.setClass(context, DatabaseUpgradeService.class);
|
||||
i.setAction(DatabaseUpgradeService.ACTION_START_SERVICE);
|
||||
context.startService(i);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Stores whether or not this service was already running when
|
||||
* {@link #onStartCommand(Intent, int, int)} is executed.
|
||||
*/
|
||||
private AtomicBoolean mRunning = new AtomicBoolean(false);
|
||||
|
||||
private LocalBroadcastManager mLocalBroadcastManager;
|
||||
|
||||
private String mAccountUuid;
|
||||
private int mProgress;
|
||||
private int mProgressEnd;
|
||||
|
||||
private TracingWakeLock mWakeLock;
|
||||
|
||||
|
||||
@Override
|
||||
public IBinder onBind(Intent intent) {
|
||||
// unused
|
||||
return null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void onCreate() {
|
||||
super.onCreate();
|
||||
|
||||
mLocalBroadcastManager = LocalBroadcastManager.getInstance(this);
|
||||
}
|
||||
|
||||
@Override
|
||||
public final int onStartCommand(Intent intent, int flags, int startId) {
|
||||
boolean success = mRunning.compareAndSet(false, true);
|
||||
if (success) {
|
||||
// The service wasn't running yet.
|
||||
|
||||
if (K9.DEBUG) {
|
||||
Log.i(K9.LOG_TAG, "DatabaseUpgradeService started");
|
||||
}
|
||||
|
||||
acquireWakelock();
|
||||
|
||||
startUpgradeInBackground();
|
||||
} else {
|
||||
// We're already running, so don't start the upgrade process again. But send the current
|
||||
// progress via broadcast.
|
||||
sendProgressBroadcast(mAccountUuid, mProgress, mProgressEnd);
|
||||
}
|
||||
|
||||
return START_STICKY;
|
||||
}
|
||||
|
||||
/**
|
||||
* Acquire a partial wake lock so the CPU won't go to sleep when the screen is turned off.
|
||||
*/
|
||||
private void acquireWakelock() {
|
||||
TracingPowerManager pm = TracingPowerManager.getPowerManager(this);
|
||||
mWakeLock = pm.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, WAKELOCK_TAG);
|
||||
mWakeLock.setReferenceCounted(false);
|
||||
mWakeLock.acquire(WAKELOCK_TIMEOUT);
|
||||
}
|
||||
|
||||
/**
|
||||
* Release the wake lock.
|
||||
*/
|
||||
private void releaseWakelock() {
|
||||
mWakeLock.release();
|
||||
}
|
||||
|
||||
/**
|
||||
* Stop this service.
|
||||
*/
|
||||
private void stopService() {
|
||||
stopSelf();
|
||||
|
||||
if (K9.DEBUG) {
|
||||
Log.i(K9.LOG_TAG, "DatabaseUpgradeService stopped");
|
||||
}
|
||||
|
||||
releaseWakelock();
|
||||
mRunning.set(false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Start a background thread for upgrading the databases.
|
||||
*/
|
||||
private void startUpgradeInBackground() {
|
||||
new Thread("DatabaseUpgradeService") {
|
||||
@Override
|
||||
public void run() {
|
||||
upgradeDatabases();
|
||||
stopService();
|
||||
}
|
||||
}.start();
|
||||
}
|
||||
|
||||
/**
|
||||
* Upgrade the accounts' databases.
|
||||
*/
|
||||
private void upgradeDatabases() {
|
||||
Preferences preferences = Preferences.getPreferences(this);
|
||||
|
||||
Account[] accounts = preferences.getAccounts();
|
||||
mProgressEnd = accounts.length;
|
||||
mProgress = 0;
|
||||
|
||||
for (Account account : accounts) {
|
||||
mAccountUuid = account.getUuid();
|
||||
|
||||
sendProgressBroadcast(mAccountUuid, mProgress, mProgressEnd);
|
||||
|
||||
try {
|
||||
// Account.getLocalStore() is blocking and will upgrade the database if necessary
|
||||
account.getLocalStore();
|
||||
} catch (UnavailableStorageException e) {
|
||||
Log.e(K9.LOG_TAG, "Database unavailable");
|
||||
} catch (Exception e) {
|
||||
Log.e(K9.LOG_TAG, "Error while upgrading database", e);
|
||||
}
|
||||
|
||||
mProgress++;
|
||||
}
|
||||
|
||||
K9.setDatabasesUpToDate(true);
|
||||
sendUpgradeCompleteBroadcast();
|
||||
}
|
||||
|
||||
private void sendProgressBroadcast(String accountUuid, int progress, int progressEnd) {
|
||||
Intent intent = new Intent();
|
||||
intent.setAction(ACTION_UPGRADE_PROGRESS);
|
||||
intent.putExtra(EXTRA_ACCOUNT_UUID, accountUuid);
|
||||
intent.putExtra(EXTRA_PROGRESS, progress);
|
||||
intent.putExtra(EXTRA_PROGRESS_END, progressEnd);
|
||||
|
||||
mLocalBroadcastManager.sendBroadcast(intent);
|
||||
}
|
||||
|
||||
private void sendUpgradeCompleteBroadcast() {
|
||||
Intent intent = new Intent();
|
||||
intent.setAction(ACTION_UPGRADE_COMPLETE);
|
||||
|
||||
mLocalBroadcastManager.sendBroadcast(intent);
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue
Block a user