Merge branch 'master' into develop
[pub/Android/ownCloud.git] / src / com / owncloud / android / services / OperationsService.java
index 71ccf44..581a686 100644 (file)
@@ -18,7 +18,6 @@
 package com.owncloud.android.services;
 
 import java.io.IOException;
-import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentLinkedQueue;
@@ -28,7 +27,6 @@ import com.owncloud.android.MainApp;
 import com.owncloud.android.R;
 import com.owncloud.android.datamodel.FileDataStorageManager;
 import com.owncloud.android.datamodel.OCFile;
-import com.owncloud.android.files.services.FileDownloader;
 import com.owncloud.android.lib.common.OwnCloudAccount;
 import com.owncloud.android.lib.common.OwnCloudClient;
 import com.owncloud.android.lib.common.OwnCloudClientManagerFactory;
@@ -53,7 +51,6 @@ import com.owncloud.android.operations.RenameFileOperation;
 import com.owncloud.android.operations.SynchronizeFileOperation;
 import com.owncloud.android.operations.SynchronizeFolderOperation;
 import com.owncloud.android.operations.UnshareLinkOperation;
-import com.owncloud.android.utils.FileStorageUtils;
 
 import android.accounts.Account;
 import android.accounts.AccountsException;
@@ -106,7 +103,7 @@ public class OperationsService extends Service {
     public static final String ACTION_CREATE_FOLDER = "CREATE_FOLDER";
     public static final String ACTION_SYNC_FILE = "SYNC_FILE";
     public static final String ACTION_SYNC_FOLDER = "SYNC_FOLDER";  // for the moment, just to download
-    public static final String ACTION_CANCEL_SYNC_FOLDER = "CANCEL_SYNC_FOLDER";  // for the moment, just to download
+    //public static final String ACTION_CANCEL_SYNC_FOLDER = "CANCEL_SYNC_FOLDER";  // for the moment, just to download
     public static final String ACTION_MOVE_FILE = "MOVE_FILE";
     
     public static final String ACTION_OPERATION_ADDED = OperationsService.class.getName() + ".OPERATION_ADDED";
@@ -147,6 +144,8 @@ public class OperationsService extends Service {
     @Override
     public void onCreate() {
         super.onCreate();
+        Log_OC.d(TAG, "Creating service");
+
         /// First worker thread for most of operations 
         HandlerThread thread = new HandlerThread("Operations thread", Process.THREAD_PRIORITY_BACKGROUND);
         thread.start();
@@ -168,9 +167,12 @@ public class OperationsService extends Service {
      */
     @Override
     public int onStartCommand(Intent intent, int flags, int startId) {
-        // WIP: for the moment, only SYNC_FOLDER and CANCEL_SYNC_FOLDER is expected here;
+        Log_OC.d(TAG, "Starting command with id " + startId);
+
+        // WIP: for the moment, only SYNC_FOLDER is expected here;
         // the rest of the operations are requested through the Binder
         if (ACTION_SYNC_FOLDER.equals(intent.getAction())) {
+
             if (!intent.hasExtra(EXTRA_ACCOUNT) || !intent.hasExtra(EXTRA_REMOTE_PATH)) {
                 Log_OC.e(TAG, "Not enough information provided in intent");
                 return START_NOT_STICKY;
@@ -183,26 +185,11 @@ public class OperationsService extends Service {
             Pair<Target, RemoteOperation> itemToQueue = newOperation(intent);
             if (itemToQueue != null) {
                 mSyncFolderHandler.add(account, remotePath, (SynchronizeFolderOperation)itemToQueue.second);
-                mSyncFolderHandler.sendBroadcastNewSyncFolder(account, remotePath);
                 Message msg = mSyncFolderHandler.obtainMessage();
                 msg.arg1 = startId;
                 msg.obj = itemSyncKey;
                 mSyncFolderHandler.sendMessage(msg);
             }
-        } else if (ACTION_CANCEL_SYNC_FOLDER.equals(intent.getAction())) {
-            if (!intent.hasExtra(EXTRA_ACCOUNT) || !intent.hasExtra(EXTRA_FILE)) {
-                Log_OC.e(TAG, "Not enough information provided in intent");
-                return START_NOT_STICKY;
-            }
-            final Account account = intent.getParcelableExtra(EXTRA_ACCOUNT);
-            final OCFile file = intent.getParcelableExtra(EXTRA_FILE);
-            // Cancel operation
-            new Thread(new Runnable() {
-                public void run() {
-                    // Cancel the download
-                    mSyncFolderHandler.cancel(account,file);
-                }
-            }).start();
 
         } else {
             Message msg = mOperationsHandler.obtainMessage();
@@ -215,7 +202,7 @@ public class OperationsService extends Service {
 
     @Override
     public void onDestroy() {
-        //Log_OC.wtf(TAG, "onDestroy init" );
+        Log_OC.v(TAG, "Destroying service" );
         // Saving cookies
         try {
             OwnCloudClientManagerFactory.getDefaultSingleton().
@@ -232,10 +219,16 @@ public class OperationsService extends Service {
             e.printStackTrace();
         }
         
-        //Log_OC.wtf(TAG, "Clear mUndispatchedFinisiedOperations" );
         mUndispatchedFinishedOperations.clear();
-        
-        //Log_OC.wtf(TAG, "onDestroy end" );
+
+        mOperationsBinder = null;
+
+        mOperationsHandler.getLooper().quit();
+        mOperationsHandler = null;
+
+        mSyncFolderHandler.getLooper().quit();
+        mSyncFolderHandler = null;
+
         super.onDestroy();
     }
 
@@ -274,23 +267,23 @@ public class OperationsService extends Service {
                 new ConcurrentHashMap<OnRemoteOperationListener, Handler>();
         
         private ServiceHandler mServiceHandler = null;   
-        
-        
+
         public OperationsServiceBinder(ServiceHandler serviceHandler) {
             mServiceHandler = serviceHandler;
         }
 
 
         /**
-         * Cancels an operation
+         * Cancels a pending or current synchronization.
          *
-         * TODO
+         * @param account       ownCloud account where the remote folder is stored.
+         * @param file          A folder in the queue of pending synchronizations
          */
-        public void cancel() {
-            // TODO
+        public void cancel(Account account, OCFile file) {
+            mSyncFolderHandler.cancel(account, file);
         }
-        
-        
+
+
         public void clearListeners() {
             
             mBoundListeners.clear();
@@ -372,12 +365,15 @@ public class OperationsService extends Service {
         
         
         /**
-         * Returns True when the file described by 'file' in the ownCloud account 'account' is downloading or waiting to download.
+         * Returns True when the file described by 'file' in the ownCloud account 'account' is downloading or waiting
+         * to download.
          * 
-         * If 'file' is a directory, returns 'true' if some of its descendant files is downloading or waiting to download. 
+         * If 'file' is a directory, returns 'true' if some of its descendant files is downloading or waiting
+         * to download.
          * 
          * @param account       ownCloud account where the remote file is stored.
-         * @param file          A file that could be affected 
+         * @param remotePath    Path of the folder to check if something is synchronizing / downloading / uploading
+         *                      inside.
          */
         public boolean isSynchronizing(Account account, String remotePath) {
             return mSyncFolderHandler.isSynchronizing(account, remotePath);
@@ -387,189 +383,6 @@ public class OperationsService extends Service {
 
 
     /**
-     * SyncFolder worker. Performs the pending operations in the order they were requested.
-     *
-     * Created with the Looper of a new thread, started in {@link OperationsService#onCreate()}.
-     */
-    private static class SyncFolderHandler extends Handler {
-
-        // don't make it a final class, and don't remove the static ; lint will warn about a possible memory leak
-
-        OperationsService mService;
-
-        private ConcurrentMap<String,SynchronizeFolderOperation> mPendingOperations =
-                new ConcurrentHashMap<String,SynchronizeFolderOperation>();
-        private OwnCloudClient mOwnCloudClient = null;
-        private FileDataStorageManager mStorageManager;
-        private SynchronizeFolderOperation mCurrentSyncOperation;
-
-
-        public SyncFolderHandler(Looper looper, OperationsService service) {
-            super(looper);
-            if (service == null) {
-                throw new IllegalArgumentException("Received invalid NULL in parameter 'service'");
-            }
-            mService = service;
-        }
-
-        
-        public boolean isSynchronizing(Account account, String remotePath) {
-            if (account == null || remotePath == null) return false;
-            String targetKey = buildRemoteName(account, remotePath);
-            synchronized (mPendingOperations) {
-                // TODO - this can be slow when synchronizing a big tree - need a better data structure
-                Iterator<String> it = mPendingOperations.keySet().iterator();
-                boolean found = false;
-                while (it.hasNext() && !found) {
-                    found = it.next().startsWith(targetKey);
-                }
-                return found;
-            }
-        }
-        
-
-        @Override
-        public void handleMessage(Message msg) {
-            Pair<Account, String> itemSyncKey = (Pair<Account, String>) msg.obj;
-            doOperation(itemSyncKey.first, itemSyncKey.second);
-            mService.stopSelf(msg.arg1);
-        }
-
-
-        /**
-         * Performs the next operation in the queue
-         */
-        private void doOperation(Account account, String remotePath) {
-
-            String syncKey = buildRemoteName(account,remotePath);
-
-            synchronized(mPendingOperations) {
-                mCurrentSyncOperation = mPendingOperations.get(syncKey);
-            }
-
-            if (mCurrentSyncOperation != null) {
-                RemoteOperationResult result = null;
-
-                try {
-
-                    OwnCloudAccount ocAccount = new OwnCloudAccount(account, mService);
-                    mOwnCloudClient = OwnCloudClientManagerFactory.getDefaultSingleton().
-                            getClientFor(ocAccount, mService);
-                    mStorageManager = new FileDataStorageManager(
-                            account,
-                            mService.getContentResolver()
-                    );
-
-                    result = mCurrentSyncOperation.execute(mOwnCloudClient, mStorageManager);
-
-                } catch (AccountsException e) {
-                    Log_OC.e(TAG, "Error while trying to get autorization", e);
-                } catch (IOException e) {
-                    Log_OC.e(TAG, "Error while trying to get autorization", e);
-                } finally {
-                    synchronized(mPendingOperations) {
-                        mPendingOperations.remove(syncKey);
-                    }
-
-                    mService.dispatchResultToOperationListeners(null, mCurrentSyncOperation, result);
-                    
-                    sendBroadcastFinishedSyncFolder(account, remotePath, result.isSuccess());
-                }
-            }
-        }
-
-        public void add(Account account, String remotePath, SynchronizeFolderOperation syncFolderOperation){
-            String syncKey = buildRemoteName(account,remotePath);
-            mPendingOperations.putIfAbsent(syncKey,syncFolderOperation);
-        }
-
-        /**
-         * Cancels sync operations.
-         * @param account       Owncloud account where the remote file is stored.
-         * @param file          File OCFile
-         */
-        public void cancel(Account account, OCFile file){
-            SynchronizeFolderOperation syncOperation = null;
-            String targetKey = buildRemoteName(account, file.getRemotePath());
-            ArrayList<String> keyItems = new ArrayList<String>();
-            synchronized (mPendingOperations) {
-                if (file.isFolder()) {
-                    Log_OC.d(TAG, "Canceling pending sync operations");
-                    Iterator<String> it = mPendingOperations.keySet().iterator();
-                    boolean found = false;
-                    while (it.hasNext()) {
-                        String keySyncOperation = it.next();
-                        found = keySyncOperation.startsWith(targetKey);
-                        if (found) {
-                            keyItems.add(keySyncOperation);
-                        }
-                    }
-                    
-                } else {
-                    // this is not really expected...
-                    Log_OC.d(TAG, "Canceling sync operation");
-                    keyItems.add(buildRemoteName(account, file.getRemotePath()));
-                }
-                for (String item: keyItems) {
-                    syncOperation = mPendingOperations.remove(item);
-                    if (syncOperation != null) {
-                        syncOperation.cancel();
-                    }
-                }
-            }
-
-            //sendBroadcastFinishedSyncFolder(account, file.getRemotePath());
-            
-            /// cancellation of download needs to be done separately in any case; a SynchronizeFolderOperation
-            //  may finish much sooner than the real download of the files in the folder
-            Intent intent = new Intent(mService, FileDownloader.class);
-            intent.setAction(FileDownloader.ACTION_CANCEL_FILE_DOWNLOAD);
-            intent.putExtra(FileDownloader.EXTRA_ACCOUNT, account);
-            intent.putExtra(FileDownloader.EXTRA_FILE, file);
-            mService.startService(intent);
-        }
-
-        /**
-         * Builds a key from the account and file to download
-         *
-         * @param account   Account where the file to download is stored
-         * @param path      File path
-         */
-        private String buildRemoteName(Account account, String path) {
-            return account.name + path;
-        }
-        
-        
-        /**
-         * TODO review this method when "folder synchronization" replaces "folder download"; this is a fast and ugly 
-         * patch. 
-         */
-        private void sendBroadcastNewSyncFolder(Account account, String remotePath) {
-            Intent added = new Intent(FileDownloader.getDownloadAddedMessage());
-            added.putExtra(FileDownloader.ACCOUNT_NAME, account.name);
-            added.putExtra(FileDownloader.EXTRA_REMOTE_PATH, remotePath);
-            added.putExtra(FileDownloader.EXTRA_FILE_PATH, FileStorageUtils.getSavePath(account.name) + remotePath);
-            mService.sendStickyBroadcast(added);
-        }
-
-        /**
-         * TODO review this method when "folder synchronization" replaces "folder download"; this is a fast and ugly 
-         * patch. 
-         */
-        private void sendBroadcastFinishedSyncFolder(Account account, String remotePath, boolean success) {
-            Intent finished = new Intent(FileDownloader.getDownloadFinishMessage());
-            finished.putExtra(FileDownloader.ACCOUNT_NAME, account.name);
-            finished.putExtra(FileDownloader.EXTRA_REMOTE_PATH, remotePath);
-            finished.putExtra(FileDownloader.EXTRA_FILE_PATH, FileStorageUtils.getSavePath(account.name) + remotePath);
-            finished.putExtra(FileDownloader.EXTRA_DOWNLOAD_RESULT, success);
-            mService.sendStickyBroadcast(finished);
-        }
-
-
-    }
-
-
-    /** 
      * Operations worker. Performs the pending operations in the order they were requested. 
      * 
      * Created with the Looper of a new thread, started in {@link OperationsService#onCreate()}. 
@@ -600,6 +413,7 @@ public class OperationsService extends Service {
         @Override
         public void handleMessage(Message msg) {
             nextOperation();
+            Log_OC.d(TAG, "Stopping after command with id " + msg.arg1);
             mService.stopSelf(msg.arg1);
         }
         
@@ -888,7 +702,7 @@ public class OperationsService extends Service {
      * @param operation         Finished operation.
      * @param result            Result of the operation.
      */
-    private void dispatchResultToOperationListeners(
+    protected void dispatchResultToOperationListeners(
             Target target, final RemoteOperation operation, final RemoteOperationResult result) {
         int count = 0;
         Iterator<OnRemoteOperationListener> listeners = mOperationsBinder.mBoundListeners.keySet().iterator();