Merge pull request #1088 from owncloud/updated_docs_about_target_of_PRs

[pub/Android/ownCloud.git] / src / com / owncloud / android / operations / SynchronizeFolderOperation.java

diff --git a/src/com/owncloud/android/operations/SynchronizeFolderOperation.java b/src/com/owncloud/android/operations/SynchronizeFolderOperation.java
index f12d5dd..6bf1ef8 100644 (file)
--- a/src/com/owncloud/android/operations/SynchronizeFolderOperation.java
+++ b/src/com/owncloud/android/operations/SynchronizeFolderOperation.java
@@ -1,5 +1,8 @@
-/* ownCloud Android client application
- *   Copyright (C) 2012-2014 ownCloud Inc.
+/**
+ *   ownCloud Android client application
+ *
+ *   @author David A. Velasco
+ *   Copyright (C) 2015 ownCloud Inc.

  *
  *   This program is free software: you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License version 2,
  *
  *   This program is free software: you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License version 2,


@@ -17,11 +20,19 @@
 
 package com.owncloud.android.operations;
 
 
 package com.owncloud.android.operations;
 

+import java.io.File;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Vector;
+

 import android.accounts.Account;
 import android.content.Context;
 import android.content.Intent;
 import android.util.Log;
 
 import android.accounts.Account;
 import android.content.Context;
 import android.content.Intent;
 import android.util.Log;
 

+

 import com.owncloud.android.datamodel.FileDataStorageManager;
 import com.owncloud.android.datamodel.OCFile;
 import com.owncloud.android.files.services.FileDownloader;
 import com.owncloud.android.datamodel.FileDataStorageManager;
 import com.owncloud.android.datamodel.OCFile;
 import com.owncloud.android.files.services.FileDownloader;


@@ -34,14 +45,9 @@ import com.owncloud.android.lib.resources.files.ReadRemoteFileOperation;
 import com.owncloud.android.lib.resources.files.ReadRemoteFolderOperation;
 import com.owncloud.android.lib.resources.files.RemoteFile;
 import com.owncloud.android.operations.common.SyncOperation;
 import com.owncloud.android.lib.resources.files.ReadRemoteFolderOperation;
 import com.owncloud.android.lib.resources.files.RemoteFile;
 import com.owncloud.android.operations.common.SyncOperation;

+import com.owncloud.android.services.OperationsService;

 import com.owncloud.android.utils.FileStorageUtils;
 
 import com.owncloud.android.utils.FileStorageUtils;
 

-import java.io.File;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Vector;

 import java.util.concurrent.atomic.AtomicBoolean;
 
 //import android.support.v4.content.LocalBroadcastManager;
 import java.util.concurrent.atomic.AtomicBoolean;
 
 //import android.support.v4.content.LocalBroadcastManager;


@@ -55,8 +61,6 @@ import java.util.concurrent.atomic.AtomicBoolean;
  *  properties, and updates the local database with them.
  *  
  *  Does NOT enter in the child folders to synchronize their contents also.
  *  properties, and updates the local database with them.
  *  
  *  Does NOT enter in the child folders to synchronize their contents also.

- * 
- *  @author David A. Velasco

  */
 public class SynchronizeFolderOperation extends SyncOperation {
 
  */
 public class SynchronizeFolderOperation extends SyncOperation {
 


@@ -98,8 +102,6 @@ public class SynchronizeFolderOperation extends SyncOperation {
     private List<SyncOperation> mFavouriteFilesToSyncContents;
         // this will be used for every file when 'folder synchronization' replaces 'folder download' 
 
     private List<SyncOperation> mFavouriteFilesToSyncContents;
         // this will be used for every file when 'folder synchronization' replaces 'folder download' 
 

-    private List<SyncOperation> mFoldersToWalkDown;
-

     private final AtomicBoolean mCancellationRequested;
 
     /**
     private final AtomicBoolean mCancellationRequested;
 
     /**


@@ -110,7 +112,8 @@ public class SynchronizeFolderOperation extends SyncOperation {
      * @param   account                 ownCloud account where the folder is located.
      * @param   currentSyncTime         Time stamp for the synchronization process in progress.
      */
      * @param   account                 ownCloud account where the folder is located.
      * @param   currentSyncTime         Time stamp for the synchronization process in progress.
      */

-    public SynchronizeFolderOperation(Context context, String remotePath, Account account, long currentSyncTime){
+    public SynchronizeFolderOperation(Context context, String remotePath, Account account,
+                                      long currentSyncTime){

         mRemotePath = remotePath;
         mCurrentSyncTime = currentSyncTime;
         mAccount = account;
         mRemotePath = remotePath;
         mCurrentSyncTime = currentSyncTime;
         mAccount = account;


@@ -119,7 +122,6 @@ public class SynchronizeFolderOperation extends SyncOperation {
         mFilesForDirectDownload = new Vector<OCFile>();
         mFilesToSyncContentsWithoutUpload = new Vector<SyncOperation>();
         mFavouriteFilesToSyncContents = new Vector<SyncOperation>();
         mFilesForDirectDownload = new Vector<OCFile>();
         mFilesToSyncContentsWithoutUpload = new Vector<SyncOperation>();
         mFavouriteFilesToSyncContents = new Vector<SyncOperation>();

-        mFoldersToWalkDown = new Vector<SyncOperation>();

         mCancellationRequested = new AtomicBoolean(false);
     }
 
         mCancellationRequested = new AtomicBoolean(false);
     }
 


@@ -161,9 +163,6 @@ public class SynchronizeFolderOperation extends SyncOperation {
                     syncContents(client);
                 }
 
                     syncContents(client);
                 }
 

-                if (mFilesForDirectDownload.isEmpty()) {
-                    sendBroadcastForNotifyingUIUpdate(result.isSuccess());
-                }

             }
             
             if (mCancellationRequested.get()) {
             }
             
             if (mCancellationRequested.get()) {


@@ -172,25 +171,14 @@ public class SynchronizeFolderOperation extends SyncOperation {
             
         } catch (OperationCancelledException e) {
             result = new RemoteOperationResult(e);
             
         } catch (OperationCancelledException e) {
             result = new RemoteOperationResult(e);

-
-            // Needed in case that cancellation occurs before starting any download.
-            // If not, yellow arrow continues being shown.
-            sendBroadcastForNotifyingUIUpdate(result.isSuccess());
-
-            /// 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(mContext, FileDownloader.class);
-            intent.setAction(FileDownloader.ACTION_CANCEL_FILE_DOWNLOAD);
-            intent.putExtra(FileDownloader.EXTRA_ACCOUNT, mAccount);
-            intent.putExtra(FileDownloader.EXTRA_FILE, mLocalFolder);
-            mContext.startService(intent);            

         }
 
         return result;
 
     }
 
         }
 
         return result;
 
     }
 

