src/com/owncloud/android/operations/SynchronizeFolderOperation.java

   1 /* ownCloud Android client application
   2  *   Copyright (C) 2012-2014 ownCloud Inc.
   3  *
   4  *   This program is free software: you can redistribute it and/or modify
   5  *   it under the terms of the GNU General Public License version 2,
   6  *   as published by the Free Software Foundation.
   7  *
   8  *   This program is distributed in the hope that it will be useful,
   9  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  *   GNU General Public License for more details.
  12  *
  13  *   You should have received a copy of the GNU General Public License
  14  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  *
  16  */
  17
  18 package com.owncloud.android.operations;
  19
  20 import android.accounts.Account;
  21 import android.content.Context;
  22 import android.content.Intent;
  23 import android.util.Log;
  24
  25 import com.owncloud.android.datamodel.FileDataStorageManager;
  26 import com.owncloud.android.datamodel.OCFile;
  27 import com.owncloud.android.files.services.FileDownloader;
  28 import com.owncloud.android.lib.common.OwnCloudClient;
  29 import com.owncloud.android.lib.common.operations.OperationCancelledException;
  30 import com.owncloud.android.lib.common.operations.RemoteOperationResult;
  31 import com.owncloud.android.lib.common.operations.RemoteOperationResult.ResultCode;
  32 import com.owncloud.android.lib.common.utils.Log_OC;
  33 import com.owncloud.android.lib.resources.files.ReadRemoteFileOperation;
  34 import com.owncloud.android.lib.resources.files.ReadRemoteFolderOperation;
  35 import com.owncloud.android.lib.resources.files.RemoteFile;
  36 import com.owncloud.android.operations.common.SyncOperation;
  37 import com.owncloud.android.utils.FileStorageUtils;
  38
  39 import java.io.File;
  40 import java.util.ArrayList;
  41 import java.util.HashMap;
  42 import java.util.List;
  43 import java.util.Map;
  44 import java.util.Vector;
  45 import java.util.concurrent.atomic.AtomicBoolean;
  46
  47 //import android.support.v4.content.LocalBroadcastManager;
  48
  49
  50 /**
  51  *  Remote operation performing the synchronization of the list of files contained
  52  *  in a folder identified with its remote path.
  53  *
  54  *  Fetches the list and properties of the files contained in the given folder, including their
  55  *  properties, and updates the local database with them.
  56  *
  57  *  Does NOT enter in the child folders to synchronize their contents also.
  58  *
  59  *  @author David A. Velasco
  60  */
  61 public class SynchronizeFolderOperation extends SyncOperation {
  62
  63     private static final String TAG = SynchronizeFolderOperation.class.getSimpleName();
  64
  65     /** Time stamp for the synchronization process in progress */
  66     private long mCurrentSyncTime;
  67
  68     /** Remote path of the folder to synchronize */
  69     private String mRemotePath;
  70
  71     /** Account where the file to synchronize belongs */
  72     private Account mAccount;
  73
  74     /** Android context; necessary to send requests to the download service */
  75     private Context mContext;
  76
  77     /** Locally cached information about folder to synchronize */
  78     private OCFile mLocalFolder;
  79
  80     /** Files and folders contained in the synchronized folder after a successful operation */
  81     //private List<OCFile> mChildren;
  82
  83     /** Counter of conflicts found between local and remote files */
  84     private int mConflictsFound;
  85
  86     /** Counter of failed operations in synchronization of kept-in-sync files */
  87     private int mFailsInFileSyncsFound;
  88
  89     /** 'True' means that the remote folder changed and should be fetched */
  90     private boolean mRemoteFolderChanged;
  91
  92     private List<OCFile> mFilesForDirectDownload;
  93         // to avoid extra PROPFINDs when there was no change in the folder
  94
  95     private List<SyncOperation> mFilesToSyncContentsWithoutUpload;
  96         // this will go out when 'folder synchronization' replaces 'folder download'; step by step
  97
  98     private List<SyncOperation> mFavouriteFilesToSyncContents;
  99         // this will be used for every file when 'folder synchronization' replaces 'folder download'
 100
 101     private List<SyncOperation> mFoldersToWalkDown;
 102
 103     private final AtomicBoolean mCancellationRequested;
 104
 105     /**
 106      * Creates a new instance of {@link SynchronizeFolderOperation}.
 107      *
 108      * @param   context                 Application context.
 109      * @param   remotePath              Path to synchronize.
 110      * @param   account                 ownCloud account where the folder is located.
 111      * @param   currentSyncTime         Time stamp for the synchronization process in progress.
 112      */
 113     public SynchronizeFolderOperation(Context context, String remotePath, Account account, long currentSyncTime){
 114         mRemotePath = remotePath;
 115         mCurrentSyncTime = currentSyncTime;
 116         mAccount = account;
 117         mContext = context;
 118         mRemoteFolderChanged = false;
 119         mFilesForDirectDownload = new Vector<OCFile>();
 120         mFilesToSyncContentsWithoutUpload = new Vector<SyncOperation>();
 121         mFavouriteFilesToSyncContents = new Vector<SyncOperation>();
 122         mFoldersToWalkDown = new Vector<SyncOperation>();
 123         mCancellationRequested = new AtomicBoolean(false);
 124     }
 125
 126
 127     public int getConflictsFound() {
 128         return mConflictsFound;
 129     }
 130
 131     public int getFailsInFileSyncsFound() {
 132         return mFailsInFileSyncsFound;
 133     }
 134
 135     /**
 136      * Performs the synchronization.
 137      *
 138      * {@inheritDoc}
 139      */
 140     @Override
 141     protected RemoteOperationResult run(OwnCloudClient client) {
 142         RemoteOperationResult result = null;
 143         mFailsInFileSyncsFound = 0;
 144         mConflictsFound = 0;
 145
 146         try {
 147             // get locally cached information about folder
 148             mLocalFolder = getStorageManager().getFileByPath(mRemotePath);
 149
 150             result = checkForChanges(client);
 151
 152             if (result.isSuccess()) {
 153                 if (mRemoteFolderChanged) {
 154                     result = fetchAndSyncRemoteFolder(client);
 155
 156                 } else {
 157                     prepareOpsFromLocalKnowledge();
 158                 }
 159
 160                 if (result.isSuccess()) {
 161                     syncContents(client);
 162                 }
 163
 164                 if (mFilesForDirectDownload.isEmpty()) {
 165                     // Send a broadcast message for notifying UI update
 166                     Intent uiUpdate = new Intent(FileDownloader.getDownloadFinishMessage());
 167                     uiUpdate.putExtra(FileDownloader.EXTRA_DOWNLOAD_RESULT, result.isSuccess());
 168                     uiUpdate.putExtra(FileDownloader.ACCOUNT_NAME, mAccount.name);
 169                     uiUpdate.putExtra(FileDownloader.EXTRA_REMOTE_PATH, mRemotePath);
 170                     uiUpdate.putExtra(FileDownloader.EXTRA_FILE_PATH, mLocalFolder.getRemotePath());
 171                     mContext.sendStickyBroadcast(uiUpdate);
 172                 }
 173             }
 174         } catch (OperationCancelledException e) {
 175             result = new RemoteOperationResult(e);
 176
 177             // cancel 'child' synchronizations
 178             for (SyncOperation  synchOp: mFoldersToWalkDown) {
 179                 ((SynchronizeFolderOperation) synchOp).cancel();
 180             }
 181         }
 182
 183         return result;
 184
 185     }
 186
 187     private RemoteOperationResult checkForChanges(OwnCloudClient client) throws OperationCancelledException {
 188         Log_OC.d(TAG, "Checking changes in " + mAccount.name + mRemotePath);
 189
 190         mRemoteFolderChanged = true;
 191         RemoteOperationResult result = null;
 192
 193         if (mCancellationRequested.get()) {
 194             throw new OperationCancelledException();
 195         }
 196
 197         // remote request
 198         ReadRemoteFileOperation operation = new ReadRemoteFileOperation(mRemotePath);
 199         result = operation.execute(client);
 200         if (result.isSuccess()){
 201             OCFile remoteFolder = FileStorageUtils.fillOCFile((RemoteFile) result.getData().get(0));
 202
 203             // check if remote and local folder are different
 204             mRemoteFolderChanged =
 205                         !(remoteFolder.getEtag().equalsIgnoreCase(mLocalFolder.getEtag()));
 206
 207             result = new RemoteOperationResult(ResultCode.OK);
 208
 209             Log_OC.i(TAG, "Checked " + mAccount.name + mRemotePath + " : " +
 210                     (mRemoteFolderChanged ? "changed" : "not changed"));
 211
 212         } else {
 213             // check failed
 214             if (result.getCode() == ResultCode.FILE_NOT_FOUND) {
 215                 removeLocalFolder();
 216             }
 217             if (result.isException()) {
 218                 Log_OC.e(TAG, "Checked " + mAccount.name + mRemotePath  + " : " +
 219                         result.getLogMessage(), result.getException());
 220             } else {
 221                 Log_OC.e(TAG, "Checked " + mAccount.name + mRemotePath + " : " +
 222                         result.getLogMessage());
 223             }
 224         }
 225
 226         return result;
 227     }
 228
 229
 230     private RemoteOperationResult fetchAndSyncRemoteFolder(OwnCloudClient client) throws OperationCancelledException {
 231         if (mCancellationRequested.get()) {
 232             throw new OperationCancelledException();
 233         }
 234
 235         ReadRemoteFolderOperation operation = new ReadRemoteFolderOperation(mRemotePath);
 236         RemoteOperationResult result = operation.execute(client);
 237         Log_OC.d(TAG, "Synchronizing " + mAccount.name + mRemotePath);
 238
 239         if (result.isSuccess()) {
 240             synchronizeData(result.getData(), client);
 241             if (mConflictsFound > 0  || mFailsInFileSyncsFound > 0) {
 242                 result = new RemoteOperationResult(ResultCode.SYNC_CONFLICT);
 243                     // should be a different result code, but will do the job
 244             }
 245         } else {
 246             if (result.getCode() == ResultCode.FILE_NOT_FOUND)
 247                 removeLocalFolder();
 248         }
 249
 250
 251         return result;
 252     }
 253
 254
 255     private void removeLocalFolder() {
 256         FileDataStorageManager storageManager = getStorageManager();
 257         if (storageManager.fileExists(mLocalFolder.getFileId())) {
 258             String currentSavePath = FileStorageUtils.getSavePath(mAccount.name);
 259             storageManager.removeFolder(
 260                     mLocalFolder,
 261                     true,
 262                     (   mLocalFolder.isDown() &&        // TODO: debug, I think this is always false for folders
 263                             mLocalFolder.getStoragePath().startsWith(currentSavePath)
 264                     )
 265             );
 266         }
 267     }
 268
 269
 270     /**
 271      *  Synchronizes the data retrieved from the server about the contents of the target folder
 272      *  with the current data in the local database.
 273      *
 274      *  Grants that mChildren is updated with fresh data after execution.
 275      *
 276      *  @param folderAndFiles   Remote folder and children files in Folder
 277      *
 278      *  @param client           Client instance to the remote server where the data were
 279      *                          retrieved.
 280      *  @return                 'True' when any change was made in the local data, 'false' otherwise
 281      */
 282     private void synchronizeData(ArrayList<Object> folderAndFiles, OwnCloudClient client) {
 283         FileDataStorageManager storageManager = getStorageManager();
 284
 285         // parse data from remote folder
 286         OCFile remoteFolder = fillOCFile((RemoteFile)folderAndFiles.get(0));
 287         remoteFolder.setParentId(mLocalFolder.getParentId());
 288         remoteFolder.setFileId(mLocalFolder.getFileId());
 289
 290         Log_OC.d(TAG, "Remote folder " + mLocalFolder.getRemotePath()
 291                 + " changed - starting update of local data ");
 292
 293         List<OCFile> updatedFiles = new Vector<OCFile>(folderAndFiles.size() - 1);
 294         mFilesForDirectDownload.clear();
 295         mFilesToSyncContentsWithoutUpload.clear();
 296         mFavouriteFilesToSyncContents.clear();
 297         mFoldersToWalkDown.clear();
 298
 299         // get current data about local contents of the folder to synchronize
 300         List<OCFile> localFiles = storageManager.getFolderContent(mLocalFolder);
 301         Map<String, OCFile> localFilesMap = new HashMap<String, OCFile>(localFiles.size());
 302         for (OCFile file : localFiles) {
 303             localFilesMap.put(file.getRemotePath(), file);
 304         }
 305
 306         // loop to synchronize every child
 307         OCFile remoteFile = null, localFile = null;
 308         for (int i=1; i<folderAndFiles.size(); i++) {
 309             /// new OCFile instance with the data from the server
 310             remoteFile = fillOCFile((RemoteFile)folderAndFiles.get(i));
 311             remoteFile.setParentId(mLocalFolder.getFileId());
 312
 313             /// retrieve local data for the read file
 314             //  localFile = mStorageManager.getFileByPath(remoteFile.getRemotePath());
 315             localFile = localFilesMap.remove(remoteFile.getRemotePath());
 316
 317             /// add to the remoteFile (the new one) data about LOCAL STATE (not existing in server)
 318             remoteFile.setLastSyncDateForProperties(mCurrentSyncTime);
 319             if (localFile != null) {
 320                 // some properties of local state are kept unmodified
 321                 remoteFile.setFileId(localFile.getFileId());
 322                 remoteFile.setKeepInSync(localFile.keepInSync());
 323                 remoteFile.setLastSyncDateForData(localFile.getLastSyncDateForData());
 324                 remoteFile.setModificationTimestampAtLastSyncForData(
 325                         localFile.getModificationTimestampAtLastSyncForData()
 326                 );
 327                 remoteFile.setStoragePath(localFile.getStoragePath());
 328                 // eTag will not be updated unless contents are synchronized
 329                 //  (Synchronize[File|Folder]Operation with remoteFile as parameter)
 330                 remoteFile.setEtag(localFile.getEtag());
 331                 if (remoteFile.isFolder()) {
 332                     remoteFile.setFileLength(localFile.getFileLength());
 333                         // TODO move operations about size of folders to FileContentProvider
 334                 } else if (mRemoteFolderChanged && remoteFile.isImage() &&
 335                         remoteFile.getModificationTimestamp() != localFile.getModificationTimestamp()) {
 336                     remoteFile.setNeedsUpdateThumbnail(true);
 337                     Log.d(TAG, "Image " + remoteFile.getFileName() + " updated on the server");
 338                 }
 339                 remoteFile.setPublicLink(localFile.getPublicLink());
 340                 remoteFile.setShareByLink(localFile.isShareByLink());
 341             } else {
 342                 // remote eTag will not be updated unless contents are synchronized
 343                 //  (Synchronize[File|Folder]Operation with remoteFile as parameter)
 344                 remoteFile.setEtag("");
 345             }
 346
 347             /// check and fix, if needed, local storage path
 348             searchForLocalFileInDefaultPath(remoteFile);
 349
 350             /// classify file to sync/download contents later
 351             if (remoteFile.isFolder()) {
 352                 /// to download children files recursively
 353                 SynchronizeFolderOperation synchFolderOp =  new SynchronizeFolderOperation(
 354                         mContext,
 355                         remoteFile.getRemotePath(),
 356                         mAccount,
 357                         mCurrentSyncTime
 358                 );
 359                 mFoldersToWalkDown.add(synchFolderOp);
 360
 361             } else if (remoteFile.keepInSync()) {
 362                 /// prepare content synchronization for kept-in-sync files
 363                 SynchronizeFileOperation operation = new SynchronizeFileOperation(
 364                         localFile,
 365                         remoteFile,
 366                         mAccount,
 367                         true,
 368                         mContext
 369                     );
 370                 mFavouriteFilesToSyncContents.add(operation);
 371
 372             } else {
 373                 /// prepare limited synchronization for regular files
 374                 SynchronizeFileOperation operation = new SynchronizeFileOperation(
 375                         localFile,
 376                         remoteFile,
 377                         mAccount,
 378                         true,
 379                         false,
 380                         mContext
 381                     );
 382                 mFilesToSyncContentsWithoutUpload.add(operation);
 383             }
 384
 385             updatedFiles.add(remoteFile);
 386         }
 387
 388         // save updated contents in local database
 389         storageManager.saveFolder(remoteFolder, updatedFiles, localFilesMap.values());
 390
 391     }
 392
 393
 394     private void prepareOpsFromLocalKnowledge() {
 395         List<OCFile> children = getStorageManager().getFolderContent(mLocalFolder);
 396         for (OCFile child : children) {
 397             /// classify file to sync/download contents later
 398             if (child.isFolder()) {
 399                 /// to download children files recursively
 400                 SynchronizeFolderOperation synchFolderOp =  new SynchronizeFolderOperation(
 401                         mContext,
 402                         child.getRemotePath(),
 403                         mAccount,
 404                         mCurrentSyncTime
 405                 );
 406                 mFoldersToWalkDown.add(synchFolderOp);
 407
 408             } else {
 409                 /// prepare limited synchronization for regular files
 410                 if (!child.isDown()) {
 411                     mFilesForDirectDownload.add(child);
 412                 }
 413             }
 414         }
 415     }
 416
 417
 418     private void syncContents(OwnCloudClient client) throws OperationCancelledException {
 419         startDirectDownloads();
 420         startContentSynchronizations(mFilesToSyncContentsWithoutUpload, client);
 421         startContentSynchronizations(mFavouriteFilesToSyncContents, client);
 422         walkSubfolders(client);    // this must be the last!
 423     }
 424
 425
 426     private void startDirectDownloads() throws OperationCancelledException {
 427         for (OCFile file : mFilesForDirectDownload) {
 428             if (mCancellationRequested.get()) {
 429                 throw new OperationCancelledException();
 430             }
 431             Intent i = new Intent(mContext, FileDownloader.class);
 432             i.putExtra(FileDownloader.EXTRA_ACCOUNT, mAccount);
 433             i.putExtra(FileDownloader.EXTRA_FILE, file);
 434             mContext.startService(i);
 435         }
 436     }
 437
 438     /**
 439      * Performs a list of synchronization operations, determining if a download or upload is needed
 440      * or if exists conflict due to changes both in local and remote contents of the each file.
 441      *
 442      * If download or upload is needed, request the operation to the corresponding service and goes
 443      * on.
 444      *
 445      * @param filesToSyncContents       Synchronization operations to execute.
 446      * @param client                    Interface to the remote ownCloud server.
 447      */
 448     private void startContentSynchronizations(List<SyncOperation> filesToSyncContents, OwnCloudClient client)
 449             throws OperationCancelledException {
 450
 451         RemoteOperationResult contentsResult = null;
 452         for (SyncOperation op: filesToSyncContents) {
 453             if (mCancellationRequested.get()) {
 454                 throw new OperationCancelledException();
 455             }
 456             contentsResult = op.execute(getStorageManager(), mContext);
 457             if (!contentsResult.isSuccess()) {
 458                 if (contentsResult.getCode() == ResultCode.SYNC_CONFLICT) {
 459                     mConflictsFound++;
 460                 } else {
 461                     mFailsInFileSyncsFound++;
 462                     if (contentsResult.getException() != null) {
 463                         Log_OC.e(TAG, "Error while synchronizing file : "
 464                                 +  contentsResult.getLogMessage(), contentsResult.getException());
 465                     } else {
 466                         Log_OC.e(TAG, "Error while synchronizing file : "
 467                                 + contentsResult.getLogMessage());
 468                     }
 469                 }
 470                 // TODO - use the errors count in notifications
 471             }   // won't let these fails break the synchronization process
 472         }
 473     }
 474
 475
 476     private void walkSubfolders(OwnCloudClient client) throws OperationCancelledException {
 477         RemoteOperationResult contentsResult = null;
 478         for (SyncOperation op: mFoldersToWalkDown) {
 479             if (mCancellationRequested.get()) {
 480                 throw new OperationCancelledException();
 481             }
 482             contentsResult = op.execute(client, getStorageManager());   // to watch out: possibly deep recursion
 483             if (!contentsResult.isSuccess()) {
 484                 // TODO - some kind of error count, and use it with notifications
 485                 if (contentsResult.getException() != null) {
 486                     Log_OC.e(TAG, "Non blocking exception : "
 487                             +  contentsResult.getLogMessage(), contentsResult.getException());
 488                 } else {
 489                     Log_OC.e(TAG, "Non blocking error : " + contentsResult.getLogMessage());
 490                 }
 491             }   // won't let these fails break the synchronization process
 492         }
 493     }
 494
 495
 496     /**
 497      * Creates and populates a new {@link com.owncloud.android.datamodel.OCFile} object with the data read from the server.
 498      *
 499      * @param remote    remote file read from the server (remote file or folder).
 500      * @return          New OCFile instance representing the remote resource described by we.
 501      */
 502     private OCFile fillOCFile(RemoteFile remote) {
 503         OCFile file = new OCFile(remote.getRemotePath());
 504         file.setCreationTimestamp(remote.getCreationTimestamp());
 505         file.setFileLength(remote.getLength());
 506         file.setMimetype(remote.getMimeType());
 507         file.setModificationTimestamp(remote.getModifiedTimestamp());
 508         file.setEtag(remote.getEtag());
 509         file.setPermissions(remote.getPermissions());
 510         file.setRemoteId(remote.getRemoteId());
 511         return file;
 512     }
 513
 514
 515     /**
 516      * Scans the default location for saving local copies of files searching for
 517      * a 'lost' file with the same full name as the {@link com.owncloud.android.datamodel.OCFile} received as
 518      * parameter.
 519      *
 520      * @param file      File to associate a possible 'lost' local file.
 521      */
 522     private void searchForLocalFileInDefaultPath(OCFile file) {
 523         if (file.getStoragePath() == null && !file.isFolder()) {
 524             File f = new File(FileStorageUtils.getDefaultSavePathFor(mAccount.name, file));
 525             if (f.exists()) {
 526                 file.setStoragePath(f.getAbsolutePath());
 527                 file.setLastSyncDateForData(f.lastModified());
 528             }
 529         }
 530     }
 531
 532
 533     /**
 534      * Cancel operation
 535      */
 536     public void cancel() {
 537         mCancellationRequested.set(true);
 538     }
 539 }