From 18adc8799d9fa4d5b063fb52eb2e3fe88e2374a8 Mon Sep 17 00:00:00 2001 From: Tim Su Date: Sat, 9 May 2009 18:19:05 +0000 Subject: [PATCH] Removed static properties from Synchronizer class so controller overrides are not propagated. --- src/com/timsu/astrid/activities/TaskList.java | 12 +-- .../activities/TaskListSubActivity.java | 11 ++- .../timsu/astrid/sync/RTMSyncProvider.java | 4 +- .../astrid/sync/SynchronizationProvider.java | 30 ++++--- .../astrid/sync/SynchronizationService.java | 23 ++++- src/com/timsu/astrid/sync/Synchronizer.java | 86 ++++++++++++------- 6 files changed, 111 insertions(+), 55 deletions(-) diff --git a/src/com/timsu/astrid/activities/TaskList.java b/src/com/timsu/astrid/activities/TaskList.java index b020fa8eb..987385e01 100644 --- a/src/com/timsu/astrid/activities/TaskList.java +++ b/src/com/timsu/astrid/activities/TaskList.java @@ -37,6 +37,7 @@ import android.widget.ViewFlipper; import com.timsu.astrid.R; import com.timsu.astrid.data.tag.TagController; import com.timsu.astrid.data.task.TaskController; +import com.timsu.astrid.sync.SynchronizationService; import com.timsu.astrid.sync.Synchronizer; import com.timsu.astrid.utilities.Constants; import com.timsu.astrid.utilities.StartupReceiver; @@ -109,8 +110,6 @@ public class TaskList extends Activity { taskController.open(); tagController = new TagController(this); tagController.open(); - Synchronizer.setTagController(tagController); - Synchronizer.setTaskController(taskController); setupUIComponents(); @@ -128,7 +127,12 @@ public class TaskList extends Activity { // sync now if requested if(synchronizeNow) { synchronizeNow = false; - Synchronizer.synchronize(this, false, null); + Synchronizer sync = new Synchronizer(false); + sync.setTagController(tagController); + sync.setTaskController(taskController); + sync.synchronize(this, null); + } else { + SynchronizationService.start(); } // if we have no filter tag, we're not on the last task @@ -344,7 +348,5 @@ public class TaskList extends Activity { super.onDestroy(); taskController.close(); tagController.close(); - Synchronizer.setTagController(null); - Synchronizer.setTaskController(null); } } diff --git a/src/com/timsu/astrid/activities/TaskListSubActivity.java b/src/com/timsu/astrid/activities/TaskListSubActivity.java index d5e9d1dc5..900309e10 100644 --- a/src/com/timsu/astrid/activities/TaskListSubActivity.java +++ b/src/com/timsu/astrid/activities/TaskListSubActivity.java @@ -806,9 +806,9 @@ public class TaskListSubActivity extends SubActivity { syncPreferencesOpened = false; // stop & start synchronization service - Intent service = new Intent(getParent(), SynchronizationService.class); - getParent().stopService(service); - getParent().startService(service); + SynchronizationService.stop(); + SynchronizationService.start(); + } else if (context.taskArray != null && context.taskArray.size() > 0 && context.taskArray.size() < AUTO_REFRESH_MAX_LIST_SIZE) { @@ -826,7 +826,10 @@ public class TaskListSubActivity extends SubActivity { @Override protected void onActivityResult(int requestCode, int resultCode, Intent data) { if(resultCode == Constants.RESULT_SYNCHRONIZE) { - Synchronizer.synchronize(getParent(), false, new SynchronizerListener() { + Synchronizer sync = new Synchronizer(false); + sync.setTagController(getTagController()); + sync.setTaskController(getTaskController()); + sync.synchronize(getParent(), new SynchronizerListener() { public void onSynchronizerFinished(int numServicesSynced) { if(numServicesSynced == 0) { DialogUtilities.okDialog(getParent(), getResources().getString( diff --git a/src/com/timsu/astrid/sync/RTMSyncProvider.java b/src/com/timsu/astrid/sync/RTMSyncProvider.java index 8cb27336f..976bdde20 100644 --- a/src/com/timsu/astrid/sync/RTMSyncProvider.java +++ b/src/com/timsu/astrid/sync/RTMSyncProvider.java @@ -83,7 +83,7 @@ public class RTMSyncProvider extends SynchronizationProvider { public void clearPersonalData(Context context) { Preferences.setSyncRTMToken(context, null); Preferences.setSyncRTMLastSync(context, null); - Synchronizer.getSyncController(context).deleteAllMappings(getId()); + synchronizer.getSyncController(context).deleteAllMappings(getId()); } // --- authentication @@ -239,7 +239,7 @@ public class RTMSyncProvider extends SynchronizationProvider { Preferences.setSyncRTMLastSync(context, syncTime); // on with the synchronization - Synchronizer.continueSynchronization(context); + synchronizer.continueSynchronization(context); } catch (Exception e) { showError(context, e, null); diff --git a/src/com/timsu/astrid/sync/SynchronizationProvider.java b/src/com/timsu/astrid/sync/SynchronizationProvider.java index 06d6c6a2a..66ba203d8 100644 --- a/src/com/timsu/astrid/sync/SynchronizationProvider.java +++ b/src/com/timsu/astrid/sync/SynchronizationProvider.java @@ -55,15 +55,19 @@ public abstract class SynchronizationProvider { private int id; static ProgressDialog progressDialog; private Handler syncHandler; - private boolean backgroundSync; + protected Synchronizer synchronizer; public SynchronizationProvider(int id) { this.id = id; } - // called off the UI thread. does some setup - void synchronizeService(final Context activity, boolean isBackgroundSync) { - this.backgroundSync = isBackgroundSync; + /** Called off the UI thread. does some setup and then invokes implemented + * synchronize method + * @param activity + * @param caller + */ + void synchronizeService(final Context activity, Synchronizer caller) { + this.synchronizer = caller; if(!isBackgroundService()) { syncHandler = new Handler(); @@ -101,7 +105,7 @@ public abstract class SynchronizationProvider { * @return true if it's running as a background service */ protected boolean isBackgroundService() { - return backgroundSync; + return synchronizer.isService(); } /** Utility method for showing synchronization errors. If message is null, @@ -194,10 +198,10 @@ public abstract class SynchronizationProvider { final SyncStats stats = new SyncStats(); final StringBuilder log = new StringBuilder(); - SyncDataController syncController = Synchronizer.getSyncController(context); - TaskController taskController = Synchronizer.getTaskController(context); - TagController tagController = Synchronizer.getTagController(context); - AlertController alertController = Synchronizer.getAlertController(context); + SyncDataController syncController = synchronizer.getSyncController(context); + TaskController taskController = synchronizer.getTaskController(context); + TagController tagController = synchronizer.getTagController(context); + AlertController alertController = synchronizer.getAlertController(context); SyncData data = new SyncData(context, remoteTasks); // 1. CREATE: grab tasks without a sync mapping and create them remotely @@ -437,10 +441,10 @@ public abstract class SynchronizationProvider { public SyncData(Context context, LinkedList remoteTasks) { // 1. get data out of the database - mappings = Synchronizer.getSyncController(context).getSyncMapping(getId()); - activeTasks = Synchronizer.getTaskController(context).getActiveTaskIdentifiers(); - allTasks = Synchronizer.getTaskController(context).getAllTaskIdentifiers(); - tags = Synchronizer.getTagController(context).getAllTagsAsMap(); + mappings = synchronizer.getSyncController(context).getSyncMapping(getId()); + activeTasks = synchronizer.getTaskController(context).getActiveTaskIdentifiers(); + allTasks = synchronizer.getTaskController(context).getAllTaskIdentifiers(); + tags = synchronizer.getTagController(context).getAllTagsAsMap(); // 2. build helper data structures remoteIdToSyncMapping = new HashMap(); diff --git a/src/com/timsu/astrid/sync/SynchronizationService.java b/src/com/timsu/astrid/sync/SynchronizationService.java index 866b8d48c..ddbdc08c5 100644 --- a/src/com/timsu/astrid/sync/SynchronizationService.java +++ b/src/com/timsu/astrid/sync/SynchronizationService.java @@ -25,6 +25,23 @@ public class SynchronizationService extends Service { SynchronizationService.context = context; } + // --- utility methods + + public static void start() { + if(Preferences.getSyncAutoSyncFrequency(context) == null) + return; + + Intent service = new Intent(context, SynchronizationService.class); + context.stopService(service); + } + + public static void stop() { + Intent service = new Intent(context, SynchronizationService.class); + context.stopService(service); + } + + // --- + @Override public IBinder onBind(Intent arg0) { return null; // unused @@ -48,6 +65,9 @@ public class SynchronizationService extends Service { /** Start the timer that runs the service */ private void startService() { + if(context == null) + return; + // figure out synchronization frequency Integer syncFrequencySeconds = Preferences.getSyncAutoSyncFrequency(context); if(syncFrequencySeconds == null) { @@ -97,6 +117,7 @@ public class SynchronizationService extends Service { Log.i("astrid", "Automatic Synchronize Initiated."); Preferences.setSyncLastSyncAttempt(context, new Date()); - Synchronizer.synchronize(context, true, null); + Synchronizer sync = new Synchronizer(true); + sync.synchronize(context, null); } } diff --git a/src/com/timsu/astrid/sync/Synchronizer.java b/src/com/timsu/astrid/sync/Synchronizer.java index 90514abf0..cc7f92691 100644 --- a/src/com/timsu/astrid/sync/Synchronizer.java +++ b/src/com/timsu/astrid/sync/Synchronizer.java @@ -33,28 +33,46 @@ import com.timsu.astrid.data.tag.TagController; import com.timsu.astrid.data.task.TaskController; import com.timsu.astrid.utilities.Preferences; +/** + * Synchronizer is a class that manages a synchronization lifecycle. You would + * use it as follows. + *

+ * 

Synchronizer synchronizer = new Synchronizer(...);
+ * synchronizer.synchronize();
+ * + * @author Tim Su + * + */ public class Synchronizer { + /** identifier for the RTM sync provider */ private static final int SYNC_ID_RTM = 1; // --- public interface + public Synchronizer(boolean isService) { + this.isService = isService; + } + public interface SynchronizerListener { void onSynchronizerFinished(int numServicesSynced); } /** Synchronize all activated sync services */ - public synchronized static void synchronize(Context context, boolean isAutoSync, - SynchronizerListener listener) { + public synchronized void synchronize(Context context, SynchronizerListener listener) { currentStep = ServiceWrapper._FIRST_SERVICE.ordinal(); servicesSynced = 0; - autoSync = isAutoSync; callback = listener; + + // if we're not the autosync service, stop it + if(!isService) + SynchronizationService.stop(); + continueSynchronization(context); } - /** Clears tokens if services are disabled */ + /** Clears tokens of activated services */ public static void clearUserData(Activity activity) { for(ServiceWrapper serviceWrapper : ServiceWrapper.values()) { if(serviceWrapper.isActivated(activity)) { @@ -104,18 +122,22 @@ public class Synchronizer { // Internal state for the synchronization process /** Current step in the sync process */ - private static int currentStep; + private int currentStep; /** # of services synchronized */ - private static int servicesSynced; + private int servicesSynced; /** On finished callback */ - private static SynchronizerListener callback; + private SynchronizerListener callback; - private static boolean autoSync; + private boolean isService; + + boolean isService() { + return isService; + } /** Called to do the next step of synchronization. */ - static void continueSynchronization(Context context) { + void continueSynchronization(Context context) { ServiceWrapper serviceWrapper = ServiceWrapper.values()[currentStep]; currentStep++; @@ -126,7 +148,7 @@ public class Synchronizer { case RTM: if(serviceWrapper.isActivated(context)) { servicesSynced++; - serviceWrapper.service.synchronizeService(context, autoSync); + serviceWrapper.service.synchronizeService(context, this); } else { continueSynchronization(context); } @@ -137,15 +159,27 @@ public class Synchronizer { } /** Called at the end of sync. */ - private static void finishSynchronization(final Context context) { + private void finishSynchronization(final Context context) { closeControllers(); Preferences.setSyncLastSync(context, new Date()); if(callback != null) callback.onSynchronizerFinished(servicesSynced); + + if(!isService) + SynchronizationService.start(); } // --- controller stuff + private ControllerWrapper syncController = + new ControllerWrapper(SyncDataController.class); + private ControllerWrapper taskController = + new ControllerWrapper(TaskController.class); + private ControllerWrapper tagController = + new ControllerWrapper(TagController.class); + private ControllerWrapper alertController = + new ControllerWrapper(AlertController.class); + private static class ControllerWrapper { TYPE controller; Class typeClass; @@ -180,7 +214,8 @@ public class Synchronizer { } public void set(TYPE newController) { - close(); + if(controller != null && !override) + close(); override = newController != null; controller = newController; @@ -194,40 +229,31 @@ public class Synchronizer { } } - private static ControllerWrapper syncController = - new ControllerWrapper(SyncDataController.class); - private static ControllerWrapper taskController = - new ControllerWrapper(TaskController.class); - private static ControllerWrapper tagController = - new ControllerWrapper(TagController.class); - private static ControllerWrapper alertController = - new ControllerWrapper(AlertController.class); - - static SyncDataController getSyncController(Context context) { + SyncDataController getSyncController(Context context) { return syncController.get(context); } - static TaskController getTaskController(Context context) { + TaskController getTaskController(Context context) { return taskController.get(context); } - static TagController getTagController(Context context) { + TagController getTagController(Context context) { return tagController.get(context); } - static AlertController getAlertController(Context context) { + AlertController getAlertController(Context context) { return alertController.get(context); } - public static void setTaskController(TaskController taskController) { - Synchronizer.taskController.set(taskController); + public void setTaskController(TaskController taskController) { + this.taskController.set(taskController); } - public static void setTagController(TagController tagController) { - Synchronizer.tagController.set(tagController); + public void setTagController(TagController tagController) { + this.tagController.set(tagController); } - private static void closeControllers() { + private void closeControllers() { syncController.close(); taskController.close(); tagController.close();