-    private RemoteOperationResult checkForChanges(OwnCloudClient client) throws OperationCancelledException {
+    private RemoteOperationResult checkForChanges(OwnCloudClient client)
+            throws OperationCancelledException {

         Log_OC.d(TAG, "Checking changes in " + mAccount.name + mRemotePath);
 
         mRemoteFolderChanged = true;
         Log_OC.d(TAG, "Checking changes in " + mAccount.name + mRemotePath);
 
         mRemoteFolderChanged = true;


@@ -228,14 +216,14 @@ public class SynchronizeFolderOperation extends SyncOperation {
                         result.getLogMessage());
             }
 
                         result.getLogMessage());
             }
 

-            sendBroadcastForNotifyingUIUpdate(result.isSuccess());

         }
 
         return result;
     }
 
 
         }
 
         return result;
     }
 
 

-    private RemoteOperationResult fetchAndSyncRemoteFolder(OwnCloudClient client) throws OperationCancelledException {
+    private RemoteOperationResult fetchAndSyncRemoteFolder(OwnCloudClient client)
+            throws OperationCancelledException {

         if (mCancellationRequested.get()) {
             throw new OperationCancelledException();
         }
         if (mCancellationRequested.get()) {
             throw new OperationCancelledException();
         }


@@ -267,7 +255,8 @@ public class SynchronizeFolderOperation extends SyncOperation {
             storageManager.removeFolder(
                     mLocalFolder,
                     true,
             storageManager.removeFolder(
                     mLocalFolder,
                     true,

-                    (   mLocalFolder.isDown() &&        // TODO: debug, I think this is always false for folders
+                    (   mLocalFolder.isDown() &&        // TODO: debug, I think this is
+                                                        // always false for folders

                             mLocalFolder.getStoragePath().startsWith(currentSavePath)
                     )
             );
                             mLocalFolder.getStoragePath().startsWith(currentSavePath)
                     )
             );


@@ -304,15 +293,13 @@ public class SynchronizeFolderOperation extends SyncOperation {
         mFilesToSyncContentsWithoutUpload.clear();
         mFavouriteFilesToSyncContents.clear();
 
         mFilesToSyncContentsWithoutUpload.clear();
         mFavouriteFilesToSyncContents.clear();
 

-        synchronized(mFoldersToWalkDown) {
-            if (mCancellationRequested.get()) {
-                throw new OperationCancelledException();
-            }
-            mFoldersToWalkDown.clear();
+        if (mCancellationRequested.get()) {
+            throw new OperationCancelledException();

         }
 
         // get current data about local contents of the folder to synchronize
         }
 
         // get current data about local contents of the folder to synchronize

-        List<OCFile> localFiles = storageManager.getFolderContent(mLocalFolder);
+        // TODO Enable when "On Device" is recovered ?
+        List<OCFile> localFiles = storageManager.getFolderContent(mLocalFolder/*, false*/);

         Map<String, OCFile> localFilesMap = new HashMap<String, OCFile>(localFiles.size());
         for (OCFile file : localFiles) {
             localFilesMap.put(file.getRemotePath(), file);
         Map<String, OCFile> localFilesMap = new HashMap<String, OCFile>(localFiles.size());
         for (OCFile file : localFiles) {
             localFilesMap.put(file.getRemotePath(), file);


@@ -347,7 +334,8 @@ public class SynchronizeFolderOperation extends SyncOperation {
                     remoteFile.setFileLength(localFile.getFileLength());
                         // TODO move operations about size of folders to FileContentProvider
                 } else if (mRemoteFolderChanged && remoteFile.isImage() &&
                     remoteFile.setFileLength(localFile.getFileLength());
                         // TODO move operations about size of folders to FileContentProvider
                 } else if (mRemoteFolderChanged && remoteFile.isImage() &&

-                        remoteFile.getModificationTimestamp() != localFile.getModificationTimestamp()) {
+                        remoteFile.getModificationTimestamp() !=
+                                localFile.getModificationTimestamp()) {

                     remoteFile.setNeedsUpdateThumbnail(true);
                     Log.d(TAG, "Image " + remoteFile.getFileName() + " updated on the server");
                 }
                     remoteFile.setNeedsUpdateThumbnail(true);
                     Log.d(TAG, "Image " + remoteFile.getFileName() + " updated on the server");
                 }


@@ -365,18 +353,11 @@ public class SynchronizeFolderOperation extends SyncOperation {
             /// classify file to sync/download contents later
             if (remoteFile.isFolder()) {
                 /// to download children files recursively
             /// classify file to sync/download contents later
             if (remoteFile.isFolder()) {
                 /// to download children files recursively

-                SynchronizeFolderOperation synchFolderOp =  new SynchronizeFolderOperation( 
-                        mContext,
-                        remoteFile.getRemotePath(),
-                        mAccount,
-                        mCurrentSyncTime
-                );
-
-                synchronized(mFoldersToWalkDown) {
+                synchronized(mCancellationRequested) {

                     if (mCancellationRequested.get()) {
                         throw new OperationCancelledException();
                     }
                     if (mCancellationRequested.get()) {
                         throw new OperationCancelledException();
                     }

-                    mFoldersToWalkDown.add(synchFolderOp);
+                    startSyncFolderOperation(remoteFile.getRemotePath());

                 }
 
             } else if (remoteFile.keepInSync()) {
                 }
 
             } else if (remoteFile.keepInSync()) {


@@ -413,23 +394,17 @@ public class SynchronizeFolderOperation extends SyncOperation {
     
     
     private void prepareOpsFromLocalKnowledge() throws OperationCancelledException {
     
     
     private void prepareOpsFromLocalKnowledge() throws OperationCancelledException {

-        List<OCFile> children = getStorageManager().getFolderContent(mLocalFolder);
+        // TODO Enable when "On Device" is recovered ?
+        List<OCFile> children = getStorageManager().getFolderContent(mLocalFolder/*, false*/);

         for (OCFile child : children) {
             /// classify file to sync/download contents later
             if (child.isFolder()) {
                 /// to download children files recursively
         for (OCFile child : children) {
             /// classify file to sync/download contents later
             if (child.isFolder()) {
                 /// to download children files recursively

-                SynchronizeFolderOperation synchFolderOp =  new SynchronizeFolderOperation( 
-                        mContext,
-                        child.getRemotePath(),
-                        mAccount,
-                        mCurrentSyncTime
-                );
-
-                synchronized(mFoldersToWalkDown) {
+                synchronized(mCancellationRequested) {

                     if (mCancellationRequested.get()) {
                         throw new OperationCancelledException();
                     }
                     if (mCancellationRequested.get()) {
                         throw new OperationCancelledException();
                     }

-                    mFoldersToWalkDown.add(synchFolderOp);
+                    startSyncFolderOperation(child.getRemotePath());

                 }
 
             } else {
                 }
 
             } else {


@@ -446,19 +421,20 @@ public class SynchronizeFolderOperation extends SyncOperation {
         startDirectDownloads();
         startContentSynchronizations(mFilesToSyncContentsWithoutUpload, client);
         startContentSynchronizations(mFavouriteFilesToSyncContents, client);
         startDirectDownloads();
         startContentSynchronizations(mFilesToSyncContentsWithoutUpload, client);
         startContentSynchronizations(mFavouriteFilesToSyncContents, client);

-        walkSubfolders(client);    // this must be the last!

     }
 
     
     private void startDirectDownloads() throws OperationCancelledException {
         for (OCFile file : mFilesForDirectDownload) {
     }
 
     
     private void startDirectDownloads() throws OperationCancelledException {
         for (OCFile file : mFilesForDirectDownload) {

-            if (mCancellationRequested.get()) {
-                throw new OperationCancelledException();
+            synchronized(mCancellationRequested) {
+                if (mCancellationRequested.get()) {
+                    throw new OperationCancelledException();
+                }
+                Intent i = new Intent(mContext, FileDownloader.class);
+                i.putExtra(FileDownloader.EXTRA_ACCOUNT, mAccount);
+                i.putExtra(FileDownloader.EXTRA_FILE, file);
+                mContext.startService(i);

             }
             }

-            Intent i = new Intent(mContext, FileDownloader.class);
-            i.putExtra(FileDownloader.EXTRA_ACCOUNT, mAccount);
-            i.putExtra(FileDownloader.EXTRA_FILE, file);
-            mContext.startService(i);

         }
     }
 
         }
     }
 


@@ -472,9 +448,11 @@ public class SynchronizeFolderOperation extends SyncOperation {
      * @param filesToSyncContents       Synchronization operations to execute.
      * @param client                    Interface to the remote ownCloud server.
      */
      * @param filesToSyncContents       Synchronization operations to execute.
      * @param client                    Interface to the remote ownCloud server.
      */

-    private void startContentSynchronizations(List<SyncOperation> filesToSyncContents, OwnCloudClient client) 
+    private void startContentSynchronizations(List<SyncOperation> filesToSyncContents,
+                                              OwnCloudClient client)

             throws OperationCancelledException {
             throws OperationCancelledException {

-        
+
+        Log_OC.v(TAG, "Starting content synchronization... ");

         RemoteOperationResult contentsResult = null;
         for (SyncOperation op: filesToSyncContents) {
             if (mCancellationRequested.get()) {
         RemoteOperationResult contentsResult = null;
         for (SyncOperation op: filesToSyncContents) {
             if (mCancellationRequested.get()) {


@@ -499,29 +477,10 @@ public class SynchronizeFolderOperation extends SyncOperation {
         }
     }
 
         }
     }
 

-
-    private void walkSubfolders(OwnCloudClient client) throws OperationCancelledException {
-        RemoteOperationResult contentsResult = null;
-        for (SyncOperation op: mFoldersToWalkDown) {
-            if (mCancellationRequested.get()) {
-                throw new OperationCancelledException();
-            }
-            contentsResult = op.execute(client, getStorageManager());   // to watch out: possibly deep recursion
-            if (!contentsResult.isSuccess()) {
-                // TODO - some kind of error count, and use it with notifications
-                if (contentsResult.getException() != null) {
-                    Log_OC.e(TAG, "Non blocking exception : "
-                            +  contentsResult.getLogMessage(), contentsResult.getException());
-                } else {
-                    Log_OC.e(TAG, "Non blocking error : " + contentsResult.getLogMessage());
-                }
-            }   // won't let these fails break the synchronization process
-        }
-    }
-

     
     /**
     
     /**

-     * Creates and populates a new {@link com.owncloud.android.datamodel.OCFile} object with the data read from the server.
+     * Creates and populates a new {@link com.owncloud.android.datamodel.OCFile}
+     * object with the data read from the server.

      *
      * @param remote    remote file read from the server (remote file or folder).
      * @return          New OCFile instance representing the remote resource described by we.
      *
      * @param remote    remote file read from the server (remote file or folder).
      * @return          New OCFile instance representing the remote resource described by we.


@@ -541,8 +500,8 @@ public class SynchronizeFolderOperation extends SyncOperation {
 
     /**
      * Scans the default location for saving local copies of files searching for
 
     /**
      * Scans the default location for saving local copies of files searching for

-     * a 'lost' file with the same full name as the {@link com.owncloud.android.datamodel.OCFile} received as
-     * parameter.
+     * a 'lost' file with the same full name as the {@link com.owncloud.android.datamodel.OCFile}
+     * received as parameter.

      *  
      * @param file      File to associate a possible 'lost' local file.
      */
      *  
      * @param file      File to associate a possible 'lost' local file.
      */


@@ -556,29 +515,12 @@ public class SynchronizeFolderOperation extends SyncOperation {
         }
     }
 
         }
     }
 

-    private void sendBroadcastForNotifyingUIUpdate(boolean result) {
-        // Send a broadcast message for notifying UI update
-        Intent uiUpdate = new Intent(FileDownloader.getDownloadFinishMessage());
-        uiUpdate.putExtra(FileDownloader.EXTRA_DOWNLOAD_RESULT, result);
-        uiUpdate.putExtra(FileDownloader.ACCOUNT_NAME, mAccount.name);
-        uiUpdate.putExtra(FileDownloader.EXTRA_REMOTE_PATH, mRemotePath);
-        uiUpdate.putExtra(FileDownloader.EXTRA_FILE_PATH, mLocalFolder.getRemotePath());
-        mContext.sendStickyBroadcast(uiUpdate);
-    }
-

     
     /**
      * Cancel operation
      */
     public void cancel() {
         mCancellationRequested.set(true);
     
     /**
      * Cancel operation
      */
     public void cancel() {
         mCancellationRequested.set(true);

-
-        synchronized(mFoldersToWalkDown) {
-            // cancel 'child' synchronizations
-            for (SyncOperation synchOp : mFoldersToWalkDown) {
-                ((SynchronizeFolderOperation) synchOp).cancel();
-            }
-        }

     }
 
     public String getFolderPath() {
     }
 
     public String getFolderPath() {


@@ -588,4 +530,16 @@ public class SynchronizeFolderOperation extends SyncOperation {
         }
         return FileStorageUtils.getDefaultSavePathFor(mAccount.name, mLocalFolder);
     }
         }
         return FileStorageUtils.getDefaultSavePathFor(mAccount.name, mLocalFolder);
     }

+
+    private void startSyncFolderOperation(String path){
+        Intent intent = new Intent(mContext, OperationsService.class);
+        intent.setAction(OperationsService.ACTION_SYNC_FOLDER);
+        intent.putExtra(OperationsService.EXTRA_ACCOUNT, mAccount);
+        intent.putExtra(OperationsService.EXTRA_REMOTE_PATH, path);
+        mContext.startService(intent);
+    }
+
+    public String getRemotePath() {
+        return mRemotePath;
+    }

 }
 }