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 04fb4db..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


@@ -18,22 +17,32 @@
 
 package com.owncloud.android.operations;
 
 
 package com.owncloud.android.operations;
 

+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;

 import java.io.IOException;
 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.List;

+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.DavException;

 import org.apache.jackrabbit.webdav.MultiStatus;
 import org.apache.jackrabbit.webdav.client.methods.PropFindMethod;
 
 import android.accounts.Account;
 import org.apache.jackrabbit.webdav.MultiStatus;
 import org.apache.jackrabbit.webdav.client.methods.PropFindMethod;
 
 import android.accounts.Account;

+import android.content.Context;

 import android.content.Intent;
 import android.content.Intent;

-import android.util.Log;

 
 

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

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

-import com.owncloud.android.files.services.FileDownloader;
+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 eu.alefzero.webdav.WebdavEntry;
 
 import eu.alefzero.webdav.WebdavClient;
 import eu.alefzero.webdav.WebdavEntry;


@@ -47,7 +56,7 @@ import eu.alefzero.webdav.WebdavUtils;
  */
 public class SynchronizeFolderOperation extends RemoteOperation {
 
  */
 public class SynchronizeFolderOperation extends RemoteOperation {
 

-    private static final String TAG = SynchronizeFolderOperation.class.getCanonicalName();
+    private static final String TAG = SynchronizeFolderOperation.class.getSimpleName();

 
     /** Remote folder to synchronize */
     private String mRemotePath;
 
     /** Remote folder to synchronize */
     private String mRemotePath;


@@ -58,102 +67,260 @@ 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 */
     /** Access to the local database */

-    private FileDataStorageManager mStorageManager;
+    private DataStorageManager mStorageManager;

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

+    /** Android context; necessary to send requests to the download service; maybe something to refactor */
+    private Context mContext;
+    
+    /** Files and folders contained in the synchronized folder */
+    private List<OCFile> mChildren;
+
+    private int mConflictsFound;
+
+    private int mFailsInFavouritesFound;
+
+    private Map<String, String> mForgottenLocalFiles;
+    
+    private boolean mSyncFullAccount;

     
     

-    SynchronizeFolderOperation(String remotePath, long currentSyncTime, long parentId, FileDataStorageManager storageManager, Account account) {
+    
+    public SynchronizeFolderOperation(  String remotePath, 
+                                        long currentSyncTime, 
+                                        long parentId,
+                                        boolean enforceMetadataUpdate,
+                                        boolean syncFullAccount,
+                                        DataStorageManager dataStorageManager, 
+                                        Account account, 
+                                        Context context ) {

         mRemotePath = remotePath;
         mCurrentSyncTime = currentSyncTime;
         mParentId = parentId;
         mRemotePath = remotePath;
         mCurrentSyncTime = currentSyncTime;
         mParentId = parentId;

-        mStorageManager = storageManager;
+        mEnforceMetadataUpdate = enforceMetadataUpdate;
+        mSyncFullAccount = syncFullAccount;
+        mStorageManager = dataStorageManager;

         mAccount = account;
         mAccount = account;

+        mContext = context;
+        mForgottenLocalFiles = new HashMap<String, String>();
+    }
+    
+    
+    public int getConflictsFound() {
+        return mConflictsFound;
+    }
+    
+    public int getFailsInFavouritesFound() {
+        return mFailsInFavouritesFound;

     }
     
     }
     

+    public Map<String, String> getForgottenLocalFiles() {
+        return mForgottenLocalFiles;
+    }

     
     

+    /**
+     * 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.
+     */
+    public List<OCFile> getChildren() {
+        return mChildren;
+    }
+    
+    public String getRemotePath() {
+        return mRemotePath;
+    }
+
+    public long getParentId() {
+        return mParentId;
+    }
+

     @Override
     protected RemoteOperationResult run(WebdavClient client) {
         RemoteOperationResult result = null;
     @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;
         // code before in FileSyncAdapter.fetchData
         PropFindMethod query = null;

-        Vector<OCFile> children = null;

         try {
         try {

-            Log.d(TAG, "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
+
+            // check and process response   - /// TODO take into account all the possible status per child-resource

             if (isMultiStatus(status)) { 
             if (isMultiStatus(status)) { 

-                /// TODO take into account all the possible status per child-resource
-                

                 MultiStatus resp = query.getResponseBodyAsMultiStatus();
                 MultiStatus resp = query.getResponseBodyAsMultiStatus();

-            
-                // read contents in folder
-                List<OCFile> updatedFiles = new Vector<OCFile>(resp.getResponses().length - 1);
-                for (int i = 1; i < resp.getResponses().length; ++i) {
-                    WebdavEntry we = new WebdavEntry(resp.getResponses()[i], client.getBaseUri().getPath());
-                    OCFile file = fillOCFile(we);
-                    file.setParentId(mParentId);
-                    OCFile oldFile = mStorageManager.getFileByPath(file.getRemotePath());
-                    if (oldFile != null) {
-                        if (oldFile.keepInSync() && file.getModificationTimestamp() > oldFile.getModificationTimestamp()) {
-                            requestContentDownload(file);
-                        }
-                        file.setKeepInSync(oldFile.keepInSync());
+
+                // 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());

                     }
                     }

-                
-                    updatedFiles.add(file);
+                    mStorageManager.saveFile(parent);
+                    if (mParentId == DataStorageManager.ROOT_PARENT_ID)
+                        mParentId = parent.getFileId();
+                    dirChanged = true;

                 }
                 }

-                
-                
-                // 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);
-
-                
-                // removal of obsolete files
-                children = mStorageManager.getDirectoryContent(mStorageManager.getFileById(mParentId));
-                OCFile file;
-                String currentSavePath = FileDownloader.getSavePath(mAccount.name);
-                for (int i=0; i < children.size(); ) {
-                    file = children.get(i);
-                    if (file.getLastSyncDate() != mCurrentSyncTime) {
-                        Log.d(TAG, "removing file: " + file);
-                        mStorageManager.removeFile(file, (file.isDown() && file.getStoragePath().startsWith(currentSavePath)));
-                        children.remove(i);
-                    } else {
-                        i++;
+
+                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 != 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());
+                            }
+                        }
+
+                        /// 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
+                    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 {
+                                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

                     }
                     }

+
+                    // 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

-            result = new RemoteOperationResult(isMultiStatus(status), status);
-            Log.i(TAG, "Synchronization of " + mRemotePath + ": " + result.getLogMessage());
-            
-            
+            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
+
+                } else {
+                    result = new RemoteOperationResult(true, status, query.getResponseHeaders());
+                }
+            } else {
+                result = new RemoteOperationResult(false, status, query.getResponseHeaders());
+            }
+            Log_OC.i(TAG, "Synchronizing " + mAccount.name + ", folder " + mRemotePath + ": " + result.getLogMessage());
+

         } catch (Exception e) {
         } catch (Exception e) {

-            // TODO - distinguish IOException and DavException in RemoteOperationResult constructor 

             result = new RemoteOperationResult(e);
             result = new RemoteOperationResult(e);

-            Log.e(TAG, "Synchronization of " + 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); 
     }


@@ -170,21 +337,93 @@ public class SynchronizeFolderOperation extends RemoteOperation {
         file.setCreationTimestamp(we.createTimestamp());
         file.setFileLength(we.contentLength());
         file.setMimetype(we.contentType());
         file.setCreationTimestamp(we.createTimestamp());
         file.setFileLength(we.contentLength());
         file.setMimetype(we.contentType());

-        file.setModificationTimestamp(we.modifiedTimesamp());
-        file.setLastSyncDate(mCurrentSyncTime);
+        file.setModificationTimestamp(we.modifiedTimestamp());
+        file.setParentId(mParentId);
+        file.setEtag(we.etag());

         return file;
     }
     
         return file;
     }
     

