X-Git-Url: http://git.linex4red.de/pub/Android/ownCloud.git/blobdiff_plain/4e1aafdafc28a58f159ba72fd71722726ec84405..e4bc3bdadc47c01e88dd1de94a4666d3753ee90e:/src/com/owncloud/android/syncadapter/FileSyncAdapter.java

diff --git a/src/com/owncloud/android/syncadapter/FileSyncAdapter.java b/src/com/owncloud/android/syncadapter/FileSyncAdapter.java
index 00888998..e977e41c 100644
--- a/src/com/owncloud/android/syncadapter/FileSyncAdapter.java
+++ b/src/com/owncloud/android/syncadapter/FileSyncAdapter.java
@@ -19,18 +19,19 @@
 package com.owncloud.android.syncadapter;
 
 import java.io.IOException;
+import java.net.UnknownHostException;
 import java.util.List;
-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 com.owncloud.android.R;
+import com.owncloud.android.datamodel.DataStorageManager;
 import com.owncloud.android.datamodel.FileDataStorageManager;
 import com.owncloud.android.datamodel.OCFile;
-import com.owncloud.android.files.services.FileDownloader;
+import com.owncloud.android.operations.RemoteOperationResult;
+import com.owncloud.android.operations.SynchronizeFolderOperation;
+import com.owncloud.android.operations.UpdateOCVersionOperation;
+import com.owncloud.android.operations.RemoteOperationResult.ResultCode;
 
 import android.accounts.Account;
 import android.app.Notification;
@@ -43,8 +44,6 @@ import android.content.Intent;
 import android.content.SyncResult;
 import android.os.Bundle;
 import android.util.Log;
