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         } catch (OperationCancelledException e) {
 165             result = new RemoteOperationResult(e);
 166
 167             // cancel 'child' synchronizations
 168             for (SyncOperation  synchOp: mFoldersToWalkDown) {
 169                 ((SynchronizeFolderOperation) synchOp).cancel();
 170             }
 171         }
 172
 173         return result;
 174
 175     }
 176
 177     private RemoteOperationResult checkForChanges(OwnCloudClient client) throws OperationCancelledException {
 178         Log_OC.d(TAG, "Checking changes in " + mAccount.name + mRemotePath);
 179
 180         mRemoteFolderChanged = true;
 181         RemoteOperationResult result = null;
 182
 183         if (mCancellationRequested.get()) {
 184             throw new OperationCancelledException();
 185         }
 186
 187         // remote request
 188         ReadRemoteFileOperation operation = new ReadRemoteFileOperation(mRemotePath);
 189         result = operation.execute(client);
 190         if (result.isSuccess()){
 191             OCFile remoteFolder = FileStorageUtils.fillOCFile((RemoteFile) result.getData().get(0));
 192
 193             // check if remote and local folder are different
 194             mRemoteFolderChanged =
 195                         !(remoteFolder.getEtag().equalsIgnoreCase(mLocalFolder.getEtag()));
 196
 197             result = new RemoteOperationResult(ResultCode.OK);
 198
 199             Log_OC.i(TAG, "Checked " + mAccount.name + mRemotePath + " : " +
 200                     (mRemoteFolderChanged ? "changed" : "not changed"));
 201
 202         } else {
 203             // check failed
 204             if (result.getCode() == ResultCode.FILE_NOT_FOUND) {
 205                 removeLocalFolder();
 206             }
 207             if (result.isException()) {
 208                 Log_OC.e(TAG, "Checked " + mAccount.name + mRemotePath  + " : " +
 209                         result.getLogMessage(), result.getException());
 210             } else {
 211                 Log_OC.e(TAG, "Checked " + mAccount.name + mRemotePath + " : " +
 212                         result.getLogMessage());
 213             }
 214         }
 215
 216         return result;
 217     }
 218
 219
 220     private RemoteOperationResult fetchAndSyncRemoteFolder(OwnCloudClient client) throws OperationCancelledException {
 221         if (mCancellationRequested.get()) {
 222             throw new OperationCancelledException();
 223         }
 224
 225         ReadRemoteFolderOperation operation = new ReadRemoteFolderOperation(mRemotePath);
 226         RemoteOperationResult result = operation.execute(client);
 227         Log_OC.d(TAG, "Synchronizing " + mAccount.name + mRemotePath);
 228
 229         if (result.isSuccess()) {
 230             synchronizeData(result.getData(), client);
 231             if (mConflictsFound > 0  || mFailsInFileSyncsFound > 0) {
 232                 result = new RemoteOperationResult(ResultCode.SYNC_CONFLICT);
 233                     // should be a different result code, but will do the job
 234             }
 235         } else {
 236             if (result.getCode() == ResultCode.FILE_NOT_FOUND)
 237                 removeLocalFolder();
 238         }
 239
 240
 241         return result;
 242     }
 243
 244
 245     private void removeLocalFolder() {
 246         FileDataStorageManager storageManager = getStorageManager();
 247         if (storageManager.fileExists(mLocalFolder.getFileId())) {
 248             String currentSavePath = FileStorageUtils.getSavePath(mAccount.name);
 249             storageManager.removeFolder(
 250                     mLocalFolder,
 251                     true,
 252                     (   mLocalFolder.isDown() &&        // TODO: debug, I think this is always false for folders
 253                             mLocalFolder.getStoragePath().startsWith(currentSavePath)
 254                     )
 255             );
 256         }
 257     }
 258
 259
 260     /**
 261      *  Synchronizes the data retrieved from the server about the contents of the target folder
 262      *  with the current data in the local database.
 263      *
 264      *  Grants that mChildren is updated with fresh data after execution.
 265      *
 266      *  @param folderAndFiles   Remote folder and children files in Folder
 267      *
 268      *  @param client           Client instance to the remote server where the data were
 269      *                          retrieved.
 270      *  @return                 'True' when any change was made in the local data, 'false' otherwise
 271      */
 272     private void synchronizeData(ArrayList<Object> folderAndFiles, OwnCloudClient client) {
 273         FileDataStorageManager storageManager = getStorageManager();
 274
 275         // parse data from remote folder
 276         OCFile remoteFolder = fillOCFile((RemoteFile)folderAndFiles.get(0));
 277         remoteFolder.setParentId(mLocalFolder.getParentId());
 278         remoteFolder.setFileId(mLocalFolder.getFileId());
 279
 280         Log_OC.d(TAG, "Remote folder " + mLocalFolder.getRemotePath()
 281                 + " changed - starting update of local data ");
 282
 283         List<OCFile> updatedFiles = new Vector<OCFile>(folderAndFiles.size() - 1);
 284         mFilesForDirectDownload.clear();
 285         mFilesToSyncContentsWithoutUpload.clear();
 286         mFavouriteFilesToSyncContents.clear();
 287         mFoldersToWalkDown.clear();
 288
 289         // get current data about local contents of the folder to synchronize
 290         List<OCFile> localFiles = storageManager.getFolderContent(mLocalFolder);
 291         Map<String, OCFile> localFilesMap = new HashMap<String, OCFile>(localFiles.size());
 292         for (OCFile file : localFiles) {
 293             localFilesMap.put(file.getRemotePath(), file);
 294         }
 295
 296         // loop to synchronize every child
 297         OCFile remoteFile = null, localFile = null;
 298         for (int i=1; i<folderAndFiles.size(); i++) {
 299             /// new OCFile instance with the data from the server
 300             remoteFile = fillOCFile((RemoteFile)folderAndFiles.get(i));
 301             remoteFile.setParentId(mLocalFolder.getFileId());
 302
 303             /// retrieve local data for the read file
 304             //  localFile = mStorageManager.getFileByPath(remoteFile.getRemotePath());
 305             localFile = localFilesMap.remove(remoteFile.getRemotePath());
 306
 307             /// add to the remoteFile (the new one) data about LOCAL STATE (not existing in server)
 308             remoteFile.setLastSyncDateForProperties(mCurrentSyncTime);
 309             if (localFile != null) {
 310                 // some properties of local state are kept unmodified
 311                 remoteFile.setFileId(localFile.getFileId());
 312                 remoteFile.setKeepInSync(localFile.keepInSync());
 313                 remoteFile.setLastSyncDateForData(localFile.getLastSyncDateForData());
 314                 remoteFile.setModificationTimestampAtLastSyncForData(
 315                         localFile.getModificationTimestampAtLastSyncForData()
 316                 );
 317                 remoteFile.setStoragePath(localFile.getStoragePath());
 318                 // eTag will not be updated unless contents are synchronized
 319                 //  (Synchronize[File|Folder]Operation with remoteFile as parameter)
 320                 remoteFile.setEtag(localFile.getEtag());
 321                 if (remoteFile.isFolder()) {
 322                     remoteFile.setFileLength(localFile.getFileLength());
 323                         // TODO move operations about size of folders to FileContentProvider
 324                 } else if (mRemoteFolderChanged && remoteFile.isImage() &&
 325                         remoteFile.getModificationTimestamp() != localFile.getModificationTimestamp()) {
 326                     remoteFile.setNeedsUpdateThumbnail(true);
 327                     Log.d(TAG, "Image " + remoteFile.getFileName() + " updated on the server");
 328                 }
 329                 remoteFile.setPublicLink(localFile.getPublicLink());
 330                 remoteFile.setShareByLink(localFile.isShareByLink());
 331             } else {
 332                 // remote eTag will not be updated unless contents are synchronized
 333                 //  (Synchronize[File|Folder]Operation with remoteFile as parameter)
 334                 remoteFile.setEtag("");
 335             }
 336
 337             /// check and fix, if needed, local storage path
 338             searchForLocalFileInDefaultPath(remoteFile);
 339
 340             /// classify file to sync/download contents later
 341             if (remoteFile.isFolder()) {
 342                 /// to download children files recursively
 343                 SynchronizeFolderOperation synchFolderOp =  new SynchronizeFolderOperation(
 344                         mContext,
 345                         remoteFile.getRemotePath(),
 346                         mAccount,
 347                         mCurrentSyncTime
 348                 );
 349                 mFoldersToWalkDown.add(synchFolderOp);
 350
 351             } else if (remoteFile.keepInSync()) {
 352                 /// prepare content synchronization for kept-in-sync files
 353                 SynchronizeFileOperation operation = new SynchronizeFileOperation(
 354                         localFile,
 355                         remoteFile,
 356                         mAccount,
 357                         true,
 358                         mContext
 359                     );
 360                 mFavouriteFilesToSyncContents.add(operation);
 361
 362             } else {
 363                 /// prepare limited synchronization for regular files
 364                 SynchronizeFileOperation operation = new SynchronizeFileOperation(
 365                         localFile,
 366                         remoteFile,
 367                         mAccount,
 368                         true,
 369                         false,
 370                         mContext
 371                     );
 372                 mFilesToSyncContentsWithoutUpload.add(operation);
 373             }
 374
 375             updatedFiles.add(remoteFile);
 376         }
 377
 378         // save updated contents in local database
 379         storageManager.saveFolder(remoteFolder, updatedFiles, localFilesMap.values());
 380
 381     }
 382
 383
 384     private void prepareOpsFromLocalKnowledge() {
 385         List<OCFile> children = getStorageManager().getFolderContent(mLocalFolder);
 386         for (OCFile child : children) {
 387             /// classify file to sync/download contents later
 388             if (child.isFolder()) {
 389                 /// to download children files recursively
 390                 SynchronizeFolderOperation synchFolderOp =  new SynchronizeFolderOperation(
 391                         mContext,
 392                         child.getRemotePath(),
 393                         mAccount,
 394                         mCurrentSyncTime
 395                 );
 396                 mFoldersToWalkDown.add(synchFolderOp);
 397
 398             } else {
 399                 /// prepare limited synchronization for regular files
 400                 if (!child.isDown()) {
 401                     mFilesForDirectDownload.add(child);
 402                 }
 403             }
 404         }
 405     }
 406
 407
 408     private void syncContents(OwnCloudClient client) throws OperationCancelledException {
 409         startDirectDownloads();
 410         startContentSynchronizations(mFilesToSyncContentsWithoutUpload, client);
 411         startContentSynchronizations(mFavouriteFilesToSyncContents, client);
 412         walkSubfolders(client);    // this must be the last!
 413     }
 414
 415
 416     private void startDirectDownloads() throws OperationCancelledException {
 417         for (OCFile file : mFilesForDirectDownload) {
 418             if (mCancellationRequested.get()) {
 419                 throw new OperationCancelledException();
 420             }
 421             Intent i = new Intent(mContext, FileDownloader.class);
 422             i.putExtra(FileDownloader.EXTRA_ACCOUNT, mAccount);
 423             i.putExtra(FileDownloader.EXTRA_FILE, file);
 424             mContext.startService(i);
 425         }
 426     }
 427
 428     /**
 429      * Performs a list of synchronization operations, determining if a download or upload is needed
 430      * or if exists conflict due to changes both in local and remote contents of the each file.
 431      *
 432      * If download or upload is needed, request the operation to the corresponding service and goes
 433      * on.
 434      *
 435      * @param filesToSyncContents       Synchronization operations to execute.
 436      * @param client                    Interface to the remote ownCloud server.
 437      */
 438     private void startContentSynchronizations(List<SyncOperation> filesToSyncContents, OwnCloudClient client)
 439             throws OperationCancelledException {
 440
 441         RemoteOperationResult contentsResult = null;
 442         for (SyncOperation op: filesToSyncContents) {
 443             if (mCancellationRequested.get()) {
 444                 throw new OperationCancelledException();
 445             }
 446             contentsResult = op.execute(getStorageManager(), mContext);
 447             if (!contentsResult.isSuccess()) {
 448                 if (contentsResult.getCode() == ResultCode.SYNC_CONFLICT) {
 449                     mConflictsFound++;
 450                 } else {
 451                     mFailsInFileSyncsFound++;
 452                     if (contentsResult.getException() != null) {
 453                         Log_OC.e(TAG, "Error while synchronizing file : "
 454                                 +  contentsResult.getLogMessage(), contentsResult.getException());
 455                     } else {
 456                         Log_OC.e(TAG, "Error while synchronizing file : "
 457                                 + contentsResult.getLogMessage());
 458                     }
 459                 }
 460                 // TODO - use the errors count in notifications
 461             }   // won't let these fails break the synchronization process
 462         }
 463     }
 464
 465
 466     private void walkSubfolders(OwnCloudClient client) throws OperationCancelledException {
 467         RemoteOperationResult contentsResult = null;
 468         for (SyncOperation op: mFoldersToWalkDown) {
 469             if (mCancellationRequested.get()) {
 470                 throw new OperationCancelledException();
 471             }
 472             contentsResult = op.execute(client, getStorageManager());   // to watch out: possibly deep recursion
 473             if (!contentsResult.isSuccess()) {
 474                 // TODO - some kind of error count, and use it with notifications
 475                 if (contentsResult.getException() != null) {
 476                     Log_OC.e(TAG, "Non blocking exception : "
 477                             +  contentsResult.getLogMessage(), contentsResult.getException());
 478                 } else {
 479                     Log_OC.e(TAG, "Non blocking error : " + contentsResult.getLogMessage());
 480                 }
 481             }   // won't let these fails break the synchronization process
 482         }
 483     }
 484
 485
 486     /**
 487      * Creates and populates a new {@link com.owncloud.android.datamodel.OCFile} object with the data read from the server.
 488      *
 489      * @param remote    remote file read from the server (remote file or folder).
 490      * @return          New OCFile instance representing the remote resource described by we.
 491      */
 492     private OCFile fillOCFile(RemoteFile remote) {
 493         OCFile file = new OCFile(remote.getRemotePath());
 494         file.setCreationTimestamp(remote.getCreationTimestamp());
 495         file.setFileLength(remote.getLength());
 496         file.setMimetype(remote.getMimeType());
 497         file.setModificationTimestamp(remote.getModifiedTimestamp());
 498         file.setEtag(remote.getEtag());
 499         file.setPermissions(remote.getPermissions());
 500         file.setRemoteId(remote.getRemoteId());
 501         return file;
 502     }
 503
 504
 505     /**
 506      * Scans the default location for saving local copies of files searching for
 507      * a 'lost' file with the same full name as the {@link com.owncloud.android.datamodel.OCFile} received as
 508      * parameter.
 509      *
 510      * @param file      File to associate a possible 'lost' local file.
 511      */
 512     private void searchForLocalFileInDefaultPath(OCFile file) {
 513         if (file.getStoragePath() == null && !file.isFolder()) {
 514             File f = new File(FileStorageUtils.getDefaultSavePathFor(mAccount.name, file));
 515             if (f.exists()) {
 516                 file.setStoragePath(f.getAbsolutePath());
 517                 file.setLastSyncDateForData(f.lastModified());
 518             }
 519         }
 520     }
 521
 522
 523     /**
 524      * Cancel operation
 525      */
 526     public void cancel() {
 527         mCancellationRequested.set(true);
 528     }
 529 }