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.HashMap;
  27 import java.util.List;
  28 import java.util.Map;
  29 import java.util.Vector;
  30
  31 import org.apache.http.HttpStatus;
  32 import org.apache.jackrabbit.webdav.MultiStatus;
  33 import org.apache.jackrabbit.webdav.client.methods.PropFindMethod;
  34
  35 import android.accounts.Account;
  36 import android.content.Context;
  37
  38 import com.owncloud.android.Log_OC;
  39 import com.owncloud.android.datamodel.DataStorageManager;
  40 import com.owncloud.android.datamodel.OCFile;
  41 import com.owncloud.android.operations.RemoteOperationResult.ResultCode;
  42 import com.owncloud.android.utils.FileStorageUtils;
  43
  44 import eu.alefzero.webdav.WebdavClient;
  45 import eu.alefzero.webdav.WebdavEntry;
  46 import eu.alefzero.webdav.WebdavUtils;
  47
  48
  49 /**
  50  * Remote operation performing the synchronization a the contents of a remote folder with the local database
  51  *
  52  * @author David A. Velasco
  53  */
  54 public class SynchronizeFolderOperation extends RemoteOperation {
  55
  56     private static final String TAG = SynchronizeFolderOperation.class.getSimpleName();
  57
  58     /** Remote folder to synchronize */
  59     private String mRemotePath;
  60
  61     /** Timestamp for the synchronization in progress */
  62     private long mCurrentSyncTime;
  63
  64     /** Id of the folder to synchronize in the local database */
  65     private long mParentId;
  66
  67     /** Access to the local database */
  68     private DataStorageManager mStorageManager;
  69
  70     /** Account where the file to synchronize belongs */
  71     private Account mAccount;
  72
  73     /** Android context; necessary to send requests to the download service; maybe something to refactor */
  74     private Context mContext;
  75
  76     /** Files and folders contained in the synchronized folder */
  77     private List<OCFile> mChildren;
  78
  79     private int mConflictsFound;
  80
  81     private int mFailsInFavouritesFound;
  82
  83     private Map<String, String> mForgottenLocalFiles;
  84
  85
  86     public SynchronizeFolderOperation(  String remotePath,
  87                                         long currentSyncTime,
  88                                         long parentId,
  89                                         DataStorageManager dataStorageManager,
  90                                         Account account,
  91                                         Context context ) {
  92         mRemotePath = remotePath;
  93         mCurrentSyncTime = currentSyncTime;
  94         mParentId = parentId;
  95         mStorageManager = dataStorageManager;
  96         mAccount = account;
  97         mContext = context;
  98         mForgottenLocalFiles = new HashMap<String, String>();
  99     }
 100
 101
 102     public int getConflictsFound() {
 103         return mConflictsFound;
 104     }
 105
 106     public int getFailsInFavouritesFound() {
 107         return mFailsInFavouritesFound;
 108     }
 109
 110     public Map<String, String> getForgottenLocalFiles() {
 111         return mForgottenLocalFiles;
 112     }
 113
 114     /**
 115      * Returns the list of files and folders contained in the synchronized folder, if called after synchronization is complete.
 116      *
 117      * @return      List of files and folders contained in the synchronized folder.
 118      */
 119     public List<OCFile> getChildren() {
 120         return mChildren;
 121     }
 122
 123
 124     @Override
 125     protected RemoteOperationResult run(WebdavClient client) {
 126         RemoteOperationResult result = null;
 127         mFailsInFavouritesFound = 0;
 128         mConflictsFound = 0;
 129         mForgottenLocalFiles.clear();
 130
 131         // code before in FileSyncAdapter.fetchData
 132         PropFindMethod query = null;
 133         try {
 134             Log_OC.d(TAG, "Synchronizing " + mAccount.name + ", fetching files in " + mRemotePath);
 135
 136             // remote request
 137             query = new PropFindMethod(client.getBaseUri() + WebdavUtils.encodePath(mRemotePath));
 138             int status = client.executeMethod(query);
 139
 140             // check and process response   - /// TODO take into account all the possible status per child-resource
 141             if (isMultiStatus(status)) {
 142                 MultiStatus resp = query.getResponseBodyAsMultiStatus();
 143
 144                 // synchronize properties of the parent folder, if necessary
 145                 if (mParentId == DataStorageManager.ROOT_PARENT_ID) {
 146                     WebdavEntry we = new WebdavEntry(resp.getResponses()[0], client.getBaseUri().getPath());
 147                     OCFile parent = fillOCFile(we);
 148                     mStorageManager.saveFile(parent);
 149                     mParentId = parent.getFileId();
 150                 }
 151
 152                 // read contents in folder
 153                 List<OCFile> updatedFiles = new Vector<OCFile>(resp.getResponses().length - 1);
 154                 List<SynchronizeFileOperation> filesToSyncContents = new Vector<SynchronizeFileOperation>();
 155                 for (int i = 1; i < resp.getResponses().length; ++i) {
 156                     /// new OCFile instance with the data from the server
 157                     WebdavEntry we = new WebdavEntry(resp.getResponses()[i], client.getBaseUri().getPath());
 158                     OCFile file = fillOCFile(we);
 159
 160                     /// set data about local state, keeping unchanged former data if existing
 161                     file.setLastSyncDateForProperties(mCurrentSyncTime);
 162                     OCFile oldFile = mStorageManager.getFileByPath(file.getRemotePath());
 163                     if (oldFile != null) {
 164                         file.setKeepInSync(oldFile.keepInSync());
 165                         file.setLastSyncDateForData(oldFile.getLastSyncDateForData());
 166                         file.setModificationTimestampAtLastSyncForData(oldFile.getModificationTimestampAtLastSyncForData());    // must be kept unchanged when the file contents are not updated
 167                         checkAndFixForeignStoragePath(oldFile);
 168                         file.setStoragePath(oldFile.getStoragePath());
 169                     }
 170
 171                     /// scan default location if local copy of file is not linked in OCFile instance
 172                     if (file.getStoragePath() == null && !file.isDirectory()) {
 173                         File f = new File(FileStorageUtils.getDefaultSavePathFor(mAccount.name, file));
 174                         if (f.exists()) {
 175                             file.setStoragePath(f.getAbsolutePath());
 176                             file.setLastSyncDateForData(f.lastModified());
 177                         }
 178                     }
 179
 180                     /// prepare content synchronization for kept-in-sync files
 181                     if (file.keepInSync()) {
 182                         SynchronizeFileOperation operation = new SynchronizeFileOperation(  oldFile,
 183                                                                                             file,
 184                                                                                             mStorageManager,
 185                                                                                             mAccount,
 186                                                                                             true,
 187                                                                                             false,
 188                                                                                             mContext
 189                                                                                             );
 190                         filesToSyncContents.add(operation);
 191                     }
 192
 193                     updatedFiles.add(file);
 194                 }
 195
 196                 // save updated contents in local database; all at once, trying to get a best performance in database update (not a big deal, indeed)
 197                 mStorageManager.saveFiles(updatedFiles);
 198
 199                 // request for the synchronization of files AFTER saving last properties
 200                 SynchronizeFileOperation op = null;
 201                 RemoteOperationResult contentsResult = null;
 202                 for (int i=0; i < filesToSyncContents.size(); i++) {
 203                     op = filesToSyncContents.get(i);
 204                     contentsResult = op.execute(client);   // returns without waiting for upload or download finishes
 205                     if (!contentsResult.isSuccess()) {
 206                         if (contentsResult.getCode() == ResultCode.SYNC_CONFLICT) {
 207                             mConflictsFound++;
 208                         } else {
 209                             mFailsInFavouritesFound++;
 210                             if (contentsResult.getException() != null) {
 211                                 Log_OC.d(TAG, "Error while synchronizing favourites : " +  contentsResult.getLogMessage(), contentsResult.getException());
 212                             } else {
 213                                 Log_OC.d(TAG, "Error while synchronizing favourites : " + contentsResult.getLogMessage());
 214                             }
 215                         }
 216                     }   // won't let these fails break the synchronization process
 217                 }
 218
 219
 220                 // removal of obsolete files
 221                 mChildren = mStorageManager.getDirectoryContent(mStorageManager.getFileById(mParentId));
 222                 OCFile file;
 223                 String currentSavePath = FileStorageUtils.getSavePath(mAccount.name);
 224                 for (int i=0; i < mChildren.size(); ) {
 225                     file = mChildren.get(i);
 226                     if (file.getLastSyncDateForProperties() != mCurrentSyncTime) {
 227                         Log_OC.d(TAG, "removing file: " + file);
 228                         mStorageManager.removeFile(file, (file.isDown() && file.getStoragePath().startsWith(currentSavePath)));
 229                         mChildren.remove(i);
 230                     } else {
 231                         i++;
 232                     }
 233                 }
 234
 235             } else {
 236                 client.exhaustResponse(query.getResponseBodyAsStream());
 237             }
 238
 239             // prepare result object
 240             if (isMultiStatus(status)) {
 241                 if (mConflictsFound > 0  || mFailsInFavouritesFound > 0) {
 242                     result = new RemoteOperationResult(ResultCode.SYNC_CONFLICT);   // should be different result, but will do the job
 243
 244                 } else {
 245                     result = new RemoteOperationResult(true, status);
 246                 }
 247             } else {
 248                 result = new RemoteOperationResult(false, status);
 249             }
 250             Log_OC.i(TAG, "Synchronizing " + mAccount.name + ", folder " + mRemotePath + ": " + result.getLogMessage());
 251
 252
 253         } catch (Exception e) {
 254             result = new RemoteOperationResult(e);
 255             Log_OC.e(TAG, "Synchronizing " + mAccount.name + ", folder " + mRemotePath + ": " + result.getLogMessage(), result.getException());
 256
 257         } finally {
 258             if (query != null)
 259                 query.releaseConnection();  // let the connection available for other methods
 260         }
 261
 262         return result;
 263     }
 264
 265
 266     public boolean isMultiStatus(int status) {
 267         return (status == HttpStatus.SC_MULTI_STATUS);
 268     }
 269
 270
 271     /**
 272      * Creates and populates a new {@link OCFile} object with the data read from the server.
 273      *
 274      * @param we        WebDAV entry read from the server for a WebDAV resource (remote file or folder).
 275      * @return          New OCFile instance representing the remote resource described by we.
 276      */
 277     private OCFile fillOCFile(WebdavEntry we) {
 278         OCFile file = new OCFile(we.decodedPath());
 279         file.setCreationTimestamp(we.createTimestamp());
 280         file.setFileLength(we.contentLength());
 281         file.setMimetype(we.contentType());
 282         file.setModificationTimestamp(we.modifiedTimestamp());
 283         file.setParentId(mParentId);
 284         return file;
 285     }
 286
 287
 288     /**
 289      * Checks the storage path of the OCFile received as parameter. If it's out of the local ownCloud folder,
 290      * tries to copy the file inside it.
 291      *
 292      * If the copy fails, the link to the local file is nullified. The account of forgotten files is kept in
 293      * {@link #mForgottenLocalFiles}
 294      *
 295      * @param file      File to check and fix.
 296      */
 297     private void checkAndFixForeignStoragePath(OCFile file) {
 298         String storagePath = file.getStoragePath();
 299         String expectedPath = FileStorageUtils.getDefaultSavePathFor(mAccount.name, file);
 300         if (storagePath != null && !storagePath.equals(expectedPath)) {
 301             /// fix storagePaths out of the local ownCloud folder
 302             File originalFile = new File(storagePath);
 303             if (FileStorageUtils.getUsableSpace(mAccount.name) < originalFile.length()) {
 304                 mForgottenLocalFiles.put(file.getRemotePath(), storagePath);
 305                 file.setStoragePath(null);
 306
 307             } else {
 308                 InputStream in = null;
 309                 OutputStream out = null;
 310                 try {
 311                     File expectedFile = new File(expectedPath);
 312                     File expectedParent = expectedFile.getParentFile();
 313                     expectedParent.mkdirs();
 314                     if (!expectedParent.isDirectory()) {
 315                         throw new IOException("Unexpected error: parent directory could not be created");
 316                     }
 317                     expectedFile.createNewFile();
 318                     if (!expectedFile.isFile()) {
 319                         throw new IOException("Unexpected error: target file could not be created");
 320                     }
 321                     in = new FileInputStream(originalFile);
 322                     out = new FileOutputStream(expectedFile);
 323                     byte[] buf = new byte[1024];
 324                     int len;
 325                     while ((len = in.read(buf)) > 0){
 326                         out.write(buf, 0, len);
 327                     }
 328                     file.setStoragePath(expectedPath);
 329
 330                 } catch (Exception e) {
 331                     Log_OC.e(TAG, "Exception while copying foreign file " + expectedPath, e);
 332                     mForgottenLocalFiles.put(file.getRemotePath(), storagePath);
 333                     file.setStoragePath(null);
 334
 335                 } finally {
 336                     try {
 337                         if (in != null) in.close();
 338                     } catch (Exception e) {
 339                         Log_OC.d(TAG, "Weird exception while closing input stream for " + storagePath + " (ignoring)", e);
 340                     }
 341                     try {
 342                         if (out != null) out.close();
 343                     } catch (Exception e) {
 344                         Log_OC.d(TAG, "Weird exception while closing output stream for " + expectedPath + " (ignoring)", e);
 345                     }
 346                 }
 347             }
 348         }
 349     }
 350
 351
 352 }