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

   1 /* ownCloud Android client application
   2  *   Copyright (C) 2012 Bartek Przybylski
   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 as published by
   6  *   the Free Software Foundation, either version 3 of the License, or
   7  *   (at your option) any later version.
   8  *
   9  *   This program is distributed in the hope that it will be useful,
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *   GNU General Public License for more details.
  13  *
  14  *   You should have received a copy of the GNU General Public License
  15  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  *
  17  */
  18
  19 package com.owncloud.android.operations;
  20
  21 import java.io.File;
  22 import java.io.FileInputStream;
  23 import java.io.FileOutputStream;
  24 import java.io.IOException;
  25 import java.io.InputStream;
  26 import java.io.OutputStream;
  27 import java.util.HashSet;
  28 import java.util.Set;
  29 import java.util.concurrent.atomic.AtomicBoolean;
  30
  31 import org.apache.commons.httpclient.HttpException;
  32 import org.apache.commons.httpclient.methods.PutMethod;
  33 import org.apache.http.HttpStatus;
  34
  35 import com.owncloud.android.datamodel.OCFile;
  36 import com.owncloud.android.files.services.FileUploader;
  37 import com.owncloud.android.operations.RemoteOperation;
  38 import com.owncloud.android.operations.RemoteOperationResult;
  39 import com.owncloud.android.operations.RemoteOperationResult.ResultCode;
  40 import com.owncloud.android.utils.FileStorageUtils;
  41
  42 import eu.alefzero.webdav.FileRequestEntity;
  43 import eu.alefzero.webdav.OnDatatransferProgressListener;
  44 import eu.alefzero.webdav.WebdavClient;
  45 import eu.alefzero.webdav.WebdavUtils;
  46 import android.accounts.Account;
  47 import android.util.Log;
  48
  49 /**
  50  * Remote operation performing the upload of a file to an ownCloud server
  51  *
  52  * @author David A. Velasco
  53  */
  54 public class UploadFileOperation extends RemoteOperation {
  55
  56     private static final String TAG = UploadFileOperation.class.getSimpleName();
  57
  58     private Account mAccount;
  59     private OCFile mFile;
  60     private OCFile mOldFile;
  61     private String mRemotePath = null;
  62     private boolean mIsInstant = false;
  63     private boolean mRemoteFolderToBeCreated = false;
  64     private boolean mForceOverwrite = false;
  65     private int mLocalBehaviour = FileUploader.LOCAL_BEHAVIOUR_COPY;
  66     private boolean mWasRenamed = false;
  67     PutMethod mPutMethod = null;
  68     private Set<OnDatatransferProgressListener> mDataTransferListeners = new HashSet<OnDatatransferProgressListener>();
  69     private final AtomicBoolean mCancellationRequested = new AtomicBoolean(false);
  70
  71
  72     public UploadFileOperation( Account account,
  73                                 OCFile file,
  74                                 boolean isInstant,
  75                                 boolean forceOverwrite,
  76                                 int localBehaviour) {
  77         if (account == null)
  78             throw new IllegalArgumentException("Illegal NULL account in UploadFileOperation creation");
  79         if (file == null)
  80             throw new IllegalArgumentException("Illegal NULL file in UploadFileOperation creation");
  81         if (file.getStoragePath() == null || file.getStoragePath().length() <= 0 || !(new File(file.getStoragePath()).exists())) {
  82             throw new IllegalArgumentException("Illegal file in UploadFileOperation; storage path invalid or file not found: " + file.getStoragePath());
  83         }
  84
  85         mAccount = account;
  86         mFile = file;
  87         mRemotePath = file.getRemotePath();
  88         mIsInstant = isInstant;
  89         mForceOverwrite = forceOverwrite;
  90         mLocalBehaviour = localBehaviour;
  91     }
  92
  93
  94     public Account getAccount() {
  95         return mAccount;
  96     }
  97
  98     public OCFile getFile() {
  99         return mFile;
 100     }
 101
 102     public OCFile getOldFile() {
 103         return mOldFile;
 104     }
 105
 106     public String getStoragePath() {
 107         return mFile.getStoragePath();
 108     }
 109
 110     public String getRemotePath() {
 111         return mFile.getRemotePath();
 112     }
 113
 114     public String getMimeType() {
 115         return mFile.getMimetype();
 116     }
 117
 118     public boolean isInstant() {
 119         return mIsInstant;
 120     }
 121
 122     public boolean isRemoteFolderToBeCreated() {
 123         return mRemoteFolderToBeCreated;
 124     }
 125
 126     public void setRemoteFolderToBeCreated() {
 127         mRemoteFolderToBeCreated = true;
 128     }
 129
 130     public boolean getForceOverwrite() {
 131         return mForceOverwrite;
 132     }
 133
 134     public boolean wasRenamed() {
 135         return mWasRenamed;
 136     }
 137
 138     public Set<OnDatatransferProgressListener> getDataTransferListeners() {
 139         return mDataTransferListeners;
 140     }
 141
 142     public void addDatatransferProgressListener (OnDatatransferProgressListener listener) {
 143         mDataTransferListeners.add(listener);
 144     }
 145
 146     @Override
 147     protected RemoteOperationResult run(WebdavClient client) {
 148         RemoteOperationResult result = null;
 149         boolean localCopyPassed = false, nameCheckPassed = false;
 150         String originalStoragePath = mFile.getStoragePath();
 151         File temporalFile = null, originalFile = new File(originalStoragePath), expectedFile = null;
 152         try {
 153             /// rename the file to upload, if necessary
 154             if (!mForceOverwrite) {
 155                 String remotePath = getAvailableRemotePath(client, mRemotePath);
 156                 mWasRenamed = !remotePath.equals(mRemotePath);
 157                 if (mWasRenamed) {
 158                    createNewOCFile(remotePath);
 159                 }
 160             }
 161             nameCheckPassed = true;
 162
 163             String expectedPath = FileStorageUtils.getDefaultSavePathFor(mAccount.name, mFile);  /// not before getAvailableRemotePath() !!!
 164             expectedFile = new File(expectedPath);
 165
 166             /// check location of local file; if not the expected, copy to a temporal file before upload (if COPY is the expected behaviour)
 167             if (!originalStoragePath.equals(expectedPath) && mLocalBehaviour == FileUploader.LOCAL_BEHAVIOUR_COPY) {
 168
 169                 if (FileStorageUtils.getUsableSpace(mAccount.name) < originalFile.length()) {
 170                     result = new RemoteOperationResult(ResultCode.LOCAL_STORAGE_FULL);
 171                     return result;  // error condition when the file should be copied
 172
 173                 } else {
 174                     String temporalPath = FileStorageUtils.getTemporalPath(mAccount.name) + mFile.getRemotePath();
 175                     mFile.setStoragePath(temporalPath);
 176                     temporalFile = new File(temporalPath);
 177                     if (!originalStoragePath.equals(temporalPath)) {   // preventing weird but possible situation
 178                         InputStream in = null;
 179                         OutputStream out = null;
 180                         try {
 181                             in = new FileInputStream(originalFile);
 182                             out = new FileOutputStream(temporalFile);
 183                             byte[] buf = new byte[1024];
 184                             int len;
 185                             while ((len = in.read(buf)) > 0){
 186                                 out.write(buf, 0, len);
 187                             }
 188
 189                         } catch (Exception e) {
 190                             result = new RemoteOperationResult(ResultCode.LOCAL_STORAGE_NOT_COPIED);
 191                             return result;
 192
 193                         } finally {
 194                             try {
 195                                 if (in != null) in.close();
 196                             } catch (Exception e) {
 197                                 Log.d(TAG, "Weird exception while closing input stream for " + originalStoragePath + " (ignoring)", e);
 198                             }
 199                             try {
 200                                 if (out != null) out.close();
 201                             } catch (Exception e) {
 202                                 Log.d(TAG, "Weird exception while closing output stream for " + expectedPath + " (ignoring)", e);
 203                             }
 204                         }
 205                     }
 206                 }
 207             }
 208             localCopyPassed = true;
 209
 210             /// perform the upload
 211             synchronized(mCancellationRequested) {
 212                 if (mCancellationRequested.get()) {
 213                     throw new OperationCancelledException();
 214                 } else {
 215                     mPutMethod = new PutMethod(client.getBaseUri() + WebdavUtils.encodePath(mFile.getRemotePath()));
 216                 }
 217             }
 218             int status = uploadFile(client);
 219
 220
 221             /// move local temporal file or original file to its corresponding location in the ownCloud local folder
 222             if (isSuccess(status)) {
 223                 if (mLocalBehaviour == FileUploader.LOCAL_BEHAVIOUR_FORGET) {
 224                     mFile.setStoragePath(null);
 225
 226                 } else {
 227                     mFile.setStoragePath(expectedPath);
 228                     File fileToMove = null;
 229                     if (temporalFile != null) {             // FileUploader.LOCAL_BEHAVIOUR_COPY ; see where temporalFile was set
 230                         fileToMove = temporalFile;
 231                     } else {                                // FileUploader.LOCAL_BEHAVIOUR_MOVE
 232                         fileToMove = originalFile;
 233                     }
 234                     expectedFile = new File(mFile.getStoragePath());
 235                     if (!expectedFile.equals(fileToMove) && !fileToMove.renameTo(expectedFile)) {
 236                         mFile.setStoragePath(null); // forget the local file
 237                         // by now, treat this as a success; the file was uploaded; the user won't like that the local file is not linked, but this should be a veeery rare fail;
 238                         // the best option could be show a warning message (but not a fail)
 239                         //result = new RemoteOperationResult(ResultCode.LOCAL_STORAGE_NOT_MOVED);
 240                         //return result;
 241                     }
 242                 }
 243             }
 244
 245             result = new RemoteOperationResult(isSuccess(status), status);
 246
 247
 248         } catch (Exception e) {
 249             // TODO something cleaner with cancellations
 250             if (mCancellationRequested.get()) {
 251                 result = new RemoteOperationResult(new OperationCancelledException());
 252             } else {
 253                 result = new RemoteOperationResult(e);
 254             }
 255
 256
 257         } finally {
 258             if (temporalFile != null && !originalFile.equals(temporalFile)) {
 259                 temporalFile.delete();
 260             }
 261             if (result.isSuccess()) {
 262                 Log.i(TAG, "Upload of " + originalStoragePath + " to " + mRemotePath + ": " + result.getLogMessage());
 263
 264             } else {
 265                 if (result.getException() != null) {
 266                     String complement = "";
 267                     if (!nameCheckPassed) {
 268                         complement = " (while checking file existence in server)";
 269                     } else if (!localCopyPassed) {
 270                         complement = " (while copying local file to " + FileStorageUtils.getSavePath(mAccount.name) + ")";
 271                     }
 272                     Log.e(TAG, "Upload of " + originalStoragePath + " to " + mRemotePath + ": " + result.getLogMessage() + complement, result.getException());
 273                 } else {
 274                     Log.e(TAG, "Upload of " + originalStoragePath + " to " + mRemotePath + ": " + result.getLogMessage());
 275                 }
 276             }
 277         }
 278
 279         return result;
 280     }
 281
 282
 283     private void createNewOCFile(String newRemotePath) {
 284         // a new OCFile instance must be created for a new remote path
 285         OCFile newFile = new OCFile(newRemotePath);
 286         newFile.setCreationTimestamp(mFile.getCreationTimestamp());
 287         newFile.setFileLength(mFile.getFileLength());
 288         newFile.setMimetype(mFile.getMimetype());
 289         newFile.setModificationTimestamp(mFile.getModificationTimestamp());
 290         // newFile.setEtag(mFile.getEtag())
 291         newFile.setKeepInSync(mFile.keepInSync());
 292         newFile.setLastSyncDateForProperties(mFile.getLastSyncDateForProperties());
 293         newFile.setLastSyncDateForData(mFile.getLastSyncDateForData());
 294         newFile.setStoragePath(mFile.getStoragePath());
 295         newFile.setParentId(mFile.getParentId());
 296         mOldFile = mFile;
 297         mFile = newFile;
 298     }
 299
 300
 301     public boolean isSuccess(int status) {
 302         return ((status == HttpStatus.SC_OK || status == HttpStatus.SC_CREATED || status == HttpStatus.SC_NO_CONTENT));
 303     }
 304
 305
 306     protected int uploadFile(WebdavClient client) throws HttpException, IOException, OperationCancelledException {
 307         int status = -1;
 308         try {
 309             File f = new File(mFile.getStoragePath());
 310             FileRequestEntity entity = new FileRequestEntity(f, getMimeType());
 311             entity.addOnDatatransferProgressListeners(mDataTransferListeners);
 312             mPutMethod.setRequestEntity(entity);
 313             status = client.executeMethod(mPutMethod);
 314             client.exhaustResponse(mPutMethod.getResponseBodyAsStream());
 315
 316         } finally {
 317             mPutMethod.releaseConnection();    // let the connection available for other methods
 318         }
 319         return status;
 320     }
 321
 322     /**
 323      * Checks if remotePath does not exist in the server and returns it, or adds a suffix to it in order to avoid the server
 324      * file is overwritten.
 325      *
 326      * @param string
 327      * @return
 328      */
 329     private String getAvailableRemotePath(WebdavClient wc, String remotePath) throws Exception {
 330         boolean check = wc.existsFile(remotePath);
 331         if (!check) {
 332             return remotePath;
 333         }
 334
 335         int pos = remotePath.lastIndexOf(".");
 336         String suffix = "";
 337         String extension = "";
 338         if (pos >= 0) {
 339             extension = remotePath.substring(pos+1);
 340             remotePath = remotePath.substring(0, pos);
 341         }
 342         int count = 2;
 343         do {
 344             suffix = " (" + count + ")";
 345             if (pos >= 0)
 346                 check = wc.existsFile(remotePath + suffix + "." + extension);
 347             else
 348                 check = wc.existsFile(remotePath + suffix);
 349             count++;
 350         } while (check);
 351
 352         if (pos >=0) {
 353             return remotePath + suffix + "." + extension;
 354         } else {
 355             return remotePath + suffix;
 356         }
 357     }
 358
 359
 360     public void cancel() {
 361         synchronized(mCancellationRequested) {
 362             mCancellationRequested.set(true);
 363             if (mPutMethod != null)
 364                 mPutMethod.abort();
 365         }
 366     }
 367
 368
 369 }