-import eu.alefzero.webdav.WebdavEntry;
-import eu.alefzero.webdav.WebdavUtils;
 
 /**
  * SyncAdapter implementation for syncing sample SyncAdapter contacts to the
@@ -54,25 +53,29 @@ import eu.alefzero.webdav.WebdavUtils;
  */
 public class FileSyncAdapter extends AbstractOwnCloudSyncAdapter {
 
-    private final static String TAG = "FileSyncAdapter"; 
-    
-    /*  Commented code for ugly performance tests
-    private final static int MAX_DELAYS = 100;
-    private static long[] mResponseDelays = new long[MAX_DELAYS]; 
-    private static long[] mSaveDelays = new long[MAX_DELAYS];
-    private int mDelaysIndex = 0;
-    private int mDelaysCount = 0;
-    */
+    private final static String TAG = "FileSyncAdapter";
+
+    /** 
+     * Maximum number of failed folder synchronizations that are supported before finishing the synchronization operation
+     */
+    private static final int MAX_FAILED_RESULTS = 3; 
     
     private long mCurrentSyncTime;
     private boolean mCancellation;
     private boolean mIsManualSync;
-    private boolean mRightSync;
+    private int mFailedResultsCounter;    
+    private RemoteOperationResult mLastFailedResult;
+    private SyncResult mSyncResult;
+    private int mConflictsFound;
+    private int mFailsInFavouritesFound;
     
     public FileSyncAdapter(Context context, boolean autoInitialize) {
         super(context, autoInitialize);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public synchronized void onPerformSync(Account account, Bundle extras,
             String authority, ContentProviderClient provider,
@@ -80,267 +83,238 @@ public class FileSyncAdapter extends AbstractOwnCloudSyncAdapter {
 
         mCancellation = false;
         mIsManualSync = extras.getBoolean(ContentResolver.SYNC_EXTRAS_MANUAL, false);
-        mRightSync = true;
-        
+        mFailedResultsCounter = 0;
+        mLastFailedResult = null;
+        mConflictsFound = 0;
+        mFailsInFavouritesFound = 0;
+        mSyncResult = syncResult;
+        mSyncResult.fullSyncRequested = false;
+        mSyncResult.delayUntil = 60*60*24; // sync after 24h
+
         this.setAccount(account);
         this.setContentProvider(provider);
         this.setStorageManager(new FileDataStorageManager(account, getContentProvider()));
+        try {
+            this.initClientForCurrentAccount();
+        } catch (UnknownHostException e) {
+            /// the account is unknown for the Synchronization Manager, or unreachable for this context; don't try this again
+            mSyncResult.tooManyRetries = true;
+            notifyFailedSynchronization();
+            return;
+        }
+        
+        Log.d(TAG, "Synchronization of ownCloud account " + account.name + " starting");
+        sendStickyBroadcast(true, null, null);  // message to signal the start of the synchronization to the UI
         
-        /*  Commented code for ugly performance tests
-        mDelaysIndex = 0;
-        mDelaysCount = 0;
-        */
-
-        Log.d(TAG, "syncing owncloud account " + account.name);
-
-        sendStickyBroadcast(true, null);  // message to signal the start to the UI
-
-        String uri = getUri().toString();
-        PropFindMethod query = null;
         try {
+            updateOCVersion();
             mCurrentSyncTime = System.currentTimeMillis();
-            query = new PropFindMethod(uri + "/");
-            int status = getClient().executeMethod(query);
-            if (status != HttpStatus.SC_UNAUTHORIZED) {
-                MultiStatus resp = query.getResponseBodyAsMultiStatus();
-
-                if (resp.getResponses().length > 0) {
-                    WebdavEntry we = new WebdavEntry(resp.getResponses()[0], getUri().getPath());
-                    OCFile file = fillOCFile(we);
-                    file.setParentId(0);
-                    getStorageManager().saveFile(file);
-                    if (!mCancellation) {
-                        fetchData(uri, syncResult, file.getFileId());
-                    }
-                }
-
+            if (!mCancellation) {
+                fetchData(OCFile.PATH_SEPARATOR, DataStorageManager.ROOT_PARENT_ID);
+                
             } else {
-                syncResult.stats.numAuthExceptions++;
+                Log.d(TAG, "Leaving synchronization before any remote request due to cancellation was requested");
             }
-        } catch (IOException e) {
-            syncResult.stats.numIoExceptions++;
-            logException(e, uri + "/");
-            
-        } catch (DavException e) {
-            syncResult.stats.numParseExceptions++;
-            logException(e, uri + "/");
             
-        } catch (Exception e) {
-            // TODO something smart with syncresult
-            logException(e, uri + "/");
-            mRightSync = false;
             
         } finally {
-            if (query != null)
-                query.releaseConnection();  // let the connection available for other methods
-            mRightSync &= (syncResult.stats.numIoExceptions == 0 && syncResult.stats.numAuthExceptions == 0 && syncResult.stats.numParseExceptions == 0);
-            if (!mRightSync && mIsManualSync) {
+            // it's important making this although very unexpected errors occur; that's the reason for the finally
+            
+            if (mFailedResultsCounter > 0 && mIsManualSync) {
                 /// don't let the system synchronization manager retries MANUAL synchronizations
                 //      (be careful: "MANUAL" currently includes the synchronization requested when a new account is created and when the user changes the current account)
-                syncResult.tooManyRetries = true;
+                mSyncResult.tooManyRetries = true;
                 
                 /// notify the user about the failure of MANUAL synchronization
-                Notification notification = new Notification(R.drawable.icon, getContext().getString(R.string.sync_fail_ticker), System.currentTimeMillis());
-                notification.flags |= Notification.FLAG_AUTO_CANCEL;
-                // TODO put something smart in the contentIntent below
-                notification.contentIntent = PendingIntent.getActivity(getContext().getApplicationContext(), 0, new Intent(), PendingIntent.FLAG_UPDATE_CURRENT);
-                notification.setLatestEventInfo(getContext().getApplicationContext(), 
-                                                getContext().getString(R.string.sync_fail_ticker), 
-                                                String.format(getContext().getString(R.string.sync_fail_content), account.name), 
-                                                notification.contentIntent);
-                ((NotificationManager) getContext().getSystemService(Context.NOTIFICATION_SERVICE)).notify(R.string.sync_fail_ticker, notification);
+                notifyFailedSynchronization();
+                
+            } else if (mConflictsFound > 0 || mFailsInFavouritesFound > 0) {
+                notifyFailsInFavourites();
             }
-            sendStickyBroadcast(false, null);        // message to signal the end to the UI
-        }
-        
-        /*  Commented code for ugly performance tests
-        long sum = 0, mean = 0, max = 0, min = Long.MAX_VALUE;
-        for (int i=0; i<MAX_DELAYS && i<mDelaysCount; i++) {
-            sum += mResponseDelays[i];
-            max = Math.max(max, mResponseDelays[i]);
-            min = Math.min(min, mResponseDelays[i]);
+            sendStickyBroadcast(false, null, mLastFailedResult);        // message to signal the end to the UI
         }
-        mean = sum / mDelaysCount;
-        Log.e(TAG, "SYNC STATS - response: mean time = " + mean + " ; max time = " + max + " ; min time = " + min);
         
-        sum = 0; max = 0; min = Long.MAX_VALUE;
-        for (int i=0; i<MAX_DELAYS && i<mDelaysCount; i++) {
-            sum += mSaveDelays[i];
-            max = Math.max(max, mSaveDelays[i]);
-            min = Math.min(min, mSaveDelays[i]);
+    }
+
+    
+    /**
+     * Called by system SyncManager when a synchronization is required to be cancelled.
+     * 
+     * Sets the mCancellation flag to 'true'. THe synchronization will be stopped when before a new folder is fetched. Data of the last folder
+     * fetched will be still saved in the database. See onPerformSync implementation.
+     */
+    @Override
+    public void onSyncCanceled() {
+        Log.d(TAG, "Synchronization of " + getAccount().name + " has been requested to cancel");
+        mCancellation = true;
+        super.onSyncCanceled();
+    }
+    
+    
+    /**
+     * Updates the locally stored version value of the ownCloud server
+     */
+    private void updateOCVersion() {
+        UpdateOCVersionOperation update = new UpdateOCVersionOperation(getAccount(), getContext());
+        RemoteOperationResult result = update.execute(getClient());
+        if (!result.isSuccess()) {
+            mLastFailedResult = result; 
         }
-        mean = sum / mDelaysCount;
-        Log.e(TAG, "SYNC STATS - save:     mean time = " + mean + " ; max time = " + max + " ; min time = " + min);
-        Log.e(TAG, "SYNC STATS - folders measured: " + mDelaysCount);
-        */
-        
     }
 
-    private void fetchData(String uri, SyncResult syncResult, long parentId) {
-        PropFindMethod query = null;
-        try {
-            Log.d(TAG, "fetching " + uri);
+    
+    
+    /**
+     * Synchronize the properties of files and folders contained in a remote folder given by remotePath.
+     * 
+     * @param remotePath        Remote path to the folder to synchronize.
+     * @param parentId          Database Id of the folder to synchronize.
+     */
+    private void fetchData(String remotePath, long parentId) {
+        
+        if (mFailedResultsCounter > MAX_FAILED_RESULTS || isFinisher(mLastFailedResult))
+            return;
+        
+        // perform folder synchronization
+        SynchronizeFolderOperation synchFolderOp = new SynchronizeFolderOperation(  remotePath, 
+                                                                                    mCurrentSyncTime, 
+                                                                                    parentId, 
+                                                                                    getStorageManager(), 
+                                                                                    getAccount(), 
+                                                                                    getContext()
+                                                                                  );
+        RemoteOperationResult result = synchFolderOp.execute(getClient());
+        
+        
+        // synchronized folder -> notice to UI - ALWAYS, although !result.isSuccess
+        sendStickyBroadcast(true, remotePath, null);
+        
+        if (result.isSuccess() || result.getCode() == ResultCode.SYNC_CONFLICT) {
             
-            // remote request 
-            query = new PropFindMethod(uri);
-            /*  Commented code for ugly performance tests
-            long responseDelay = System.currentTimeMillis();
-            */
-            int status = getClient().executeMethod(query);
-            /*  Commented code for ugly performance tests
-            responseDelay = System.currentTimeMillis() - responseDelay;
-            Log.e(TAG, "syncing: RESPONSE TIME for " + uri + " contents, " + responseDelay + "ms");
-            */
-            if (status != HttpStatus.SC_UNAUTHORIZED) {
-                MultiStatus resp = query.getResponseBodyAsMultiStatus();
+            if (result.getCode() == ResultCode.SYNC_CONFLICT) {
+                mConflictsFound += synchFolderOp.getConflictsFound();
+                mFailsInFavouritesFound += synchFolderOp.getFailsInFavouritesFound();
+            }
+            // synchronize children folders 
+            List<OCFile> children = synchFolderOp.getChildren();
+            fetchChildren(children);    // beware of the 'hidden' recursion here!
             
-                // insertion or update of files
-                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], getUri().getPath());
-                    OCFile file = fillOCFile(we);
-                    file.setParentId(parentId);
-                    if (getStorageManager().getFileByPath(file.getRemotePath()) != null &&
-                            getStorageManager().getFileByPath(file.getRemotePath()).keepInSync() &&
-                            file.getModificationTimestamp() > getStorageManager().getFileByPath(file.getRemotePath())
-                                                                         .getModificationTimestamp()) {
-                        Intent intent = new Intent(this.getContext(), FileDownloader.class);
-                        intent.putExtra(FileDownloader.EXTRA_ACCOUNT, getAccount());
-                        intent.putExtra(FileDownloader.EXTRA_FILE, file);
-                        /*intent.putExtra(FileDownloader.EXTRA_FILE_PATH, file.getRemotePath());
-                        intent.putExtra(FileDownloader.EXTRA_REMOTE_PATH, file.getRemotePath());
-                        intent.putExtra(FileDownloader.EXTRA_FILE_SIZE, file.getFileLength());*/
-                        file.setKeepInSync(true);
-                        getContext().startService(intent);
-                    }
-                    if (getStorageManager().getFileByPath(file.getRemotePath()) != null)
-                        file.setKeepInSync(getStorageManager().getFileByPath(file.getRemotePath()).keepInSync());
+        } else {
+            if (result.getCode() == RemoteOperationResult.ResultCode.UNAUTHORIZED) {
+                mSyncResult.stats.numAuthExceptions++;
                 
-                    // Log.v(TAG, "adding file: " + file);
-                    updatedFiles.add(file);
-                    if (parentId == 0)
-                        parentId = file.getFileId();
-                }
-                /*  Commented code for ugly performance tests
-                long saveDelay = System.currentTimeMillis();
-                 */            
-                getStorageManager().saveFiles(updatedFiles);    // all "at once" ; trying to get a best performance in database update
-                /*  Commented code for ugly performance tests
-                saveDelay = System.currentTimeMillis() - saveDelay;
-                Log.e(TAG, "syncing: SAVE TIME for " + uri + " contents, " + mSaveDelays[mDelaysIndex] + "ms");
-                 */
-            
-                // removal of obsolete files
-                Vector<OCFile> files = getStorageManager().getDirectoryContent(
-                        getStorageManager().getFileById(parentId));
-                OCFile file;
-                String currentSavePath = FileDownloader.getSavePath(getAccount().name);
-                for (int i=0; i < files.size(); ) {
-                    file = files.get(i);
-                    if (file.getLastSyncDate() != mCurrentSyncTime) {
-                        Log.v(TAG, "removing file: " + file);
-                        getStorageManager().removeFile(file, (file.isDown() && file.getStoragePath().startsWith(currentSavePath)));
-                        files.remove(i);
-                    } else {
-                        i++;
-                    }
-                }
-            
-                // recursive fetch
-                for (int i=0; i < files.size() && !mCancellation; i++) {
-                    OCFile newFile = files.get(i);
-                    if (newFile.getMimetype().equals("DIR")) {
-                        fetchData(getUri().toString() + WebdavUtils.encodePath(newFile.getRemotePath()), syncResult, newFile.getFileId());
-                    }
-                }
-                if (mCancellation) Log.d(TAG, "Leaving " + uri + " because cancelation request");
+            } else if (result.getException() instanceof DavException) {
+                mSyncResult.stats.numParseExceptions++;
                 
-                /*  Commented code for ugly performance tests
-                mResponseDelays[mDelaysIndex] = responseDelay;
-                mSaveDelays[mDelaysIndex] = saveDelay;
-                mDelaysCount++;
-                mDelaysIndex++;
-                if (mDelaysIndex >= MAX_DELAYS)
-                    mDelaysIndex = 0;
-                 */
-
-            } else {
-                syncResult.stats.numAuthExceptions++;
+            } else if (result.getException() instanceof IOException) { 
+                mSyncResult.stats.numIoExceptions++;
             }
-        } catch (IOException e) {
-            syncResult.stats.numIoExceptions++;
-            logException(e, uri);
-            
-        } catch (DavException e) {
-            syncResult.stats.numParseExceptions++;
-            logException(e, uri);
+            mFailedResultsCounter++;
+            mLastFailedResult = result;
+        }
             
-        } catch (Exception e) {
-            // TODO something smart with syncresult
-            mRightSync = false;
-            logException(e, uri);
-
-        } finally {
-            if (query != null)
-                query.releaseConnection();  // let the connection available for other methods
+    }
 
-            // synchronized folder -> notice to UI
-            sendStickyBroadcast(true, getStorageManager().getFileById(parentId).getRemotePath());
+    /**
+     * Checks if a failed result should terminate the synchronization process immediately, according to
+     * OUR OWN POLICY
+     * 
+     * @param   failedResult        Remote operation result to check.
+     * @return                      'True' if the result should immediately finish the synchronization
+     */
+    private boolean isFinisher(RemoteOperationResult failedResult) {
+        if  (failedResult != null) {
+            RemoteOperationResult.ResultCode code = failedResult.getCode();
+            return (code.equals(RemoteOperationResult.ResultCode.SSL_ERROR) ||
+                    code.equals(RemoteOperationResult.ResultCode.SSL_RECOVERABLE_PEER_UNVERIFIED) ||
+                    code.equals(RemoteOperationResult.ResultCode.BAD_OC_VERSION) ||
+                    code.equals(RemoteOperationResult.ResultCode.INSTANCE_NOT_CONFIGURED));
         }
+        return false;
     }
 
-    private OCFile fillOCFile(WebdavEntry we) {
-        OCFile file = new OCFile(we.decodedPath());
-        file.setCreationTimestamp(we.createTimestamp());
-        file.setFileLength(we.contentLength());
-        file.setMimetype(we.contentType());
-        file.setModificationTimestamp(we.modifiedTimesamp());
-        file.setLastSyncDate(mCurrentSyncTime);
-        return file;
+    /**
+     * Synchronize data of folders in the list of received files
+     * 
+     * @param files         Files to recursively fetch 
+     */
+    private void fetchChildren(List<OCFile> files) {
+        int i;
+        for (i=0; i < files.size() && !mCancellation; i++) {
+            OCFile newFile = files.get(i);
+            if (newFile.isDirectory()) {
+                fetchData(newFile.getRemotePath(), newFile.getFileId());
+            }
+        }
+        if (mCancellation && i <files.size()) Log.d(TAG, "Leaving synchronization before synchronizing " + files.get(i).getRemotePath() + " because cancelation request");
     }
+
     
-    
-    private void sendStickyBroadcast(boolean inProgress, String dirRemotePath) {
+    /**
+     * 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, getAccount().name);
         if (dirRemotePath != null) {
             i.putExtra(FileSyncService.SYNC_FOLDER_REMOTE_PATH, dirRemotePath);
         }
+        if (result != null) {
+            i.putExtra(FileSyncService.SYNC_RESULT, result);
+        }
         getContext().sendStickyBroadcast(i);
     }
+
+    
     
     /**
-     * Called by system SyncManager when a synchronization is required to be cancelled.
-     * 
-     * Sets the mCancellation flag to 'true'. THe synchronization will be stopped when before a new folder is fetched. Data of the last folder
-     * fetched will be still saved in the database. See onPerformSync implementation.
+     * Notifies the user about a failed synchronization through the status notification bar 
      */
-    @Override
-    public void onSyncCanceled() {
-        Log.d(TAG, "Synchronization of " + getAccount().name + " has been requested to cancel");
-        mCancellation = true;
-        super.onSyncCanceled();
+    private void notifyFailedSynchronization() {
+        Notification notification = new Notification(R.drawable.icon, getContext().getString(R.string.sync_fail_ticker), System.currentTimeMillis());
+        notification.flags |= Notification.FLAG_AUTO_CANCEL;
+        // TODO put something smart in the contentIntent below
+        notification.contentIntent = PendingIntent.getActivity(getContext().getApplicationContext(), (int)System.currentTimeMillis(), new Intent(), 0);
+        notification.setLatestEventInfo(getContext().getApplicationContext(), 
+                                        getContext().getString(R.string.sync_fail_ticker), 
+                                        String.format(getContext().getString(R.string.sync_fail_content), getAccount().name), 
+                                        notification.contentIntent);
+        ((NotificationManager) getContext().getSystemService(Context.NOTIFICATION_SERVICE)).notify(R.string.sync_fail_ticker, notification);
     }
 
-    
+
     /**
-     * Logs an exception triggered in a synchronization request. 
+     * Notifies the user about conflicts and strange fails when trying to synchronize the contents of favourite files.
      * 
-     * @param e       Caught exception.
-     * @param uri     Uri to the remote directory that was fetched when the synchronization failed 
+     * By now, we won't consider a failed synchronization.
      */
-    private void logException(Exception e, String uri) {
-        if (e instanceof IOException) {
-            Log.e(TAG, "Unrecovered transport exception while synchronizing " + uri + " at " + getAccount().name, e);
-
-        } else if (e instanceof DavException) {
-            Log.e(TAG, "Unexpected WebDAV exception while synchronizing " + uri + " at " + getAccount().name, e);
-
+    private void notifyFailsInFavourites() {
+        if (mFailedResultsCounter > 0) {
+            Notification notification = new Notification(R.drawable.icon, getContext().getString(R.string.sync_fail_in_favourites_ticker), System.currentTimeMillis());
+            notification.flags |= Notification.FLAG_AUTO_CANCEL;
+            // TODO put something smart in the contentIntent below
+            notification.contentIntent = PendingIntent.getActivity(getContext().getApplicationContext(), (int)System.currentTimeMillis(), new Intent(), 0);
+            notification.setLatestEventInfo(getContext().getApplicationContext(), 
+                                            getContext().getString(R.string.sync_fail_in_favourites_ticker), 
+                                            String.format(getContext().getString(R.string.sync_fail_in_favourites_content), mFailedResultsCounter + mConflictsFound, mConflictsFound), 
+                                            notification.contentIntent);
+            ((NotificationManager) getContext().getSystemService(Context.NOTIFICATION_SERVICE)).notify(R.string.sync_fail_in_favourites_ticker, notification);
+            
         } else {
-            Log.e(TAG, "Unexpected exception while synchronizing " + uri  + " at " + getAccount().name, e);
-        }
+            Notification notification = new Notification(R.drawable.icon, getContext().getString(R.string.sync_conflicts_in_favourites_ticker), System.currentTimeMillis());
+            notification.flags |= Notification.FLAG_AUTO_CANCEL;
+            // TODO put something smart in the contentIntent below
+            notification.contentIntent = PendingIntent.getActivity(getContext().getApplicationContext(), (int)System.currentTimeMillis(), new Intent(), 0);
+            notification.setLatestEventInfo(getContext().getApplicationContext(), 
+                                            getContext().getString(R.string.sync_conflicts_in_favourites_ticker), 
+                                            String.format(getContext().getString(R.string.sync_conflicts_in_favourites_content), mConflictsFound), 
+                                            notification.contentIntent);
+            ((NotificationManager) getContext().getSystemService(Context.NOTIFICATION_SERVICE)).notify(R.string.sync_conflicts_in_favourites_ticker, notification);
+        } 
     }
 
-    
 }