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

   1 /**
   2  *   ownCloud Android client application
   3  *
   4  *   @author David A. Velasco
   5  *   Copyright (C) 2015 ownCloud Inc.
   6  *
   7  *   This program is free software: you can redistribute it and/or modify
   8  *   it under the terms of the GNU General Public License version 2,
   9  *   as published by the Free Software Foundation.
  10  *
  11  *   This program is distributed in the hope that it will be useful,
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *   GNU General Public License for more details.
  15  *
  16  *   You should have received a copy of the GNU General Public License
  17  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  *
  19  */
  20
  21 package com.owncloud.android.operations;
  22
  23 import java.util.ArrayList;
  24 import java.util.HashMap;
  25 import java.util.List;
  26 import java.util.Map;
  27 import java.util.Vector;
  28
  29 import android.accounts.Account;
  30 import android.content.Context;
  31 import android.content.Intent;
  32 import android.util.Log;
  33
  34 import com.owncloud.android.datamodel.FileDataStorageManager;
  35 import com.owncloud.android.datamodel.OCFile;
  36
  37 import com.owncloud.android.lib.common.OwnCloudClient;
  38 import com.owncloud.android.lib.resources.shares.OCShare;
  39 import com.owncloud.android.lib.common.operations.RemoteOperation;
  40 import com.owncloud.android.lib.common.operations.RemoteOperationResult;
  41 import com.owncloud.android.lib.common.operations.RemoteOperationResult.ResultCode;
  42 import com.owncloud.android.lib.common.utils.Log_OC;
  43 import com.owncloud.android.lib.resources.shares.GetRemoteSharesForFileOperation;
  44 import com.owncloud.android.lib.resources.files.ReadRemoteFileOperation;
  45 import com.owncloud.android.lib.resources.files.ReadRemoteFolderOperation;
  46 import com.owncloud.android.lib.resources.files.RemoteFile;
  47
  48 import com.owncloud.android.syncadapter.FileSyncAdapter;
  49 import com.owncloud.android.utils.FileStorageUtils;
  50
  51
  52
  53 /**
  54  *  Remote operation performing the synchronization of the list of files contained
  55  *  in a folder identified with its remote path.
  56  *
  57  *  Fetches the list and properties of the files contained in the given folder, including their
  58  *  properties, and updates the local database with them.
  59  *
  60  *  Does NOT enter in the child folders to synchronize their contents also.
  61  */
  62 public class RefreshFolderOperation extends RemoteOperation {
  63
  64     private static final String TAG = RefreshFolderOperation.class.getSimpleName();
  65
  66     public static final String EVENT_SINGLE_FOLDER_CONTENTS_SYNCED  =
  67             RefreshFolderOperation.class.getName() + ".EVENT_SINGLE_FOLDER_CONTENTS_SYNCED";
  68     public static final String EVENT_SINGLE_FOLDER_SHARES_SYNCED    =
  69             RefreshFolderOperation.class.getName() + ".EVENT_SINGLE_FOLDER_SHARES_SYNCED";
  70
  71     /** Time stamp for the synchronization process in progress */
  72     private long mCurrentSyncTime;
  73
  74     /** Remote folder to synchronize */
  75     private OCFile mLocalFolder;
  76
  77     /** Access to the local database */
  78     private FileDataStorageManager mStorageManager;
  79
  80     /** Account where the file to synchronize belongs */
  81     private Account mAccount;
  82
  83     /** Android context; necessary to send requests to the download service */
  84     private Context mContext;
  85
  86     /** Files and folders contained in the synchronized folder after a successful operation */
  87     private List<OCFile> mChildren;
  88
  89     /** Counter of conflicts found between local and remote files */
  90     private int mConflictsFound;
  91
  92     /** Counter of failed operations in synchronization of kept-in-sync files */
  93     private int mFailsInFavouritesFound;
  94
  95     /**
  96      * Map of remote and local paths to files that where locally stored in a location
  97      * out of the ownCloud folder and couldn't be copied automatically into it
  98      **/
  99     private Map<String, String> mForgottenLocalFiles;
 100
 101     /** 'True' means that this operation is part of a full account synchronization */
 102     private boolean mSyncFullAccount;
 103
 104     /** 'True' means that Share resources bound to the files into should be refreshed also */
 105     private boolean mIsShareSupported;
 106
 107     /** 'True' means that the remote folder changed and should be fetched */
 108     private boolean mRemoteFolderChanged;
 109
 110     /** 'True' means that Etag will be ignored */
 111     private boolean mIgnoreETag;
 112
 113     private List<SynchronizeFileOperation> mFilesToSyncContents;
 114     // this will be used for every file when 'folder synchronization' replaces 'folder download'
 115
 116
 117     /**
 118      * Creates a new instance of {@link RefreshFolderOperation}.
 119      *
 120      * @param   folder                  Folder to synchronize.
 121      * @param   currentSyncTime         Time stamp for the synchronization process in progress.
 122      * @param   syncFullAccount         'True' means that this operation is part of a full account
 123      *                                  synchronization.
 124      * @param   isShareSupported        'True' means that the server supports the sharing API.
 125      * @param   ignoreETag              'True' means that the content of the remote folder should
 126      *                                  be fetched and updated even though the 'eTag' did not
 127      *                                  change.
 128      * @param   dataStorageManager      Interface with the local database.
 129      * @param   account                 ownCloud account where the folder is located.
 130      * @param   context                 Application context.
 131      */
 132     public RefreshFolderOperation(OCFile folder,
 133                                   long currentSyncTime,
 134                                   boolean syncFullAccount,
 135                                   boolean isShareSupported,
 136                                   boolean ignoreETag,
 137                                   FileDataStorageManager dataStorageManager,
 138                                   Account account,
 139                                   Context context) {
 140         mLocalFolder = folder;
 141         mCurrentSyncTime = currentSyncTime;
 142         mSyncFullAccount = syncFullAccount;
 143         mIsShareSupported = isShareSupported;
 144         mStorageManager = dataStorageManager;
 145         mAccount = account;
 146         mContext = context;
 147         mForgottenLocalFiles = new HashMap<String, String>();
 148         mRemoteFolderChanged = false;
 149         mIgnoreETag = ignoreETag;
 150         mFilesToSyncContents = new Vector<SynchronizeFileOperation>();
 151     }
 152
 153
 154     public int getConflictsFound() {
 155         return mConflictsFound;
 156     }
 157
 158     public int getFailsInFavouritesFound() {
 159         return mFailsInFavouritesFound;
 160     }
 161
 162     public Map<String, String> getForgottenLocalFiles() {
 163         return mForgottenLocalFiles;
 164     }
 165
 166     /**
 167      * Returns the list of files and folders contained in the synchronized folder,
 168      * if called after synchronization is complete.
 169      *
 170      * @return  List of files and folders contained in the synchronized folder.
 171      */
 172     public List<OCFile> getChildren() {
 173         return mChildren;
 174     }
 175
 176     /**
 177      * Performs the synchronization.
 178      *
 179      * {@inheritDoc}
 180      */
 181     @Override
 182     protected RemoteOperationResult run(OwnCloudClient client) {
 183         RemoteOperationResult result = null;
 184         mFailsInFavouritesFound = 0;
 185         mConflictsFound = 0;
 186         mForgottenLocalFiles.clear();
 187
 188         if (OCFile.ROOT_PATH.equals(mLocalFolder.getRemotePath()) && !mSyncFullAccount) {
 189             updateOCVersion(client);
 190
 191         }
 192
 193         result = checkForChanges(client);
 194
 195         if (result.isSuccess()) {
 196             if (mRemoteFolderChanged) {
 197                 result = fetchAndSyncRemoteFolder(client);
 198             } else {
 199                 fetchFavoritesToSyncFromLocalData();
 200                 mChildren = mStorageManager.getFolderContent(mLocalFolder/*, false*/);
 201             }
 202
 203             if (result.isSuccess()) {
 204                 // request for the synchronization of KEPT-IN-SYNC file contents
 205                 startContentSynchronizations(mFilesToSyncContents, client);
 206             }
 207         }
 208
 209         if (!mSyncFullAccount) {
 210             sendLocalBroadcast(
 211                     EVENT_SINGLE_FOLDER_CONTENTS_SYNCED, mLocalFolder.getRemotePath(), result
 212             );
 213         }
 214
 215         if (result.isSuccess() && mIsShareSupported && !mSyncFullAccount) {
 216             refreshSharesForFolder(client); // share result is ignored
 217         }
 218
 219         if (!mSyncFullAccount) {
 220             sendLocalBroadcast(
 221                     EVENT_SINGLE_FOLDER_SHARES_SYNCED, mLocalFolder.getRemotePath(), result
 222             );
 223         }
 224
 225         return result;
 226
 227     }
 228
 229
 230     private void updateOCVersion(OwnCloudClient client) {
 231         UpdateOCVersionOperation update = new UpdateOCVersionOperation(mAccount, mContext);
 232         RemoteOperationResult result = update.execute(client);
 233         if (result.isSuccess()) {
 234             mIsShareSupported = update.getOCVersion().isSharedSupported();
 235
 236             // Update Capabilities for this account
 237             if (update.getOCVersion().isVersionWithCapabilitiesAPI()) {
 238                 updateCapabilities(client);
 239             } else {
 240                 Log_OC.d(TAG, "Capabilities API disabled");
 241             }
 242         }
 243     }
 244
 245     private void updateCapabilities(OwnCloudClient client){
 246         GetCapabilitiesOperarion getCapabilities = new GetCapabilitiesOperarion();
 247         RemoteOperationResult  result = getCapabilities.execute(mStorageManager,mContext);
 248         if (!result.isSuccess()){
 249             Log_OC.d(TAG, "Update Capabilities unsuccessfully");
 250         }
 251     }
 252
 253     private RemoteOperationResult checkForChanges(OwnCloudClient client) {
 254         mRemoteFolderChanged = true;
 255         RemoteOperationResult result = null;
 256         String remotePath = mLocalFolder.getRemotePath();
 257
 258         Log_OC.d(TAG, "Checking changes in " + mAccount.name + remotePath);
 259
 260         // remote request
 261         ReadRemoteFileOperation operation = new ReadRemoteFileOperation(remotePath);
 262         result = operation.execute(client);
 263         if (result.isSuccess()){
 264             OCFile remoteFolder = FileStorageUtils.fillOCFile((RemoteFile) result.getData().get(0));
 265
 266             if (!mIgnoreETag) {
 267                 // check if remote and local folder are different
 268                 String remoteFolderETag = remoteFolder.getEtag();
 269                 if (remoteFolderETag != null) {
 270                     mRemoteFolderChanged =
 271                             !(remoteFolderETag.equalsIgnoreCase(mLocalFolder.getEtag()));
 272                 } else {
 273                     Log_OC.e(TAG, "Checked " + mAccount.name + remotePath + " : " +
 274                             "No ETag received from server");
 275                 }
 276             }
 277
 278             result = new RemoteOperationResult(ResultCode.OK);
 279
 280             Log_OC.i(TAG, "Checked " + mAccount.name + remotePath + " : " +
 281                     (mRemoteFolderChanged ? "changed" : "not changed"));
 282
 283         } else {
 284             // check failed
 285             if (result.getCode() == ResultCode.FILE_NOT_FOUND) {
 286                 removeLocalFolder();
 287             }
 288             if (result.isException()) {
 289                 Log_OC.e(TAG, "Checked " + mAccount.name + remotePath  + " : " +
 290                         result.getLogMessage(), result.getException());
 291             } else {
 292                 Log_OC.e(TAG, "Checked " + mAccount.name + remotePath + " : " +
 293                         result.getLogMessage());
 294             }
 295         }
 296
 297         return result;
 298     }
 299
 300
 301     private RemoteOperationResult fetchAndSyncRemoteFolder(OwnCloudClient client) {
 302         String remotePath = mLocalFolder.getRemotePath();
 303         ReadRemoteFolderOperation operation = new ReadRemoteFolderOperation(remotePath);
 304         RemoteOperationResult result = operation.execute(client);
 305         Log_OC.d(TAG, "Synchronizing " + mAccount.name + remotePath);
 306
 307         if (result.isSuccess()) {
 308             synchronizeData(result.getData(), client);
 309             if (mConflictsFound > 0  || mFailsInFavouritesFound > 0) {
 310                 result = new RemoteOperationResult(ResultCode.SYNC_CONFLICT);
 311                     // should be a different result code, but will do the job
 312             }
 313         } else {
 314             if (result.getCode() == ResultCode.FILE_NOT_FOUND)
 315                 removeLocalFolder();
 316         }
 317
 318         return result;
 319     }
 320
 321
 322     private void removeLocalFolder() {
 323         if (mStorageManager.fileExists(mLocalFolder.getFileId())) {
 324             String currentSavePath = FileStorageUtils.getSavePath(mAccount.name);
 325             mStorageManager.removeFolder(
 326                     mLocalFolder,
 327                     true,
 328                     (   mLocalFolder.isDown() &&
 329                             mLocalFolder.getStoragePath().startsWith(currentSavePath)
 330                     )
 331             );
 332         }
 333     }
 334
 335
 336     /**
 337      *  Synchronizes the data retrieved from the server about the contents of the target folder
 338      *  with the current data in the local database.
 339      *
 340      *  Grants that mChildren is updated with fresh data after execution.
 341      *
 342      *  @param folderAndFiles   Remote folder and children files in Folder
 343      *
 344      *  @param client           Client instance to the remote server where the data were
 345      *                          retrieved.
 346      *  @return                 'True' when any change was made in the local data, 'false' otherwise
 347      */
 348     private void synchronizeData(ArrayList<Object> folderAndFiles, OwnCloudClient client) {
 349         // get 'fresh data' from the database
 350         mLocalFolder = mStorageManager.getFileByPath(mLocalFolder.getRemotePath());
 351
 352         // parse data from remote folder
 353         OCFile remoteFolder = FileStorageUtils.fillOCFile((RemoteFile) folderAndFiles.get(0));
 354         remoteFolder.setParentId(mLocalFolder.getParentId());
 355         remoteFolder.setFileId(mLocalFolder.getFileId());
 356
 357         Log_OC.d(TAG, "Remote folder " + mLocalFolder.getRemotePath()
 358                 + " changed - starting update of local data ");
 359
 360         List<OCFile> updatedFiles = new Vector<OCFile>(folderAndFiles.size() - 1);
 361         mFilesToSyncContents.clear();
 362
 363         // get current data about local contents of the folder to synchronize
 364         // TODO Enable when "On Device" is recovered ?
 365         List<OCFile> localFiles = mStorageManager.getFolderContent(mLocalFolder/*, false*/);
 366         Map<String, OCFile> localFilesMap = new HashMap<String, OCFile>(localFiles.size());
 367         for (OCFile file : localFiles) {
 368             localFilesMap.put(file.getRemotePath(), file);
 369         }
 370
 371         // loop to update every child
 372         OCFile remoteFile = null, localFile = null, updatedFile = null;
 373         RemoteFile r;
 374         for (int i=1; i<folderAndFiles.size(); i++) {
 375             /// new OCFile instance with the data from the server
 376             r = (RemoteFile) folderAndFiles.get(i);
 377             remoteFile = FileStorageUtils.fillOCFile(r);
 378
 379             /// new OCFile instance to merge fresh data from server with local state
 380             updatedFile = FileStorageUtils.fillOCFile(r);
 381             updatedFile.setParentId(mLocalFolder.getFileId());
 382
 383             /// retrieve local data for the read file
 384             //  localFile = mStorageManager.getFileByPath(remoteFile.getRemotePath());
 385             localFile = localFilesMap.remove(remoteFile.getRemotePath());
 386
 387             /// add to updatedFile data about LOCAL STATE (not existing in server)
 388             updatedFile.setLastSyncDateForProperties(mCurrentSyncTime);
 389             if (localFile != null) {
 390                 updatedFile.setFileId(localFile.getFileId());
 391                 updatedFile.setFavorite(localFile.isFavorite());
 392                 updatedFile.setLastSyncDateForData(localFile.getLastSyncDateForData());
 393                 updatedFile.setModificationTimestampAtLastSyncForData(
 394                         localFile.getModificationTimestampAtLastSyncForData()
 395                 );
 396                 updatedFile.setStoragePath(localFile.getStoragePath());
 397                 // eTag will not be updated unless file CONTENTS are synchronized
 398                 updatedFile.setEtag(localFile.getEtag());
 399                 if (updatedFile.isFolder()) {
 400                     updatedFile.setFileLength(localFile.getFileLength());
 401                         // TODO move operations about size of folders to FileContentProvider
 402                 } else if (mRemoteFolderChanged && remoteFile.isImage() &&
 403                         remoteFile.getModificationTimestamp() !=
 404                                 localFile.getModificationTimestamp()) {
 405                     updatedFile.setNeedsUpdateThumbnail(true);
 406                     Log.d(TAG, "Image " + remoteFile.getFileName() + " updated on the server");
 407                 }
 408                 updatedFile.setPublicLink(localFile.getPublicLink());
 409                 updatedFile.setShareViaLink(localFile.isSharedViaLink());
 410                 updatedFile.setShareWithSharee(localFile.isSharedWithSharee());
 411                 updatedFile.setEtagInConflict(localFile.getEtagInConflict());
 412             } else {
 413                 // remote eTag will not be updated unless file CONTENTS are synchronized
 414                 updatedFile.setEtag("");
 415             }
 416
 417             /// check and fix, if needed, local storage path
 418             FileStorageUtils.searchForLocalFileInDefaultPath(updatedFile, mAccount);
 419
 420             /// prepare content synchronization for kept-in-sync files
 421             if (updatedFile.isFavorite()) {
 422                 SynchronizeFileOperation operation = new SynchronizeFileOperation(  localFile,
 423                                                                                     remoteFile,
 424                                                                                     mAccount,
 425                                                                                     true,
 426                                                                                     mContext
 427                                                                                     );
 428
 429                 mFilesToSyncContents.add(operation);
 430             }
 431
 432             updatedFiles.add(updatedFile);
 433         }
 434
 435         // save updated contents in local database
 436         mStorageManager.saveFolder(remoteFolder, updatedFiles, localFilesMap.values());
 437
 438         mChildren = updatedFiles;
 439     }
 440
 441     /**
 442      * Performs a list of synchronization operations, determining if a download or upload is needed
 443      * or if exists conflict due to changes both in local and remote contents of the each file.
 444      *
 445      * If download or upload is needed, request the operation to the corresponding service and goes
 446      * on.
 447      *
 448      * @param filesToSyncContents       Synchronization operations to execute.
 449      * @param client                    Interface to the remote ownCloud server.
 450      */
 451     private void startContentSynchronizations(
 452             List<SynchronizeFileOperation> filesToSyncContents, OwnCloudClient client
 453         ) {
 454         RemoteOperationResult contentsResult = null;
 455         for (SynchronizeFileOperation op: filesToSyncContents) {
 456             contentsResult = op.execute(mStorageManager, mContext);   // async
 457             if (!contentsResult.isSuccess()) {
 458                 if (contentsResult.getCode() == ResultCode.SYNC_CONFLICT) {
 459                     mConflictsFound++;
 460                 } else {
 461                     mFailsInFavouritesFound++;
 462                     if (contentsResult.getException() != null) {
 463                         Log_OC.e(TAG, "Error while synchronizing favourites : "
 464                                 +  contentsResult.getLogMessage(), contentsResult.getException());
 465                     } else {
 466                         Log_OC.e(TAG, "Error while synchronizing favourites : "
 467                                 + contentsResult.getLogMessage());
 468                     }
 469                 }
 470             }   // won't let these fails break the synchronization process
 471         }
 472     }
 473
 474
 475     /**
 476      * Syncs the Share resources for the files contained in the folder refreshed (children, not deeper descendants).
 477      *
 478      * @param client    Handler of a session with an OC server.
 479      * @return          The result of the remote operation retrieving the Share resources in the folder refreshed by
 480      *                  the operation.
 481      */
 482     private RemoteOperationResult refreshSharesForFolder(OwnCloudClient client) {
 483         RemoteOperationResult result = null;
 484
 485         // remote request
 486         GetRemoteSharesForFileOperation operation =
 487                 new GetRemoteSharesForFileOperation(mLocalFolder.getRemotePath(), true, true);
 488         result = operation.execute(client);
 489
 490         if (result.isSuccess()) {
 491             // update local database
 492             ArrayList<OCShare> shares = new ArrayList<OCShare>();
 493             for(Object obj: result.getData()) {
 494                 shares.add((OCShare) obj);
 495             }
 496             mStorageManager.saveSharesInFolder(shares, mLocalFolder);
 497         }
 498
 499         return result;
 500     }
 501
 502
 503     /**
 504      * Sends a message to any application component interested in the progress
 505      * of the synchronization.
 506      *
 507      * @param event
 508      * @param dirRemotePath     Remote path of a folder that was just synchronized
 509      *                          (with or without success)
 510      * @param result
 511      */
 512     private void sendLocalBroadcast(
 513             String event, String dirRemotePath, RemoteOperationResult result
 514         ) {
 515         Log_OC.d(TAG, "Send broadcast " + event);
 516         Intent intent = new Intent(event);
 517         intent.putExtra(FileSyncAdapter.EXTRA_ACCOUNT_NAME, mAccount.name);
 518         if (dirRemotePath != null) {
 519             intent.putExtra(FileSyncAdapter.EXTRA_FOLDER_PATH, dirRemotePath);
 520         }
 521         intent.putExtra(FileSyncAdapter.EXTRA_RESULT, result);
 522         mContext.sendStickyBroadcast(intent);
 523         //LocalBroadcastManager.getInstance(mContext).sendBroadcast(intent);
 524     }
 525
 526
 527     private void fetchFavoritesToSyncFromLocalData() {
 528         List<OCFile> children = mStorageManager.getFolderContent(mLocalFolder);
 529         for (OCFile child : children) {
 530             if (!child.isFolder() && child.isFavorite()) {
 531                 SynchronizeFileOperation operation = new SynchronizeFileOperation(
 532                         child,
 533                         child,  // cheating with the remote file to get an update to server; to refactor
 534                         mAccount,
 535                         true,
 536                         mContext
 537                 );
 538                 mFilesToSyncContents.add(operation);
 539             }
 540         }
 541     }
 542
 543 }