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

   1 /* ownCloud Android client application
   2  *   Copyright (C) 2012-2013 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 java.io.File;
  21 import java.io.FileInputStream;
  22 import java.io.FileOutputStream;
  23 import java.io.IOException;
  24 import java.io.InputStream;
  25 import java.io.OutputStream;
  26 import java.util.ArrayList;
  27 import java.util.HashMap;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.Vector;
  31
  32 import org.apache.http.HttpStatus;
  33 import android.accounts.Account;
  34 import android.content.Context;
  35 import android.content.Intent;
  36
  37 import com.owncloud.android.datamodel.FileDataStorageManager;
  38 import com.owncloud.android.datamodel.OCFile;
  39 import com.owncloud.android.lib.network.OwnCloudClient;
  40 import com.owncloud.android.lib.operations.common.RemoteOperation;
  41 import com.owncloud.android.lib.operations.common.RemoteOperationResult;
  42 import com.owncloud.android.lib.operations.common.RemoteOperationResult.ResultCode;
  43 import com.owncloud.android.lib.operations.remote.ReadRemoteFileOperation;
  44 import com.owncloud.android.lib.operations.remote.ReadRemoteFolderOperation;
  45 import com.owncloud.android.lib.operations.common.RemoteFile;
  46 import com.owncloud.android.syncadapter.FileSyncService;
  47 import com.owncloud.android.utils.FileStorageUtils;
  48 import com.owncloud.android.utils.Log_OC;
  49
  50
  51
  52 /**
  53  *  Remote operation performing the synchronization of the list of files contained
  54  *  in a folder identified with its remote path.
  55  *
  56  *  Fetches the list and properties of the files contained in the given folder, including their
  57  *  properties, and updates the local database with them.
  58  *
  59  *  Does NOT enter in the child folders to synchronize their contents also.
  60  *
  61  *  @author David A. Velasco
  62  */
  63 public class SynchronizeFolderOperation extends RemoteOperation {
  64
  65     private static final String TAG = SynchronizeFolderOperation.class.getSimpleName();
  66
  67
  68     /** Time stamp for the synchronization process in progress */
  69     private long mCurrentSyncTime;
  70
  71     /** Remote folder to synchronize */
  72     private OCFile mLocalFolder;
  73
  74     /** Access to the local database */
  75     private FileDataStorageManager mStorageManager;
  76
  77     /** Account where the file to synchronize belongs */
  78     private Account mAccount;
  79
  80     /** Android context; necessary to send requests to the download service */
  81     private Context mContext;
  82
  83     /** Files and folders contained in the synchronized folder after a successful operation */
  84     private List<OCFile> mChildren;
  85
  86     /** Counter of conflicts found between local and remote files */
  87     private int mConflictsFound;
  88
  89     /** Counter of failed operations in synchronization of kept-in-sync files */
  90     private int mFailsInFavouritesFound;
  91
  92     /** Map of remote and local paths to files that where locally stored in a location out of the ownCloud folder and couldn't be copied automatically into it */
  93     private Map<String, String> mForgottenLocalFiles;
  94
  95     /** 'True' means that this operation is part of a full account synchronization */
  96     private boolean mSyncFullAccount;
  97
  98     /** 'True' means that the remote folder changed from last synchronization and should be fetched */
  99     private boolean mRemoteFolderChanged;
 100
 101
 102     /**
 103      * Creates a new instance of {@link SynchronizeFolderOperation}.
 104      *
 105      * @param   remoteFolderPath        Remote folder to synchronize.
 106      * @param   currentSyncTime         Time stamp for the synchronization process in progress.
 107      * @param   localFolderId           Identifier in the local database of the folder to synchronize.
 108      * @param   updateFolderProperties  'True' means that the properties of the folder should be updated also, not just its content.
 109      * @param   syncFullAccount         'True' means that this operation is part of a full account synchronization.
 110      * @param   dataStorageManager      Interface with the local database.
 111      * @param   account                 ownCloud account where the folder is located.
 112      * @param   context                 Application context.
 113      */
 114     public SynchronizeFolderOperation(  OCFile folder,
 115                                         long currentSyncTime,
 116                                         boolean syncFullAccount,
 117                                         FileDataStorageManager dataStorageManager,
 118                                         Account account,
 119                                         Context context ) {
 120         mLocalFolder = folder;
 121         mCurrentSyncTime = currentSyncTime;
 122         mSyncFullAccount = syncFullAccount;
 123         mStorageManager = dataStorageManager;
 124         mAccount = account;
 125         mContext = context;
 126         mForgottenLocalFiles = new HashMap<String, String>();
 127         mRemoteFolderChanged = false;
 128     }
 129
 130
 131     public int getConflictsFound() {
 132         return mConflictsFound;
 133     }
 134
 135     public int getFailsInFavouritesFound() {
 136         return mFailsInFavouritesFound;
 137     }
 138
 139     public Map<String, String> getForgottenLocalFiles() {
 140         return mForgottenLocalFiles;
 141     }
 142
 143     /**
 144      * Returns the list of files and folders contained in the synchronized folder, if called after synchronization is complete.
 145      *
 146      * @return  List of files and folders contained in the synchronized folder.
 147      */
 148     public List<OCFile> getChildren() {
 149         return mChildren;
 150     }
 151
 152     /**
 153      * Performs the synchronization.
 154      *
 155      * {@inheritDoc}
 156      */
 157     @Override
 158     protected RemoteOperationResult run(OwnCloudClient client) {
 159         RemoteOperationResult result = null;
 160         mFailsInFavouritesFound = 0;
 161         mConflictsFound = 0;
 162         mForgottenLocalFiles.clear();
 163
 164         result = checkForChanges(client);
 165
 166         if (result.isSuccess()) {
 167             if (mRemoteFolderChanged) {
 168                 result = fetchAndSyncRemoteFolder(client);
 169             } else {
 170                 mChildren = mStorageManager.getFolderContent(mLocalFolder);
 171             }
 172         }
 173
 174         if (!mSyncFullAccount) {
 175             sendStickyBroadcast(false, mLocalFolder.getRemotePath(), result);
 176         }
 177
 178         return result;
 179
 180     }
 181
 182
 183     private RemoteOperationResult checkForChanges(OwnCloudClient client) {
 184         mRemoteFolderChanged = false;
 185         RemoteOperationResult result = null;
 186         String remotePath = null;
 187
 188             remotePath = mLocalFolder.getRemotePath();
 189             Log_OC.d(TAG, "Checking changes in " + mAccount.name + remotePath);
 190
 191             // remote request
 192             ReadRemoteFileOperation operation = new ReadRemoteFileOperation(remotePath);
 193             result = operation.execute(client);
 194             if (result.isSuccess()){
 195                 OCFile remoteFolder = FileStorageUtils.fillOCFile((RemoteFile) result.getData().get(0));
 196
 197              // check if remote and local folder are different
 198               mRemoteFolderChanged = !(remoteFolder.getEtag().equalsIgnoreCase(mLocalFolder.getEtag()));
 199
 200               result = new RemoteOperationResult(ResultCode.OK);
 201
 202               Log_OC.i(TAG, "Checked " + mAccount.name + remotePath + " : " + (mRemoteFolderChanged ? "changed" : "not changed"));
 203             } else {
 204                 // check failed
 205                 if (result.getCode() == ResultCode.FILE_NOT_FOUND) {
 206                     removeLocalFolder();
 207                 }
 208                 if (result.isException()) {
 209                     Log_OC.e(TAG, "Checked " + mAccount.name + remotePath  + " : " + result.getLogMessage(), result.getException());
 210                 } else {
 211                     Log_OC.e(TAG, "Checked " + mAccount.name + remotePath + " : " + result.getLogMessage());
 212                 }
 213             }
 214
 215         return result;
 216     }
 217
 218
 219     private RemoteOperationResult fetchAndSyncRemoteFolder(OwnCloudClient client) {
 220         String remotePath = mLocalFolder.getRemotePath();
 221         ReadRemoteFolderOperation operation = new ReadRemoteFolderOperation(remotePath);
 222         RemoteOperationResult result = operation.execute(client);
 223         Log_OC.d(TAG, "Synchronizing " + mAccount.name + remotePath);
 224
 225         if (result.isSuccess()) {
 226             ArrayList<RemoteFile> remotes = new ArrayList<RemoteFile>();
 227             for(Object obj: result.getData()) {
 228                 remotes.add((RemoteFile) obj);
 229             }
 230             synchronizeData(remotes, client);
 231             if (mConflictsFound > 0  || mFailsInFavouritesFound > 0) {
 232                 result = new RemoteOperationResult(ResultCode.SYNC_CONFLICT);   // should be different result, but will do the job
 233             }
 234         } else {
 235             if (result.getCode() == ResultCode.FILE_NOT_FOUND)
 236                 removeLocalFolder();
 237         }
 238
 239         return result;
 240     }
 241
 242
 243     private void removeLocalFolder() {
 244         if (mStorageManager.fileExists(mLocalFolder.getFileId())) {
 245             String currentSavePath = FileStorageUtils.getSavePath(mAccount.name);
 246             mStorageManager.removeFolder(mLocalFolder, true, (mLocalFolder.isDown() && mLocalFolder.getStoragePath().startsWith(currentSavePath)));
 247         }
 248     }
 249
 250
 251     /**
 252      *  Synchronizes the data retrieved from the server about the contents of the target folder
 253      *  with the current data in the local database.
 254      *
 255      *  Grants that mChildren is updated with fresh data after execution.
 256      *
 257      *  @param folderAndFiles   Remote folder and children files in Folder
 258      *
 259      *  @param client           Client instance to the remote server where the data were
 260      *                          retrieved.
 261      *  @return                 'True' when any change was made in the local data, 'false' otherwise.
 262      */
 263     private void synchronizeData(ArrayList<RemoteFile> folderAndFiles, OwnCloudClient client) {
 264         // get 'fresh data' from the database
 265         mLocalFolder = mStorageManager.getFileByPath(mLocalFolder.getRemotePath());
 266
 267         // parse data from remote folder
 268         OCFile remoteFolder = fillOCFile(folderAndFiles.get(0));
 269         remoteFolder.setParentId(mLocalFolder.getParentId());
 270         remoteFolder.setFileId(mLocalFolder.getFileId());
 271
 272         Log_OC.d(TAG, "Remote folder " + mLocalFolder.getRemotePath() + " changed - starting update of local data ");
 273
 274         List<OCFile> updatedFiles = new Vector<OCFile>(folderAndFiles.size() - 1);
 275         List<SynchronizeFileOperation> filesToSyncContents = new Vector<SynchronizeFileOperation>();
 276
 277         // get current data about local contents of the folder to synchronize
 278         List<OCFile> localFiles = mStorageManager.getFolderContent(mLocalFolder);
 279         Map<String, OCFile> localFilesMap = new HashMap<String, OCFile>(localFiles.size());
 280         for (OCFile file : localFiles) {
 281             localFilesMap.put(file.getRemotePath(), file);
 282         }
 283
 284         // loop to update every child
 285         OCFile remoteFile = null, localFile = null;
 286         for (int i=1; i<folderAndFiles.size(); i++) {
 287             /// new OCFile instance with the data from the server
 288             remoteFile = fillOCFile(folderAndFiles.get(i));
 289             remoteFile.setParentId(mLocalFolder.getFileId());
 290
 291             /// retrieve local data for the read file
 292             //localFile = mStorageManager.getFileByPath(remoteFile.getRemotePath());
 293             localFile = localFilesMap.remove(remoteFile.getRemotePath());
 294
 295             /// add to the remoteFile (the new one) data about LOCAL STATE (not existing in the server side)
 296             remoteFile.setLastSyncDateForProperties(mCurrentSyncTime);
 297             if (localFile != null) {
 298                 // some properties of local state are kept unmodified
 299                 remoteFile.setFileId(localFile.getFileId());
 300                 remoteFile.setKeepInSync(localFile.keepInSync());
 301                 remoteFile.setLastSyncDateForData(localFile.getLastSyncDateForData());
 302                 remoteFile.setModificationTimestampAtLastSyncForData(localFile.getModificationTimestampAtLastSyncForData());
 303                 remoteFile.setStoragePath(localFile.getStoragePath());
 304                 remoteFile.setEtag(localFile.getEtag());    // eTag will not be updated unless contents are synchronized (Synchronize[File|Folder]Operation with remoteFile as parameter)
 305                 if (remoteFile.isFolder()) {
 306                     remoteFile.setFileLength(localFile.getFileLength()); // TODO move operations about size of folders to FileContentProvider
 307                 }
 308             } else {
 309                 remoteFile.setEtag(""); // remote eTag will not be updated unless contents are synchronized (Synchronize[File|Folder]Operation with remoteFile as parameter)
 310             }
 311
 312             /// check and fix, if needed, local storage path
 313             checkAndFixForeignStoragePath(remoteFile);      // fixing old policy - now local files must be copied into the ownCloud local folder
 314             searchForLocalFileInDefaultPath(remoteFile);    // legacy
 315
 316             /// prepare content synchronization for kept-in-sync files
 317             if (remoteFile.keepInSync()) {
 318                 SynchronizeFileOperation operation = new SynchronizeFileOperation(  localFile,
 319                                                                                     remoteFile,
 320                                                                                     mStorageManager,
 321                                                                                     mAccount,
 322                                                                                     true,
 323                                                                                     mContext
 324                                                                                     );
 325                 filesToSyncContents.add(operation);
 326             }
 327
 328             updatedFiles.add(remoteFile);
 329         }
 330
 331         // save updated contents in local database; all at once, trying to get a best performance in database update (not a big deal, indeed)
 332         mStorageManager.saveFolder(remoteFolder, updatedFiles, localFilesMap.values());
 333
 334         // request for the synchronization of file contents AFTER saving current remote properties
 335         startContentSynchronizations(filesToSyncContents, client);
 336
 337         // removal of obsolete files
 338         //removeObsoleteFiles();
 339
 340         // must be done AFTER saving all the children information, so that eTag is not updated in the database in case of unexpected exceptions
 341         //mStorageManager.saveFile(remoteFolder);
 342         mChildren = updatedFiles;
 343
 344     }
 345
 346     /**
 347      * Performs a list of synchronization operations, determining if a download or upload is needed or
 348      * if exists conflict due to changes both in local and remote contents of the each file.
 349      *
 350      * If download or upload is needed, request the operation to the corresponding service and goes on.
 351      *
 352      * @param filesToSyncContents       Synchronization operations to execute.
 353      * @param client                    Interface to the remote ownCloud server.
 354      */
 355     private void startContentSynchronizations(List<SynchronizeFileOperation> filesToSyncContents, OwnCloudClient client) {
 356         RemoteOperationResult contentsResult = null;
 357         for (SynchronizeFileOperation op: filesToSyncContents) {
 358             contentsResult = op.execute(client);   // returns without waiting for upload or download finishes
 359             if (!contentsResult.isSuccess()) {
 360                 if (contentsResult.getCode() == ResultCode.SYNC_CONFLICT) {
 361                     mConflictsFound++;
 362                 } else {
 363                     mFailsInFavouritesFound++;
 364                     if (contentsResult.getException() != null) {
 365                         Log_OC.e(TAG, "Error while synchronizing favourites : " +  contentsResult.getLogMessage(), contentsResult.getException());
 366                     } else {
 367                         Log_OC.e(TAG, "Error while synchronizing favourites : " + contentsResult.getLogMessage());
 368                     }
 369                 }
 370             }   // won't let these fails break the synchronization process
 371         }
 372     }
 373
 374
 375     public boolean isMultiStatus(int status) {
 376         return (status == HttpStatus.SC_MULTI_STATUS);
 377     }
 378
 379     /**
 380      * Creates and populates a new {@link OCFile} object with the data read from the server.
 381      *
 382      * @param remote    remote file read from the server (remote file or folder).
 383      * @return          New OCFile instance representing the remote resource described by we.
 384      */
 385     private OCFile fillOCFile(RemoteFile remote) {
 386         OCFile file = new OCFile(remote.getRemotePath());
 387         file.setCreationTimestamp(remote.getCreationTimestamp());
 388         file.setFileLength(remote.getLength());
 389         file.setMimetype(remote.getMimeType());
 390         file.setModificationTimestamp(remote.getModifiedTimestamp());
 391         file.setEtag(remote.getEtag());
 392         return file;
 393     }
 394
 395
 396     /**
 397      * Checks the storage path of the OCFile received as parameter. If it's out of the local ownCloud folder,
 398      * tries to copy the file inside it.
 399      *
 400      * If the copy fails, the link to the local file is nullified. The account of forgotten files is kept in
 401      * {@link #mForgottenLocalFiles}
 402      *)
 403      * @param file      File to check and fix.
 404      */
 405     private void checkAndFixForeignStoragePath(OCFile file) {
 406         String storagePath = file.getStoragePath();
 407         String expectedPath = FileStorageUtils.getDefaultSavePathFor(mAccount.name, file);
 408         if (storagePath != null && !storagePath.equals(expectedPath)) {
 409             /// fix storagePaths out of the local ownCloud folder
 410             File originalFile = new File(storagePath);
 411             if (FileStorageUtils.getUsableSpace(mAccount.name) < originalFile.length()) {
 412                 mForgottenLocalFiles.put(file.getRemotePath(), storagePath);
 413                 file.setStoragePath(null);
 414
 415             } else {
 416                 InputStream in = null;
 417                 OutputStream out = null;
 418                 try {
 419                     File expectedFile = new File(expectedPath);
 420                     File expectedParent = expectedFile.getParentFile();
 421                     expectedParent.mkdirs();
 422                     if (!expectedParent.isDirectory()) {
 423                         throw new IOException("Unexpected error: parent directory could not be created");
 424                     }
 425                     expectedFile.createNewFile();
 426                     if (!expectedFile.isFile()) {
 427                         throw new IOException("Unexpected error: target file could not be created");
 428                     }
 429                     in = new FileInputStream(originalFile);
 430                     out = new FileOutputStream(expectedFile);
 431                     byte[] buf = new byte[1024];
 432                     int len;
 433                     while ((len = in.read(buf)) > 0){
 434                         out.write(buf, 0, len);
 435                     }
 436                     file.setStoragePath(expectedPath);
 437
 438                 } catch (Exception e) {
 439                     Log_OC.e(TAG, "Exception while copying foreign file " + expectedPath, e);
 440                     mForgottenLocalFiles.put(file.getRemotePath(), storagePath);
 441                     file.setStoragePath(null);
 442
 443                 } finally {
 444                     try {
 445                         if (in != null) in.close();
 446                     } catch (Exception e) {
 447                         Log_OC.d(TAG, "Weird exception while closing input stream for " + storagePath + " (ignoring)", e);
 448                     }
 449                     try {
 450                         if (out != null) out.close();
 451                     } catch (Exception e) {
 452                         Log_OC.d(TAG, "Weird exception while closing output stream for " + expectedPath + " (ignoring)", e);
 453                     }
 454                 }
 455             }
 456         }
 457     }
 458
 459     /**
 460      * Scans the default location for saving local copies of files searching for
 461      * a 'lost' file with the same full name as the {@link OCFile} received as
 462      * parameter.
 463      *
 464      * @param file      File to associate a possible 'lost' local file.
 465      */
 466     private void searchForLocalFileInDefaultPath(OCFile file) {
 467         if (file.getStoragePath() == null && !file.isFolder()) {
 468             File f = new File(FileStorageUtils.getDefaultSavePathFor(mAccount.name, file));
 469             if (f.exists()) {
 470                 file.setStoragePath(f.getAbsolutePath());
 471                 file.setLastSyncDateForData(f.lastModified());
 472             }
 473         }
 474     }
 475
 476
 477     /**
 478      * Sends a message to any application component interested in the progress of the synchronization.
 479      *
 480      * @param inProgress        'True' when the synchronization progress is not finished.
 481      * @param dirRemotePath     Remote path of a folder that was just synchronized (with or without success)
 482      */
 483     private void sendStickyBroadcast(boolean inProgress, String dirRemotePath, RemoteOperationResult result) {
 484         Intent i = new Intent(FileSyncService.getSyncMessage());
 485         i.putExtra(FileSyncService.IN_PROGRESS, inProgress);
 486         i.putExtra(FileSyncService.ACCOUNT_NAME, mAccount.name);
 487         if (dirRemotePath != null) {
 488             i.putExtra(FileSyncService.SYNC_FOLDER_REMOTE_PATH, dirRemotePath);
 489         }
 490         if (result != null) {
 491             i.putExtra(FileSyncService.SYNC_RESULT, result);
 492         }
 493         mContext.sendStickyBroadcast(i);
 494     }
 495
 496
 497     public boolean getRemoteFolderChanged() {
 498         return mRemoteFolderChanged;
 499     }
 500
 501 }