Merge branch 'develop' into refresh_folder_contents_when_browsed_into

[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 008fb50..b15119a 100644 (file)
--- a/src/com/owncloud/android/operations/SynchronizeFolderOperation.java
+++ b/src/com/owncloud/android/operations/SynchronizeFolderOperation.java
@@ -1,10 +1,9 @@
 /* ownCloud Android client application
 /* ownCloud Android client application

- *   Copyright (C) 2012 Bartek Przybylski
+ *   Copyright (C) 2012-2013 ownCloud Inc.

  *
  *   This program is free software: you can redistribute it and/or modify
  *
  *   This program is free software: you can redistribute it and/or modify

- *   it under the terms of the GNU General Public License as published by
- *   the Free Software Foundation, either version 3 of the License, or
- *   (at your option) any later version.
+ *   it under the terms of the GNU General Public License version 2,
+ *   as published by the Free Software Foundation.

  *
  *   This program is distributed in the hope that it will be useful,
  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  *
  *   This program is distributed in the hope that it will be useful,
  *   but WITHOUT ANY WARRANTY; without even the implied warranty of


@@ -24,6 +23,7 @@ import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;

+import java.util.ArrayList;

 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;


@@ -35,11 +35,13 @@ import org.apache.jackrabbit.webdav.client.methods.PropFindMethod;
 
 import android.accounts.Account;
 import android.content.Context;
 
 import android.accounts.Account;
 import android.content.Context;

-import android.util.Log;
+import android.content.Intent;

 
 

+import com.owncloud.android.Log_OC;

 import com.owncloud.android.datamodel.DataStorageManager;
 import com.owncloud.android.datamodel.OCFile;
 import com.owncloud.android.operations.RemoteOperationResult.ResultCode;
 import com.owncloud.android.datamodel.DataStorageManager;
 import com.owncloud.android.datamodel.OCFile;
 import com.owncloud.android.operations.RemoteOperationResult.ResultCode;

+import com.owncloud.android.syncadapter.FileSyncService;

 import com.owncloud.android.utils.FileStorageUtils;
 
 import eu.alefzero.webdav.WebdavClient;
 import com.owncloud.android.utils.FileStorageUtils;
 
 import eu.alefzero.webdav.WebdavClient;


@@ -65,6 +67,9 @@ public class SynchronizeFolderOperation extends RemoteOperation {
     /** Id of the folder to synchronize in the local database */
     private long mParentId;
     
     /** Id of the folder to synchronize in the local database */
     private long mParentId;
     

+    /** Boolean to indicate if is mandatory to update the folder */
+    private boolean mEnforceMetadataUpdate;
+

     /** Access to the local database */
     private DataStorageManager mStorageManager;
     
     /** Access to the local database */
     private DataStorageManager mStorageManager;
     


@@ -83,16 +88,22 @@ public class SynchronizeFolderOperation extends RemoteOperation {
 
     private Map<String, String> mForgottenLocalFiles;
     
 
     private Map<String, String> mForgottenLocalFiles;
     

+    private boolean mSyncFullAccount;
+    

     
     public SynchronizeFolderOperation(  String remotePath, 
                                         long currentSyncTime, 
     
     public SynchronizeFolderOperation(  String remotePath, 
                                         long currentSyncTime, 

-                                        long parentId, 
+                                        long parentId,
+                                        boolean enforceMetadataUpdate,
+                                        boolean syncFullAccount,

                                         DataStorageManager dataStorageManager, 
                                         Account account, 
                                         Context context ) {
         mRemotePath = remotePath;
         mCurrentSyncTime = currentSyncTime;
         mParentId = parentId;
                                         DataStorageManager dataStorageManager, 
                                         Account account, 
                                         Context context ) {
         mRemotePath = remotePath;
         mCurrentSyncTime = currentSyncTime;
         mParentId = parentId;

+        mEnforceMetadataUpdate = enforceMetadataUpdate;
+        mSyncFullAccount = syncFullAccount;

         mStorageManager = dataStorageManager;
         mAccount = account;
         mContext = context;
         mStorageManager = dataStorageManager;
         mAccount = account;
         mContext = context;


@@ -121,158 +132,194 @@ public class SynchronizeFolderOperation extends RemoteOperation {
         return mChildren;
     }
     
         return mChildren;
     }
     

-    
+    public String getRemotePath() {
+        return mRemotePath;
+    }
+
+    public long getParentId() {
+        return mParentId;
+    }
+

     @Override
     protected RemoteOperationResult run(WebdavClient client) {
         RemoteOperationResult result = null;
         mFailsInFavouritesFound = 0;
         mConflictsFound = 0;
         mForgottenLocalFiles.clear();
     @Override
     protected RemoteOperationResult run(WebdavClient client) {
         RemoteOperationResult result = null;
         mFailsInFavouritesFound = 0;
         mConflictsFound = 0;
         mForgottenLocalFiles.clear();

-        
+        boolean dirChanged = false;
+

         // code before in FileSyncAdapter.fetchData
         PropFindMethod query = null;
         try {
         // code before in FileSyncAdapter.fetchData
         PropFindMethod query = null;
         try {

-            Log.d(TAG, "Synchronizing " + mAccount.name + ", fetching files in " + mRemotePath);
-            
+            Log_OC.d(TAG, "Synchronizing " + mAccount.name + ", fetching files in " + mRemotePath);
+

             // remote request 
             query = new PropFindMethod(client.getBaseUri() + WebdavUtils.encodePath(mRemotePath));
             int status = client.executeMethod(query);
             // remote request 
             query = new PropFindMethod(client.getBaseUri() + WebdavUtils.encodePath(mRemotePath));
             int status = client.executeMethod(query);

-            
+

             // check and process response   - /// TODO take into account all the possible status per child-resource
             if (isMultiStatus(status)) { 
                 MultiStatus resp = query.getResponseBodyAsMultiStatus();
             // check and process response   - /// TODO take into account all the possible status per child-resource
             if (isMultiStatus(status)) { 
                 MultiStatus resp = query.getResponseBodyAsMultiStatus();

-            
-                // synchronize properties of the parent folder, if necessary
-                if (mParentId == DataStorageManager.ROOT_PARENT_ID) {
-                    WebdavEntry we = new WebdavEntry(resp.getResponses()[0], client.getBaseUri().getPath());
-                    OCFile parent = fillOCFile(we);
+
+                // synchronize properties of the parent folder, if necessary 
+                WebdavEntry we = new WebdavEntry(resp.getResponses()[0], client.getBaseUri().getPath());
+
+                // Properties of server folder
+                OCFile parent = fillOCFile(we);
+                // Properties of local folder
+                OCFile localParent = mStorageManager.getFileByPath(mRemotePath);
+                if (localParent == null || !(parent.getEtag().equalsIgnoreCase(localParent.getEtag())) || mEnforceMetadataUpdate) {
+                    if (localParent != null) {
+                        parent.setParentId(localParent.getParentId());
+                    }

                     mStorageManager.saveFile(parent);
                     mStorageManager.saveFile(parent);

-                    mParentId = parent.getFileId();
+                    if (mParentId == DataStorageManager.ROOT_PARENT_ID)
+                        mParentId = parent.getFileId();
+                    dirChanged = true;

                 }
                 }

-                
-                // read contents in folder
-                List<OCFile> updatedFiles = new Vector<OCFile>(resp.getResponses().length - 1);
-                List<SynchronizeFileOperation> filesToSyncContents = new Vector<SynchronizeFileOperation>();
-                for (int i = 1; i < resp.getResponses().length; ++i) {
-                    /// new OCFile instance with the data from the server
-                    WebdavEntry we = new WebdavEntry(resp.getResponses()[i], client.getBaseUri().getPath());
-                    OCFile file = fillOCFile(we);
-                    
-                    /// set data about local state, keeping unchanged former data if existing
-                    file.setLastSyncDateForProperties(mCurrentSyncTime);
-                    OCFile oldFile = mStorageManager.getFileByPath(file.getRemotePath());
-                    if (oldFile != null) {
-                        file.setKeepInSync(oldFile.keepInSync());
-                        if (oldFile.isDown() && oldFile.getLastSyncDateForData() == 0) {
-                            // only should be true after the upgrade to database version 3 (official 1.3.16 release)
-                            file.setLastSyncDateForData(oldFile.getLocalModificationTimestamp());   // assume there are not local changes pending to upload
-                        } else {
-                            file.setLastSyncDateForData(oldFile.getLastSyncDateForData());
+
+                if (dirChanged) {
+                    // read contents in folder
+                    List<String> filesOnServer = new ArrayList<String> (); // Contains the lists of files on server
+                    List<OCFile> updatedFiles = new Vector<OCFile>(resp.getResponses().length - 1);
+                    List<SynchronizeFileOperation> filesToSyncContents = new Vector<SynchronizeFileOperation>();
+                    for (int i = 1; i < resp.getResponses().length; ++i) {
+                        /// new OCFile instance with the data from the server
+                        we = new WebdavEntry(resp.getResponses()[i], client.getBaseUri().getPath());                        
+                        OCFile file = fillOCFile(we);
+
+                        filesOnServer.add(file.getRemotePath()); // Registry the file in the list
+
+                        /// set data about local state, keeping unchanged former data if existing
+                        file.setLastSyncDateForProperties(mCurrentSyncTime);
+                        OCFile oldFile = mStorageManager.getFileByPath(file.getRemotePath());
+
+                        // Check if it is needed to synchronize the folder
+                        if (oldFile != null) {
+                            if (!file.getEtag().equalsIgnoreCase(oldFile.getEtag())) {                            
+                            }                        

                         } 
                         } 

-                        if (oldFile.isDown() && oldFile.getModificationTimestampAtLastSyncForData() == 0) {
-                            // only should be true after the upgrade to database version 4 (official 1.3.16 release)
-                            file.setModificationTimestampAtLastSyncForData(oldFile.getModificationTimestamp()); // assume the file was downloaded not later than the last account synchronization
-                        } else {
-                            file.setModificationTimestampAtLastSyncForData(oldFile.getModificationTimestampAtLastSyncForData());    // not local, but must be kept unchanged when the file contents are not updated
+
+                        if (oldFile != null) { 
+                            file.setKeepInSync(oldFile.keepInSync());
+                            file.setLastSyncDateForData(oldFile.getLastSyncDateForData());
+                            file.setModificationTimestampAtLastSyncForData(oldFile.getModificationTimestampAtLastSyncForData());    // must be kept unchanged when the file contents are not updated
+                            checkAndFixForeignStoragePath(oldFile);
+                            file.setStoragePath(oldFile.getStoragePath());
+                            if (file.isDirectory())
+                                file.setEtag(oldFile.getEtag());
+                        } else
+                            if (file.isDirectory())
+                                file.setEtag("");
+
+                        /// scan default location if local copy of file is not linked in OCFile instance
+                        if (file.getStoragePath() == null && !file.isDirectory()) {
+                            File f = new File(FileStorageUtils.getDefaultSavePathFor(mAccount.name, file));
+                            if (f.exists()) {
+                                file.setStoragePath(f.getAbsolutePath());
+                                file.setLastSyncDateForData(f.lastModified());
+                            }

                         }
                         }

-                        checkAndFixForeignStoragePath(oldFile);
-                        file.setStoragePath(oldFile.getStoragePath());
-                    }

 
 

-                    /// scan default location if local copy of file is not linked in OCFile instance
-                    if (file.getStoragePath() == null && !file.isDirectory()) {
-                        File f = new File(FileStorageUtils.getDefaultSavePathFor(mAccount.name, file));
-                        if (f.exists()) {
-                            file.setStoragePath(f.getAbsolutePath());
-                            file.setLastSyncDateForData(f.lastModified());
+                        /// prepare content synchronization for kept-in-sync files
+                        if (file.keepInSync()) {
+                            SynchronizeFileOperation operation = new SynchronizeFileOperation(  oldFile,        
+                                    file, 
+                                    mStorageManager,
+                                    mAccount,       
+                                    true, 
+                                    false,          
+                                    mContext
+                                    );
+                            filesToSyncContents.add(operation);

                         }
                         }

+
+                        updatedFiles.add(file);

                     }
                     }

-                    
-                    /// prepare content synchronization for kept-in-sync files
-                    if (file.keepInSync()) {
-                        SynchronizeFileOperation operation = new SynchronizeFileOperation(  oldFile,        
-                                                                                            file, 
-                                                                                            mStorageManager,
-                                                                                            mAccount,       
-                                                                                            true, 
-                                                                                            false,          
-                                                                                            mContext
-                                                                                            );
-                        filesToSyncContents.add(operation);
-                    }
-                
-                    updatedFiles.add(file);
-                }
-                                
-                // save updated contents in local database; all at once, trying to get a best performance in database update (not a big deal, indeed)
-                mStorageManager.saveFiles(updatedFiles);
-                
-                // request for the synchronization of files AFTER saving last properties
-                SynchronizeFileOperation op = null;
-                RemoteOperationResult contentsResult = null;
-                for (int i=0; i < filesToSyncContents.size(); i++) {
-                    op = filesToSyncContents.get(i);
-                    contentsResult = op.execute(client);   // returns without waiting for upload or download finishes
-                    if (!contentsResult.isSuccess()) {
-                        if (contentsResult.getCode() == ResultCode.SYNC_CONFLICT) {
-                            mConflictsFound++;
-                        } else {
-                            mFailsInFavouritesFound++;
-                            if (contentsResult.getException() != null) {
-                                Log.d(TAG, "Error while synchronizing favourites : " +  contentsResult.getLogMessage(), contentsResult.getException());
+
+                    // save updated contents in local database; all at once, trying to get a best performance in database update (not a big deal, indeed)
+                    mStorageManager.saveFiles(updatedFiles);
+
+                    // request for the synchronization of files AFTER saving last properties
+                    RemoteOperationResult contentsResult = null;
+                    for (SynchronizeFileOperation op: filesToSyncContents) {
+                        contentsResult = op.execute(client);   // returns without waiting for upload or download finishes
+                        if (!contentsResult.isSuccess()) {
+                            if (contentsResult.getCode() == ResultCode.SYNC_CONFLICT) {
+                                mConflictsFound++;

                             } else {
                             } else {

-                                Log.d(TAG, "Error while synchronizing favourites : " + contentsResult.getLogMessage());
+                                mFailsInFavouritesFound++;
+                                if (contentsResult.getException() != null) {
+                                    Log_OC.e(TAG, "Error while synchronizing favourites : " +  contentsResult.getLogMessage(), contentsResult.getException());
+                                } else {
+                                    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
+                    }

 
 

-                    
-                // removal of obsolete files
-                mChildren = mStorageManager.getDirectoryContent(mStorageManager.getFileById(mParentId));
-                OCFile file;
-                String currentSavePath = FileStorageUtils.getSavePath(mAccount.name);
-                for (int i=0; i < mChildren.size(); ) {
-                    file = mChildren.get(i);
-                    if (file.getLastSyncDateForProperties() != mCurrentSyncTime) {
-                        Log.d(TAG, "removing file: " + file);
-                        mStorageManager.removeFile(file, (file.isDown() && file.getStoragePath().startsWith(currentSavePath)));
-                        mChildren.remove(i);
-                    } else {
-                        i++;
+                    // removal of obsolete files
+                    mChildren = mStorageManager.getDirectoryContent(mStorageManager.getFileById(mParentId));
+                    OCFile file;
+                    String currentSavePath = FileStorageUtils.getSavePath(mAccount.name);
+                    for (int i=0; i < mChildren.size(); ) {
+                        file = mChildren.get(i);
+                        if (file.getLastSyncDateForProperties() != mCurrentSyncTime) {
+                            Log_OC.d(TAG, "removing file: " + file);
+                            mStorageManager.removeFile(file, (file.isDown() && file.getStoragePath().startsWith(currentSavePath)));
+                            mChildren.remove(i);
+                        } else {
+                            i++;
+                        }

                     }
                     }

+
+                } else {
+                    client.exhaustResponse(query.getResponseBodyAsStream());

                 }
                 }

-                
-            } else {
-                client.exhaustResponse(query.getResponseBodyAsStream());

             }
             }

-            
+

             // prepare result object
             // prepare result object

-            if (isMultiStatus(status)) {
+            if (!dirChanged) {
+                result = new RemoteOperationResult(ResultCode.OK_NO_CHANGES_ON_DIR);
+                mChildren = mStorageManager.getDirectoryContent(mStorageManager.getFileById(mParentId));
+
+            } else if (isMultiStatus(status)) {

                 if (mConflictsFound > 0  || mFailsInFavouritesFound > 0) { 
                     result = new RemoteOperationResult(ResultCode.SYNC_CONFLICT);   // should be different result, but will do the job
                 if (mConflictsFound > 0  || mFailsInFavouritesFound > 0) { 
                     result = new RemoteOperationResult(ResultCode.SYNC_CONFLICT);   // should be different result, but will do the job

-                            
+

                 } else {
                 } else {

-                    result = new RemoteOperationResult(true, status);
+                    result = new RemoteOperationResult(true, status, query.getResponseHeaders());

                 }
             } else {
                 }
             } else {

-                result = new RemoteOperationResult(false, status);
+                result = new RemoteOperationResult(false, status, query.getResponseHeaders());

             }
             }

-            Log.i(TAG, "Synchronizing " + mAccount.name + ", folder " + mRemotePath + ": " + result.getLogMessage());
-            
-            
+            Log_OC.i(TAG, "Synchronizing " + mAccount.name + ", folder " + mRemotePath + ": " + result.getLogMessage());
+

         } catch (Exception e) {
             result = new RemoteOperationResult(e);
         } catch (Exception e) {
             result = new RemoteOperationResult(e);

-            Log.e(TAG, "Synchronizing " + mAccount.name + ", folder " + mRemotePath + ": " + result.getLogMessage(), result.getException());
+            

 
         } finally {
             if (query != null)
                 query.releaseConnection();  // let the connection available for other methods
 
         } finally {
             if (query != null)
                 query.releaseConnection();  // let the connection available for other methods

+            if (result.isSuccess()) {
+                Log_OC.i(TAG, "Synchronizing " + mAccount.name + ", folder " + mRemotePath + ": " + result.getLogMessage());
+            } else {
+                if (result.isException()) {
+                    Log_OC.e(TAG, "Synchronizing " + mAccount.name + ", folder " + mRemotePath + ": " + result.getLogMessage(), result.getException());
+                } else {
+                    Log_OC.e(TAG, "Synchronizing " + mAccount.name + ", folder " + mRemotePath + ": " + result.getLogMessage());
+                }
+            }
+            
+            if (!mSyncFullAccount) {            
+                sendStickyBroadcast(false, mRemotePath, result);
+            }

         }
         }

-        
+

         return result;
     }
         return result;
     }

-    
+

 
     public boolean isMultiStatus(int status) {
         return (status == HttpStatus.SC_MULTI_STATUS); 
 
     public boolean isMultiStatus(int status) {
         return (status == HttpStatus.SC_MULTI_STATUS); 


@@ -292,6 +339,7 @@ public class SynchronizeFolderOperation extends RemoteOperation {
         file.setMimetype(we.contentType());
         file.setModificationTimestamp(we.modifiedTimestamp());
         file.setParentId(mParentId);
         file.setMimetype(we.contentType());
         file.setModificationTimestamp(we.modifiedTimestamp());
         file.setParentId(mParentId);

+        file.setEtag(we.etag());

         return file;
     }
     
         return file;
     }
     


@@ -302,7 +350,7 @@ public class SynchronizeFolderOperation extends RemoteOperation {
      * 
      * 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.
      */
     private void checkAndFixForeignStoragePath(OCFile file) {
      * @param file      File to check and fix.
      */
     private void checkAndFixForeignStoragePath(OCFile file) {


@@ -339,7 +387,7 @@ public class SynchronizeFolderOperation extends RemoteOperation {
                     file.setStoragePath(expectedPath);
                     
                 } catch (Exception e) {
                     file.setStoragePath(expectedPath);
                     
                 } catch (Exception e) {

-                    Log.e(TAG, "Exception while copying foreign file " + expectedPath, e);
+                    Log_OC.e(TAG, "Exception while copying foreign file " + expectedPath, e);

                     mForgottenLocalFiles.put(file.getRemotePath(), storagePath);
                     file.setStoragePath(null);
                     
                     mForgottenLocalFiles.put(file.getRemotePath(), storagePath);
                     file.setStoragePath(null);
                     


@@ -347,17 +395,35 @@ public class SynchronizeFolderOperation extends RemoteOperation {
                     try {
                         if (in != null) in.close();
                     } catch (Exception e) {
                     try {
                         if (in != null) in.close();
                     } catch (Exception e) {

-                        Log.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.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);

                     }
                 }
             }
         }
     }
 
                     }
                 }
             }
         }
     }
 

+    /**
+     * Sends a message to any application component interested in the progress of the synchronization.
+     * 
+     * @param inProgress        'True' when the synchronization progress is not finished.
+     * @param dirRemotePath     Remote path of a folder that was just synchronized (with or without success)
+     */
+    private void sendStickyBroadcast(boolean inProgress, String dirRemotePath, RemoteOperationResult result) {
+        Intent i = new Intent(FileSyncService.SYNC_MESSAGE);
+        i.putExtra(FileSyncService.IN_PROGRESS, inProgress);
+        i.putExtra(FileSyncService.ACCOUNT_NAME, mAccount.name);
+        if (dirRemotePath != null) {
+            i.putExtra(FileSyncService.SYNC_FOLDER_REMOTE_PATH, dirRemotePath);
+        }
+        if (result != null) {
+            i.putExtra(FileSyncService.SYNC_RESULT, result);
+        }
+        mContext.sendStickyBroadcast(i);
+    }

 
 }
 
 }