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