OC-2280: Isolate the code for ReadFile (PROPFIND 0) to remove local dependences

[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 f8b69f4..52f60e8 100644 (file)
--- a/src/com/owncloud/android/operations/SynchronizeFolderOperation.java
+++ b/src/com/owncloud/android/operations/SynchronizeFolderOperation.java
@@ -29,6 +29,7 @@ import java.util.Map;
 import java.util.Vector;
 
 import org.apache.http.HttpStatus;
 import java.util.Vector;
 
 import org.apache.http.HttpStatus;

+import org.apache.jackrabbit.webdav.DavConstants;

 import org.apache.jackrabbit.webdav.MultiStatus;
 import org.apache.jackrabbit.webdav.client.methods.PropFindMethod;
 
 import org.apache.jackrabbit.webdav.MultiStatus;
 import org.apache.jackrabbit.webdav.client.methods.PropFindMethod;
 


@@ -36,16 +37,19 @@ import android.accounts.Account;
 import android.content.Context;
 import android.content.Intent;
 
 import android.content.Context;
 import android.content.Intent;
 

-import com.owncloud.android.Log_OC;
-import com.owncloud.android.datamodel.DataStorageManager;
+import com.owncloud.android.datamodel.FileDataStorageManager;

 import com.owncloud.android.datamodel.OCFile;
 import com.owncloud.android.datamodel.OCFile;

-import com.owncloud.android.operations.RemoteOperationResult.ResultCode;
+import com.owncloud.android.oc_framework.network.webdav.WebdavClient;
+import com.owncloud.android.oc_framework.network.webdav.WebdavEntry;
+import com.owncloud.android.oc_framework.network.webdav.WebdavUtils;
+import com.owncloud.android.oc_framework.operations.RemoteOperation;
+import com.owncloud.android.oc_framework.operations.RemoteOperationResult;
+import com.owncloud.android.oc_framework.operations.RemoteOperationResult.ResultCode;
+import com.owncloud.android.oc_framework.operations.remote.ReadRemoteFileOperation;

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

+import com.owncloud.android.utils.Log_OC;

 
 

-import eu.alefzero.webdav.WebdavClient;
-import eu.alefzero.webdav.WebdavEntry;
-import eu.alefzero.webdav.WebdavUtils;

 
 
 /**
 
 
 /**


@@ -70,11 +74,8 @@ public class SynchronizeFolderOperation extends RemoteOperation {
     /** Remote folder to synchronize */
     private OCFile mLocalFolder;
     
     /** Remote folder to synchronize */
     private OCFile mLocalFolder;
     

-    /** 'True' means that the properties of the folder should be updated also, not just its content */
-    private boolean mUpdateFolderProperties;
-

     /** Access to the local database */
     /** Access to the local database */

-    private DataStorageManager mStorageManager;
+    private FileDataStorageManager mStorageManager;

     
     /** Account where the file to synchronize belongs */
     private Account mAccount;
     
     /** Account where the file to synchronize belongs */
     private Account mAccount;


@@ -96,6 +97,9 @@ public class SynchronizeFolderOperation extends RemoteOperation {
 
     /** 'True' means that this operation is part of a full account synchronization */ 
     private boolean mSyncFullAccount;
 
     /** 'True' means that this operation is part of a full account synchronization */ 
     private boolean mSyncFullAccount;

+
+    /** 'True' means that the remote folder changed from last synchronization and should be fetched */
+    private boolean mRemoteFolderChanged;

     
     
     /**
     
     
     /**


@@ -112,19 +116,18 @@ public class SynchronizeFolderOperation extends RemoteOperation {
      */
     public SynchronizeFolderOperation(  OCFile folder, 
                                         long currentSyncTime, 
      */
     public SynchronizeFolderOperation(  OCFile folder, 
                                         long currentSyncTime, 

-                                        boolean updateFolderProperties,

                                         boolean syncFullAccount,
                                         boolean syncFullAccount,

-                                        DataStorageManager dataStorageManager, 
+                                        FileDataStorageManager dataStorageManager, 

                                         Account account, 
                                         Context context ) {
         mLocalFolder = folder;
         mCurrentSyncTime = currentSyncTime;
                                         Account account, 
                                         Context context ) {
         mLocalFolder = folder;
         mCurrentSyncTime = currentSyncTime;

-        mUpdateFolderProperties = updateFolderProperties;

         mSyncFullAccount = syncFullAccount;
         mStorageManager = dataStorageManager;
         mAccount = account;
         mContext = context;
         mForgottenLocalFiles = new HashMap<String, String>();
         mSyncFullAccount = syncFullAccount;
         mStorageManager = dataStorageManager;
         mAccount = account;
         mContext = context;
         mForgottenLocalFiles = new HashMap<String, String>();

+        mRemoteFolderChanged = false;

     }
     
     
     }
     
     


@@ -160,6 +163,64 @@ public class SynchronizeFolderOperation extends RemoteOperation {
         mFailsInFavouritesFound = 0;
         mConflictsFound = 0;
         mForgottenLocalFiles.clear();
         mFailsInFavouritesFound = 0;
         mConflictsFound = 0;
         mForgottenLocalFiles.clear();

+        
+        result = checkForChanges(client);
+        
+        if (result.isSuccess()) {
+            if (mRemoteFolderChanged) {
+                result = fetchAndSyncRemoteFolder(client);
+            } else {
+                mChildren = mStorageManager.getFolderContent(mLocalFolder);
+            }
+        }
+        
+        if (!mSyncFullAccount) {            
+            sendStickyBroadcast(false, mLocalFolder.getRemotePath(), result);
+        }
+
+        return result;
+        
+    }
+
+
+    private RemoteOperationResult checkForChanges(WebdavClient client) {
+        mRemoteFolderChanged = false;
+        RemoteOperationResult result = null;
+        String remotePath = null;
+
+            remotePath = mLocalFolder.getRemotePath();
+            Log_OC.d(TAG, "Checking changes in " + mAccount.name + remotePath);
+
+            // remote request 
+            ReadRemoteFileOperation operation = new ReadRemoteFileOperation(remotePath);
+            result = operation.execute(client);
+            if (result.isSuccess()){
+                OCFile remoteFolder = FileStorageUtils.fillOCFile(result.getData().get(0));
+                
+             // check if remote and local folder are different
+              mRemoteFolderChanged = !(remoteFolder.getEtag().equalsIgnoreCase(mLocalFolder.getEtag()));
+              
+              result = new RemoteOperationResult(ResultCode.OK);
+
+              Log_OC.i(TAG, "Checked " + mAccount.name + remotePath + " : " + (mRemoteFolderChanged ? "changed" : "not changed"));
+            } else {
+                // check failed
+                if (result.getCode() == ResultCode.FILE_NOT_FOUND) {
+                    removeLocalFolder();
+                }
+                if (result.isException()) {
+                    Log_OC.e(TAG, "Checked " + mAccount.name + remotePath  + " : " + result.getLogMessage(), result.getException());
+                } else {
+                    Log_OC.e(TAG, "Checked " + mAccount.name + remotePath + " : " + result.getLogMessage());
+                }
+            }
+            
+        return result;
+    }
+
+
+    private RemoteOperationResult fetchAndSyncRemoteFolder(WebdavClient client) {
+        RemoteOperationResult result = null;

         String remotePath = null;
         PropFindMethod query = null;
         try {
         String remotePath = null;
         PropFindMethod query = null;
         try {


@@ -167,30 +228,25 @@ public class SynchronizeFolderOperation extends RemoteOperation {
             Log_OC.d(TAG, "Synchronizing " + mAccount.name + remotePath);
 
             // remote request 
             Log_OC.d(TAG, "Synchronizing " + mAccount.name + remotePath);
 
             // remote request 

-            query = new PropFindMethod(client.getBaseUri() + WebdavUtils.encodePath(remotePath));
+            query = new PropFindMethod(client.getBaseUri() + WebdavUtils.encodePath(remotePath),
+                    DavConstants.PROPFIND_ALL_PROP,
+                    DavConstants.DEPTH_1);

             int status = client.executeMethod(query);
 
             // check and process response
             if (isMultiStatus(status)) {
             int status = client.executeMethod(query);
 
             // check and process response
             if (isMultiStatus(status)) {

-                boolean folderChanged = synchronizeData(query.getResponseBodyAsMultiStatus(), client);
-                if (folderChanged) {
-                    if (mConflictsFound > 0  || mFailsInFavouritesFound > 0) { 
-                        result = new RemoteOperationResult(ResultCode.SYNC_CONFLICT);   // should be different result, but will do the job
-                    } else {
-                        result = new RemoteOperationResult(true, status, query.getResponseHeaders());
-                    }
+                synchronizeData(query.getResponseBodyAsMultiStatus(), client);
+                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(ResultCode.OK_NO_CHANGES_ON_DIR);
+                    result = new RemoteOperationResult(true, status, query.getResponseHeaders());

                 }
                 
             } else {
                 // synchronization failed
                 client.exhaustResponse(query.getResponseBodyAsStream());
                 if (status == HttpStatus.SC_NOT_FOUND) {
                 }
                 
             } else {
                 // synchronization failed
                 client.exhaustResponse(query.getResponseBodyAsStream());
                 if (status == HttpStatus.SC_NOT_FOUND) {

-                    if (mStorageManager.fileExists(mLocalFolder.getFileId())) {
-                        String currentSavePath = FileStorageUtils.getSavePath(mAccount.name);
-                        mStorageManager.removeDirectory(mLocalFolder, true, (mLocalFolder.isDown() && mLocalFolder.getStoragePath().startsWith(currentSavePath)));
-                    }
+                    removeLocalFolder();

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


@@ -212,15 +268,19 @@ public class SynchronizeFolderOperation extends RemoteOperation {
                 }
             }
             
                 }
             }
             

-            if (!mSyncFullAccount) {            
-                sendStickyBroadcast(false, remotePath, result);
-            }

         }
         }

-

         return result;
     }
 
 
         return result;
     }
 
 

+    private void removeLocalFolder() {
+        if (mStorageManager.fileExists(mLocalFolder.getFileId())) {
+            String currentSavePath = FileStorageUtils.getSavePath(mAccount.name);
+            mStorageManager.removeFolder(mLocalFolder, true, (mLocalFolder.isDown() && mLocalFolder.getStoragePath().startsWith(currentSavePath)));
+        }
+    }
+
+

     /**
      *  Synchronizes the data retrieved from the server about the contents of the target folder 
      *  with the current data in the local database.
     /**
      *  Synchronizes the data retrieved from the server about the contents of the target folder 
      *  with the current data in the local database.


@@ -233,9 +293,9 @@ public class SynchronizeFolderOperation extends RemoteOperation {
      *                          retrieved.  
      *  @return                 'True' when any change was made in the local data, 'false' otherwise.
      */
      *                          retrieved.  
      *  @return                 'True' when any change was made in the local data, 'false' otherwise.
      */

-    private boolean synchronizeData(MultiStatus dataInServer, WebdavClient client) {
+    private void synchronizeData(MultiStatus dataInServer, WebdavClient client) {

         // get 'fresh data' from the database
         // get 'fresh data' from the database

-        mLocalFolder = mStorageManager.getFileById(mLocalFolder.getFileId());
+        mLocalFolder = mStorageManager.getFileByPath(mLocalFolder.getRemotePath());

         
         // parse data from remote folder 
         WebdavEntry we = new WebdavEntry(dataInServer.getResponses()[0], client.getBaseUri().getPath());
         
         // parse data from remote folder 
         WebdavEntry we = new WebdavEntry(dataInServer.getResponses()[0], client.getBaseUri().getPath());


@@ -243,107 +303,80 @@ public class SynchronizeFolderOperation extends RemoteOperation {
         remoteFolder.setParentId(mLocalFolder.getParentId());
         remoteFolder.setFileId(mLocalFolder.getFileId());
         
         remoteFolder.setParentId(mLocalFolder.getParentId());
         remoteFolder.setFileId(mLocalFolder.getFileId());
         

-        // check if remote and local folder are different
-        boolean folderChanged = !(remoteFolder.getEtag().equalsIgnoreCase(mLocalFolder.getEtag()));
+        Log_OC.d(TAG, "Remote folder " + mLocalFolder.getRemotePath() + " changed - starting update of local data ");

         
         

-        if (!folderChanged) {
-            if (mUpdateFolderProperties) {  // TODO check if this is really necessary
-                mStorageManager.saveFile(remoteFolder);
-            }
-            
-            mChildren = mStorageManager.getDirectoryContent(mLocalFolder);
-            
-        } else {
-            // read info of folder contents
-            List<OCFile> updatedFiles = new Vector<OCFile>(dataInServer.getResponses().length - 1);
-            List<SynchronizeFileOperation> filesToSyncContents = new Vector<SynchronizeFileOperation>();
+        List<OCFile> updatedFiles = new Vector<OCFile>(dataInServer.getResponses().length - 1);
+        List<SynchronizeFileOperation> filesToSyncContents = new Vector<SynchronizeFileOperation>();
+
+        // get current data about local contents of the folder to synchronize
+        List<OCFile> localFiles = mStorageManager.getFolderContent(mLocalFolder);
+        Map<String, OCFile> localFilesMap = new HashMap<String, OCFile>(localFiles.size());
+        for (OCFile file : localFiles) {
+            localFilesMap.put(file.getRemotePath(), file);
+        }
+        
+        // loop to update every child
+        OCFile remoteFile = null, localFile = null;
+        for (int i = 1; i < dataInServer.getResponses().length; ++i) {
+            /// new OCFile instance with the data from the server
+            we = new WebdavEntry(dataInServer.getResponses()[i], client.getBaseUri().getPath());                        
+            remoteFile = fillOCFile(we);
+            remoteFile.setParentId(mLocalFolder.getFileId());
+
+            /// retrieve local data for the read file 
+            //localFile = mStorageManager.getFileByPath(remoteFile.getRemotePath());
+            localFile = localFilesMap.remove(remoteFile.getRemotePath());

             
             

-            // loop to update every child
-            OCFile remoteFile = null, localFile = null;
-            for (int i = 1; i < dataInServer.getResponses().length; ++i) {
-                /// new OCFile instance with the data from the server
-                we = new WebdavEntry(dataInServer.getResponses()[i], client.getBaseUri().getPath());                        
-                remoteFile = fillOCFile(we);
-                remoteFile.setParentId(mLocalFolder.getFileId());
-
-                /// retrieve local data for the read file 
-                localFile = mStorageManager.getFileByPath(remoteFile.getRemotePath());
-                
-                /// add to the remoteFile (the new one) data about LOCAL STATE (not existing in the server side)
-                remoteFile.setLastSyncDateForProperties(mCurrentSyncTime);
-                if (localFile != null) {
-                    // properties of local state are kept unmodified 
-                    remoteFile.setKeepInSync(localFile.keepInSync());
-                    remoteFile.setLastSyncDateForData(localFile.getLastSyncDateForData());
-                    remoteFile.setModificationTimestampAtLastSyncForData(localFile.getModificationTimestampAtLastSyncForData());
-                    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)
-                } else {
-                    remoteFile.setEtag(""); // remote eTag will not be updated unless contents are synchronized (Synchronize[File|Folder]Operation with remoteFile as parameter)
-                }
-
-                /// check and fix, if need, local storage path
-                checkAndFixForeignStoragePath(remoteFile);      // fixing old policy - now local files must be copied into the ownCloud local folder 
-                searchForLocalFileInDefaultPath(remoteFile);    // legacy   
-
-                /// prepare content synchronization for kept-in-sync files
-                if (remoteFile.keepInSync()) {
-                    SynchronizeFileOperation operation = new SynchronizeFileOperation(  localFile,        
-                                                                                        remoteFile, 
-                                                                                        mStorageManager,
-                                                                                        mAccount,       
-                                                                                        true, 
-                                                                                        false,          
-                                                                                        mContext
-                                                                                        );
-                    filesToSyncContents.add(operation);
+            /// add to the remoteFile (the new one) data about LOCAL STATE (not existing in the server side)
+            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.setStoragePath(localFile.getStoragePath());
+                remoteFile.setEtag(localFile.getEtag());    // eTag will not be updated unless contents are synchronized (Synchronize[File|Folder]Operation with remoteFile as parameter)
+                if (remoteFile.isFolder()) {
+                    remoteFile.setFileLength(localFile.getFileLength()); // TODO move operations about size of folders to FileContentProvider

                 }
                 }

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

             }
 
             }
 

-            // 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 file contents AFTER saving current remote properties
-            startContentSynchronizations(filesToSyncContents, client);
-
-            // removal of obsolete files
-            removeObsoleteFiles();
-           
-            // must be done AFTER saving all the children information, so that eTag is not updated in the database in case of unexpected exceptions
-            mStorageManager.saveFile(remoteFolder);
+            /// check and fix, if needed, local storage path
+            checkAndFixForeignStoragePath(remoteFile);      // fixing old policy - now local files must be copied into the ownCloud local folder 
+            searchForLocalFileInDefaultPath(remoteFile);    // legacy   
+
+            /// prepare content synchronization for kept-in-sync files
+            if (remoteFile.keepInSync()) {
+                SynchronizeFileOperation operation = new SynchronizeFileOperation(  localFile,        
+                                                                                    remoteFile, 
+                                                                                    mStorageManager,
+                                                                                    mAccount,       
+                                                                                    true, 
+                                                                                    mContext
+                                                                                    );
+                filesToSyncContents.add(operation);
+            }

             
             

+            updatedFiles.add(remoteFile);

         }
         }

-        
-        return folderChanged;
-        
-    }

 
 

+        // save updated contents in local database; all at once, trying to get a best performance in database update (not a big deal, indeed)
+        mStorageManager.saveFolder(remoteFolder, updatedFiles, localFilesMap.values());

 
 

-    /**
-     *  Removes obsolete children in the folder after saving all the new data.
-     */
-    private void removeObsoleteFiles() {
-        mChildren = mStorageManager.getDirectoryContent(mLocalFolder);
-        OCFile file;
-        for (int i=0; i < mChildren.size(); ) {
-            file = mChildren.get(i);
-            if (file.getLastSyncDateForProperties() != mCurrentSyncTime) {
-                if (file.isDirectory()) {
-                    Log_OC.d(TAG, "removing folder: " + file);
-                    mStorageManager.removeDirectory(file, true, true);
-                } else {
-                    Log_OC.d(TAG, "removing file: " + file);
-                    mStorageManager.removeFile(file, true);
-                }
-                mChildren.remove(i);
-            } else {
-                i++;
-            }
-        }
-    }
+        // request for the synchronization of file contents AFTER saving current remote properties
+        startContentSynchronizations(filesToSyncContents, client);

 
 

+        // removal of obsolete files
+        //removeObsoleteFiles();
+       
+        // must be done AFTER saving all the children information, so that eTag is not updated in the database in case of unexpected exceptions
+        //mStorageManager.saveFile(remoteFolder);
+        mChildren = updatedFiles;
+        
+    }

 
     /**
      * Performs a list of synchronization operations, determining if a download or upload is needed or
 
     /**
      * Performs a list of synchronization operations, determining if a download or upload is needed or


@@ -459,7 +492,6 @@ public class SynchronizeFolderOperation extends RemoteOperation {
         }
     }
 
         }
     }
 

-

     /**
      * Scans the default location for saving local copies of files searching for
      * a 'lost' file with the same full name as the {@link OCFile} received as 
     /**
      * Scans the default location for saving local copies of files searching for
      * a 'lost' file with the same full name as the {@link OCFile} received as 


@@ -468,7 +500,7 @@ public class SynchronizeFolderOperation extends RemoteOperation {
      * @param file      File to associate a possible 'lost' local file.
      */
     private void searchForLocalFileInDefaultPath(OCFile file) {
      * @param file      File to associate a possible 'lost' local file.
      */
     private void searchForLocalFileInDefaultPath(OCFile file) {

-        if (file.getStoragePath() == null && !file.isDirectory()) {
+        if (file.getStoragePath() == null && !file.isFolder()) {

             File f = new File(FileStorageUtils.getDefaultSavePathFor(mAccount.name, file));
             if (f.exists()) {
                 file.setStoragePath(f.getAbsolutePath());
             File f = new File(FileStorageUtils.getDefaultSavePathFor(mAccount.name, file));
             if (f.exists()) {
                 file.setStoragePath(f.getAbsolutePath());


@@ -485,7 +517,7 @@ public class SynchronizeFolderOperation extends RemoteOperation {
      * @param dirRemotePath     Remote path of a folder that was just synchronized (with or without success)
      */
     private void sendStickyBroadcast(boolean inProgress, String dirRemotePath, RemoteOperationResult result) {
      * @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);
+        Intent i = new Intent(FileSyncService.getSyncMessage());

         i.putExtra(FileSyncService.IN_PROGRESS, inProgress);
         i.putExtra(FileSyncService.ACCOUNT_NAME, mAccount.name);
         if (dirRemotePath != null) {
         i.putExtra(FileSyncService.IN_PROGRESS, inProgress);
         i.putExtra(FileSyncService.ACCOUNT_NAME, mAccount.name);
         if (dirRemotePath != null) {


@@ -497,4 +529,9 @@ public class SynchronizeFolderOperation extends RemoteOperation {
         mContext.sendStickyBroadcast(i);
     }
 
         mContext.sendStickyBroadcast(i);
     }
 

+
+    public boolean getRemoteFolderChanged() {
+        return mRemoteFolderChanged;
+    }
+

 }
 }