- added Comment

[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 f542652..cdf1282 100644 (file)
--- a/src/com/owncloud/android/operations/SynchronizeFolderOperation.java
+++ b/src/com/owncloud/android/operations/SynchronizeFolderOperation.java
@@ -70,8 +70,10 @@ public class SynchronizeFolderOperation extends RemoteOperation {
 
     private static final String TAG = SynchronizeFolderOperation.class.getSimpleName();
 
 
     private static final String TAG = SynchronizeFolderOperation.class.getSimpleName();
 

-    public static final String EVENT_SINGLE_FOLDER_CONTENTS_SYNCED  = SynchronizeFolderOperation.class.getName() + ".EVENT_SINGLE_FOLDER_CONTENTS_SYNCED";
-    public static final String EVENT_SINGLE_FOLDER_SHARES_SYNCED    = SynchronizeFolderOperation.class.getName() + ".EVENT_SINGLE_FOLDER_SHARES_SYNCED";
+    public static final String EVENT_SINGLE_FOLDER_CONTENTS_SYNCED  = 
+            SynchronizeFolderOperation.class.getName() + ".EVENT_SINGLE_FOLDER_CONTENTS_SYNCED";
+    public static final String EVENT_SINGLE_FOLDER_SHARES_SYNCED    = 
+            SynchronizeFolderOperation.class.getName() + ".EVENT_SINGLE_FOLDER_SHARES_SYNCED";

     
     /** Time stamp for the synchronization process in progress */
     private long mCurrentSyncTime;
     
     /** Time stamp for the synchronization process in progress */
     private long mCurrentSyncTime;


@@ -97,16 +99,19 @@ public class SynchronizeFolderOperation extends RemoteOperation {
     /** Counter of failed operations in synchronization of kept-in-sync files */
     private int mFailsInFavouritesFound;
 
     /** Counter of failed operations in synchronization of kept-in-sync files */
     private int mFailsInFavouritesFound;
 

-    /** Map of remote and local paths to files that where locally stored in a location out of the ownCloud folder and couldn't be copied automatically into it */
+    /**
+     * Map of remote and local paths to files that where locally stored in a location 
+     * out of the ownCloud folder and couldn't be copied automatically into it 
+     **/

     private Map<String, String> mForgottenLocalFiles;
 
     /** 'True' means that this operation is part of a full account synchronization */ 
     private boolean mSyncFullAccount;
 
     private Map<String, String> mForgottenLocalFiles;
 
     /** 'True' means that this operation is part of a full account synchronization */ 
     private boolean mSyncFullAccount;
 

-    /** 'True' means that Share resources bound to the files into the folder should be refreshed also */
+    /** 'True' means that Share resources bound to the files into should be refreshed also */

     private boolean mIsShareSupported;
     
     private boolean mIsShareSupported;
     

-    /** 'True' means that the remote folder changed from last synchronization and should be fetched */
+    /** 'True' means that the remote folder changed and should be fetched */

     private boolean mRemoteFolderChanged;
 
     /** 'True' means that Etag will be ignored */
     private boolean mRemoteFolderChanged;
 
     /** 'True' means that Etag will be ignored */


@@ -116,11 +121,14 @@ public class SynchronizeFolderOperation extends RemoteOperation {
     /**
      * Creates a new instance of {@link SynchronizeFolderOperation}.
      * 
     /**
      * Creates a new instance of {@link SynchronizeFolderOperation}.
      * 

-     * @param   remoteFolderPath        Remote folder to synchronize.
+     * @param   folder                  Folder to synchronize.

      * @param   currentSyncTime         Time stamp for the synchronization process in progress.
      * @param   currentSyncTime         Time stamp for the synchronization process in progress.

-     * @param   localFolderId           Identifier in the local database of the folder to synchronize.
-     * @param   updateFolderProperties  'True' means that the properties of the folder should be updated also, not just its content.
-     * @param   syncFullAccount         'True' means that this operation is part of a full account synchronization.
+     * @param   syncFullAccount         'True' means that this operation is part of a full account 
+     *                                  synchronization.
+     * @param   isShareSupported        'True' means that the server supports the sharing API.           
+     * @param   ignoreEtag              'True' means that the content of the remote folder should
+     *                                  be fetched and updated even though the 'eTag' did not 
+     *                                  change.  

      * @param   dataStorageManager      Interface with the local database.
      * @param   account                 ownCloud account where the folder is located. 
      * @param   context                 Application context.
      * @param   dataStorageManager      Interface with the local database.
      * @param   account                 ownCloud account where the folder is located. 
      * @param   context                 Application context.


@@ -159,7 +167,8 @@ public class SynchronizeFolderOperation extends RemoteOperation {
     }
     
     /**
     }
     
     /**

-     * Returns the list of files and folders contained in the synchronized folder, if called after synchronization is complete.
+     * Returns the list of files and folders contained in the synchronized folder, 
+     * if called after synchronization is complete.

      * 
      * @return  List of files and folders contained in the synchronized folder.
      */
      * 
      * @return  List of files and folders contained in the synchronized folder.
      */


@@ -194,7 +203,9 @@ public class SynchronizeFolderOperation extends RemoteOperation {
         }
         
         if (!mSyncFullAccount) {            
         }
         
         if (!mSyncFullAccount) {            

-            sendLocalBroadcast(EVENT_SINGLE_FOLDER_CONTENTS_SYNCED, mLocalFolder.getRemotePath(), result);
+            sendLocalBroadcast(
+                    EVENT_SINGLE_FOLDER_CONTENTS_SYNCED, mLocalFolder.getRemotePath(), result
+            );

         }
         
         if (result.isSuccess() && mIsShareSupported && !mSyncFullAccount) {
         }
         
         if (result.isSuccess() && mIsShareSupported && !mSyncFullAccount) {


@@ -202,7 +213,9 @@ public class SynchronizeFolderOperation extends RemoteOperation {
         }
         
         if (!mSyncFullAccount) {            
         }
         
         if (!mSyncFullAccount) {            

-            sendLocalBroadcast(EVENT_SINGLE_FOLDER_SHARES_SYNCED, mLocalFolder.getRemotePath(), result);
+            sendLocalBroadcast(
+                    EVENT_SINGLE_FOLDER_SHARES_SYNCED, mLocalFolder.getRemotePath(), result
+            );

         }
         
         return result;
         }
         
         return result;


@@ -235,12 +248,14 @@ public class SynchronizeFolderOperation extends RemoteOperation {
 
             if (!mIgnoreETag) {
                 // check if remote and local folder are different
 
             if (!mIgnoreETag) {
                 // check if remote and local folder are different

-                mRemoteFolderChanged = !(remoteFolder.getEtag().equalsIgnoreCase(mLocalFolder.getEtag()));
+                mRemoteFolderChanged = 
+                        !(remoteFolder.getEtag().equalsIgnoreCase(mLocalFolder.getEtag()));

             }
 
             result = new RemoteOperationResult(ResultCode.OK);
         
             }
 
             result = new RemoteOperationResult(ResultCode.OK);
         

-            Log_OC.i(TAG, "Checked " + mAccount.name + remotePath + " : " + (mRemoteFolderChanged ? "changed" : "not changed"));
+            Log_OC.i(TAG, "Checked " + mAccount.name + remotePath + " : " + 
+                    (mRemoteFolderChanged ? "changed" : "not changed"));

             
         } else {
             // check failed
             
         } else {
             // check failed


@@ -248,9 +263,11 @@ public class SynchronizeFolderOperation extends RemoteOperation {
                 removeLocalFolder();
             }
             if (result.isException()) {
                 removeLocalFolder();
             }
             if (result.isException()) {

-                Log_OC.e(TAG, "Checked " + mAccount.name + remotePath  + " : " + result.getLogMessage(), result.getException());
+                Log_OC.e(TAG, "Checked " + mAccount.name + remotePath  + " : " + 
+                        result.getLogMessage(), result.getException());

             } else {
             } else {

-                Log_OC.e(TAG, "Checked " + mAccount.name + remotePath + " : " + result.getLogMessage());
+                Log_OC.e(TAG, "Checked " + mAccount.name + remotePath + " : " + 
+                        result.getLogMessage());

             }
         }
         
             }
         }
         


@@ -267,7 +284,8 @@ public class SynchronizeFolderOperation extends RemoteOperation {
         if (result.isSuccess()) {
             synchronizeData(result.getData(), client);
             if (mConflictsFound > 0  || mFailsInFavouritesFound > 0) { 
         if (result.isSuccess()) {
             synchronizeData(result.getData(), client);
             if (mConflictsFound > 0  || mFailsInFavouritesFound > 0) { 

-                result = new RemoteOperationResult(ResultCode.SYNC_CONFLICT);   // should be different result, but will do the job
+                result = new RemoteOperationResult(ResultCode.SYNC_CONFLICT);   
+                    // should be a different result code, but will do the job

             }
         } else {
             if (result.getCode() == ResultCode.FILE_NOT_FOUND)
             }
         } else {
             if (result.getCode() == ResultCode.FILE_NOT_FOUND)


@@ -281,7 +299,13 @@ public class SynchronizeFolderOperation extends RemoteOperation {
     private void removeLocalFolder() {
         if (mStorageManager.fileExists(mLocalFolder.getFileId())) {
             String currentSavePath = FileStorageUtils.getSavePath(mAccount.name);
     private void removeLocalFolder() {
         if (mStorageManager.fileExists(mLocalFolder.getFileId())) {
             String currentSavePath = FileStorageUtils.getSavePath(mAccount.name);

-            mStorageManager.removeFolder(mLocalFolder, true, (mLocalFolder.isDown() && mLocalFolder.getStoragePath().startsWith(currentSavePath)));
+            mStorageManager.removeFolder(
+                    mLocalFolder, 
+                    true, 
+                    (   mLocalFolder.isDown() && 
+                            mLocalFolder.getStoragePath().startsWith(currentSavePath)
+                    )
+            );

         }
     }
 
         }
     }
 


@@ -296,7 +320,7 @@ public class SynchronizeFolderOperation extends RemoteOperation {
      *  
      *  @param client           Client instance to the remote server where the data were 
      *                          retrieved.  
      *  
      *  @param client           Client instance to the remote server where the data were 
      *                          retrieved.  

-     *  @return                 'True' when any change was made in the local data, 'false' otherwise.
+     *  @return                 'True' when any change was made in the local data, 'false' otherwise

      */
     private void synchronizeData(ArrayList<Object> folderAndFiles, OwnCloudClient client) {
         // get 'fresh data' from the database
      */
     private void synchronizeData(ArrayList<Object> folderAndFiles, OwnCloudClient client) {
         // get 'fresh data' from the database


@@ -307,7 +331,8 @@ public class SynchronizeFolderOperation extends RemoteOperation {
         remoteFolder.setParentId(mLocalFolder.getParentId());
         remoteFolder.setFileId(mLocalFolder.getFileId());
         
         remoteFolder.setParentId(mLocalFolder.getParentId());
         remoteFolder.setFileId(mLocalFolder.getFileId());
         

-        Log_OC.d(TAG, "Remote folder " + mLocalFolder.getRemotePath() + " changed - starting update of local data ");
+        Log_OC.d(TAG, "Remote folder " + mLocalFolder.getRemotePath() 
+                + " changed - starting update of local data ");

         
         List<OCFile> updatedFiles = new Vector<OCFile>(folderAndFiles.size() - 1);
         List<SynchronizeFileOperation> filesToSyncContents = new Vector<SynchronizeFileOperation>();
         
         List<OCFile> updatedFiles = new Vector<OCFile>(folderAndFiles.size() - 1);
         List<SynchronizeFileOperation> filesToSyncContents = new Vector<SynchronizeFileOperation>();


@@ -327,30 +352,38 @@ public class SynchronizeFolderOperation extends RemoteOperation {
             remoteFile.setParentId(mLocalFolder.getFileId());
 
             /// retrieve local data for the read file 
             remoteFile.setParentId(mLocalFolder.getFileId());
 
             /// retrieve local data for the read file 

-            //localFile = mStorageManager.getFileByPath(remoteFile.getRemotePath());
+            //  localFile = mStorageManager.getFileByPath(remoteFile.getRemotePath());

             localFile = localFilesMap.remove(remoteFile.getRemotePath());
             
             localFile = localFilesMap.remove(remoteFile.getRemotePath());
             

-            /// add to the remoteFile (the new one) data about LOCAL STATE (not existing in the server side)
+            /// add to the remoteFile (the new one) data about LOCAL STATE (not existing in server)

             remoteFile.setLastSyncDateForProperties(mCurrentSyncTime);
             if (localFile != null) {
                 // some properties of local state are kept unmodified
                 remoteFile.setFileId(localFile.getFileId());
                 remoteFile.setKeepInSync(localFile.keepInSync());
                 remoteFile.setLastSyncDateForData(localFile.getLastSyncDateForData());
             remoteFile.setLastSyncDateForProperties(mCurrentSyncTime);
             if (localFile != null) {
                 // some properties of local state are kept unmodified
                 remoteFile.setFileId(localFile.getFileId());
                 remoteFile.setKeepInSync(localFile.keepInSync());
                 remoteFile.setLastSyncDateForData(localFile.getLastSyncDateForData());

-                remoteFile.setModificationTimestampAtLastSyncForData(localFile.getModificationTimestampAtLastSyncForData());
+                remoteFile.setModificationTimestampAtLastSyncForData(
+                        localFile.getModificationTimestampAtLastSyncForData()
+                );

                 remoteFile.setStoragePath(localFile.getStoragePath());
                 remoteFile.setStoragePath(localFile.getStoragePath());

-                remoteFile.setEtag(localFile.getEtag());    // eTag will not be updated unless contents are synchronized (Synchronize[File|Folder]Operation with remoteFile as parameter)
+                // eTag will not be updated unless contents are synchronized 
+                //  (Synchronize[File|Folder]Operation with remoteFile as parameter)
+                remoteFile.setEtag(localFile.getEtag());    

                 if (remoteFile.isFolder()) {
                 if (remoteFile.isFolder()) {

-                    remoteFile.setFileLength(localFile.getFileLength()); // TODO move operations about size of folders to FileContentProvider
+                    remoteFile.setFileLength(localFile.getFileLength()); 
+                        // TODO move operations about size of folders to FileContentProvider

                 }
                 remoteFile.setPublicLink(localFile.getPublicLink());
                 remoteFile.setShareByLink(localFile.isShareByLink());
             } else {
                 }
                 remoteFile.setPublicLink(localFile.getPublicLink());
                 remoteFile.setShareByLink(localFile.isShareByLink());
             } else {

-                remoteFile.setEtag(""); // remote eTag will not be updated unless contents are synchronized (Synchronize[File|Folder]Operation with remoteFile as parameter)
+                // remote eTag will not be updated unless contents are synchronized 
+                //  (Synchronize[File|Folder]Operation with remoteFile as parameter)
+                remoteFile.setEtag(""); 

             }
 
             /// check and fix, if needed, local storage path
             }
 
             /// check and fix, if needed, local storage path

-            checkAndFixForeignStoragePath(remoteFile);      // fixing old policy - now local files must be copied into the ownCloud local folder 
+            checkAndFixForeignStoragePath(remoteFile);      // policy - local files are COPIED 
+                                                            // into the ownCloud local folder;

             searchForLocalFileInDefaultPath(remoteFile);    // legacy   
 
             /// prepare content synchronization for kept-in-sync files
             searchForLocalFileInDefaultPath(remoteFile);    // legacy   
 
             /// prepare content synchronization for kept-in-sync files


@@ -368,7 +401,7 @@ public class SynchronizeFolderOperation extends RemoteOperation {
             updatedFiles.add(remoteFile);
         }
 
             updatedFiles.add(remoteFile);
         }
 

-        // save updated contents in local database; all at once, trying to get a best performance in database update (not a big deal, indeed)
+        // save updated contents in local database

         mStorageManager.saveFolder(remoteFolder, updatedFiles, localFilesMap.values());
 
         // request for the synchronization of file contents AFTER saving current remote properties
         mStorageManager.saveFolder(remoteFolder, updatedFiles, localFilesMap.values());
 
         // request for the synchronization of file contents AFTER saving current remote properties


@@ -378,27 +411,32 @@ public class SynchronizeFolderOperation extends RemoteOperation {
     }
 
     /**
     }
 
     /**

-     * Performs a list of synchronization operations, determining if a download or upload is needed or
-     * if exists conflict due to changes both in local and remote contents of the each file.
+     * Performs a list of synchronization operations, determining if a download or upload is needed
+     * or if exists conflict due to changes both in local and remote contents of the each file.

      * 
      * 

-     * If download or upload is needed, request the operation to the corresponding service and goes on.
+     * If download or upload is needed, request the operation to the corresponding service and goes 
+     * on.

      * 
      * @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<SynchronizeFileOperation> filesToSyncContents, OwnCloudClient client) {
+    private void startContentSynchronizations(
+            List<SynchronizeFileOperation> filesToSyncContents, OwnCloudClient client
+        ) {

         RemoteOperationResult contentsResult = null;
         for (SynchronizeFileOperation op: filesToSyncContents) {
         RemoteOperationResult contentsResult = null;
         for (SynchronizeFileOperation op: filesToSyncContents) {

-            contentsResult = op.execute(mStorageManager, mContext);   // returns without waiting for upload or download finishes
+            contentsResult = op.execute(mStorageManager, mContext);   // async

             if (!contentsResult.isSuccess()) {
                 if (contentsResult.getCode() == ResultCode.SYNC_CONFLICT) {
                     mConflictsFound++;
                 } else {
                     mFailsInFavouritesFound++;
                     if (contentsResult.getException() != null) {
             if (!contentsResult.isSuccess()) {
                 if (contentsResult.getCode() == ResultCode.SYNC_CONFLICT) {
                     mConflictsFound++;
                 } else {
                     mFailsInFavouritesFound++;
                     if (contentsResult.getException() != null) {

-                        Log_OC.e(TAG, "Error while synchronizing favourites : " +  contentsResult.getLogMessage(), contentsResult.getException());
+                        Log_OC.e(TAG, "Error while synchronizing favourites : " 
+                                +  contentsResult.getLogMessage(), contentsResult.getException());

                     } else {
                     } else {

-                        Log_OC.e(TAG, "Error while synchronizing favourites : " + contentsResult.getLogMessage());
+                        Log_OC.e(TAG, "Error while synchronizing favourites : " 
+                                + contentsResult.getLogMessage());

                     }
                 }
             }   // won't let these fails break the synchronization process
                     }
                 }
             }   // won't let these fails break the synchronization process


@@ -430,11 +468,11 @@ public class SynchronizeFolderOperation extends RemoteOperation {
     
 
     /**
     
 
     /**

-     * Checks the storage path of the OCFile received as parameter. If it's out of the local ownCloud folder,
-     * tries to copy the file inside it. 
+     * Checks the storage path of the OCFile received as parameter. 
+     * If it's out of the local ownCloud folder, tries to copy the file inside it. 

      * 
      * 

-     * If the copy fails, the link to the local file is nullified. The account of forgotten files is kept in 
-     * {@link #mForgottenLocalFiles}
+     * If the copy fails, the link to the local file is nullified. The account of forgotten 
+     * files is kept in {@link #mForgottenLocalFiles}

      *) 
      * @param file      File to check and fix.
      */
      *) 
      * @param file      File to check and fix.
      */


@@ -456,7 +494,9 @@ public class SynchronizeFolderOperation extends RemoteOperation {
                     File expectedParent = expectedFile.getParentFile();
                     expectedParent.mkdirs();
                     if (!expectedParent.isDirectory()) {
                     File expectedParent = expectedFile.getParentFile();
                     expectedParent.mkdirs();
                     if (!expectedParent.isDirectory()) {

-                        throw new IOException("Unexpected error: parent directory could not be created");
+                        throw new IOException(
+                                "Unexpected error: parent directory could not be created"
+                        );

                     }
                     expectedFile.createNewFile();
                     if (!expectedFile.isFile()) {
                     }
                     expectedFile.createNewFile();
                     if (!expectedFile.isFile()) {


@@ -480,12 +520,14 @@ public class SynchronizeFolderOperation extends RemoteOperation {
                     try {
                         if (in != null) in.close();
                     } catch (Exception e) {
                     try {
                         if (in != null) in.close();
                     } catch (Exception e) {

-                        Log_OC.d(TAG, "Weird exception while closing input stream for " + storagePath + " (ignoring)", e);
+                        Log_OC.d(TAG, "Weird exception while closing input stream for " 
+                                + storagePath + " (ignoring)", e);

                     }
                     try {
                         if (out != null) out.close();
                     } catch (Exception e) {
                     }
                     try {
                         if (out != null) out.close();
                     } catch (Exception e) {

-                        Log_OC.d(TAG, "Weird exception while closing output stream for " + expectedPath + " (ignoring)", e);
+                        Log_OC.d(TAG, "Weird exception while closing output stream for " 
+                                + expectedPath + " (ignoring)", e);

                     }
                 }
             }
                     }
                 }
             }


@@ -497,7 +539,8 @@ public class SynchronizeFolderOperation extends RemoteOperation {
         RemoteOperationResult result = null;
         
         // remote request 
         RemoteOperationResult result = null;
         
         // remote request 

-        GetRemoteSharesForFileOperation operation = new GetRemoteSharesForFileOperation(mLocalFolder.getRemotePath(), false, true);
+        GetRemoteSharesForFileOperation operation = 
+                new GetRemoteSharesForFileOperation(mLocalFolder.getRemotePath(), false, true);

         result = operation.execute(client);
         
         if (result.isSuccess()) {
         result = operation.execute(client);
         
         if (result.isSuccess()) {


@@ -532,13 +575,17 @@ public class SynchronizeFolderOperation extends RemoteOperation {
 
     
     /**
 
     
     /**

-     * Sends a message to any application component interested in the progress of the synchronization.
+     * Sends a message to any application component interested in the progress 
+     * of the synchronization.

      * 
      * @param event
      * 
      * @param event

-     * @param dirRemotePath     Remote path of a folder that was just synchronized (with or without success)
+     * @param dirRemotePath     Remote path of a folder that was just synchronized 
+     *                          (with or without success)

      * @param result
      */
      * @param result
      */

-    private void sendLocalBroadcast(String event, String dirRemotePath, RemoteOperationResult result) {
+    private void sendLocalBroadcast(
+            String event, String dirRemotePath, RemoteOperationResult result
+        ) {

         Log_OC.d(TAG, "Send broadcast " + event);
         Intent intent = new Intent(event);
         intent.putExtra(FileSyncAdapter.EXTRA_ACCOUNT_NAME, mAccount.name);
         Log_OC.d(TAG, "Send broadcast " + event);
         Intent intent = new Intent(event);
         intent.putExtra(FileSyncAdapter.EXTRA_ACCOUNT_NAME, mAccount.name);