-    
-    /** 
-     * Probably this code would be better in other place
+
+    /**
+     * 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}
+     *) 
+     * @param file      File to check and fix.

      */
      */

-    private void requestContentDownload(OCFile file) {
-        Intent intent = new Intent(this.getContext(), FileDownloader.class);
-        intent.putExtra(FileDownloader.EXTRA_ACCOUNT, mAccount);
-        intent.putExtra(FileDownloader.EXTRA_FILE, file);
-        getContext().startService(intent);
+    private void checkAndFixForeignStoragePath(OCFile file) {
+        String storagePath = file.getStoragePath();
+        String expectedPath = FileStorageUtils.getDefaultSavePathFor(mAccount.name, file);
+        if (storagePath != null && !storagePath.equals(expectedPath)) {
+            /// fix storagePaths out of the local ownCloud folder
+            File originalFile = new File(storagePath);
+            if (FileStorageUtils.getUsableSpace(mAccount.name) < originalFile.length()) {
+                mForgottenLocalFiles.put(file.getRemotePath(), storagePath);
+                file.setStoragePath(null);
+                    
+            } else {
+                InputStream in = null;
+                OutputStream out = null;
+                try {
+                    File expectedFile = new File(expectedPath);
+                    File expectedParent = expectedFile.getParentFile();
+                    expectedParent.mkdirs();
+                    if (!expectedParent.isDirectory()) {
+                        throw new IOException("Unexpected error: parent directory could not be created");
+                    }
+                    expectedFile.createNewFile();
+                    if (!expectedFile.isFile()) {
+                        throw new IOException("Unexpected error: target file could not be created");
+                    }                    
+                    in = new FileInputStream(originalFile);
+                    out = new FileOutputStream(expectedFile);
+                    byte[] buf = new byte[1024];
+                    int len;
+                    while ((len = in.read(buf)) > 0){
+                        out.write(buf, 0, len);
+                    }
+                    file.setStoragePath(expectedPath);
+                    
+                } catch (Exception e) {
+                    Log_OC.e(TAG, "Exception while copying foreign file " + expectedPath, e);
+                    mForgottenLocalFiles.put(file.getRemotePath(), storagePath);
+                    file.setStoragePath(null);
+                    
+                } finally {
+                    try {
+                        if (in != null) in.close();
+                    } catch (Exception e) {
+                        Log_OC.d(TAG, "Weird exception while closing input stream for " + storagePath + " (ignoring)", e);
+                    }
+                    try {
+                        if (out != null) out.close();
+                    } catch (Exception 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);
+    }

 
 }
 
 }