src/com/owncloud/android/files/services/FileUploader.java

   1 /* ownCloud Android client application
   2  *   Copyright (C) 2012 Bartek Przybylski
   3  *   Copyright (C) 2012-2013 ownCloud Inc.
   4  *
   5  *   This program is free software: you can redistribute it and/or modify
   6  *   it under the terms of the GNU General Public License version 2,
   7  *   as published by the Free Software Foundation.
   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.files.services;
  20
  21 import java.io.File;
  22 import java.io.IOException;
  23 import java.util.AbstractList;
  24 import java.util.HashMap;
  25 import java.util.Iterator;
  26 import java.util.Map;
  27 import java.util.Vector;
  28 import java.util.concurrent.ConcurrentHashMap;
  29 import java.util.concurrent.ConcurrentMap;
  30
  31 import org.apache.http.HttpStatus;
  32 import org.apache.jackrabbit.webdav.DavConstants;
  33 import org.apache.jackrabbit.webdav.MultiStatus;
  34 import org.apache.jackrabbit.webdav.client.methods.PropFindMethod;
  35
  36 import com.owncloud.android.Log_OC;
  37 import com.owncloud.android.MainApp;
  38 import com.owncloud.android.R;
  39 import com.owncloud.android.authentication.AccountAuthenticator;
  40 import com.owncloud.android.authentication.AuthenticatorActivity;
  41 import com.owncloud.android.datamodel.FileDataStorageManager;
  42 import com.owncloud.android.datamodel.OCFile;
  43 import com.owncloud.android.db.DbHandler;
  44 import com.owncloud.android.network.OwnCloudClientUtils;
  45 import com.owncloud.android.operations.ChunkedUploadFileOperation;
  46 import com.owncloud.android.operations.CreateFolderOperation;
  47 import com.owncloud.android.operations.ExistenceCheckOperation;
  48 import com.owncloud.android.operations.RemoteOperation;
  49 import com.owncloud.android.operations.RemoteOperationResult;
  50 import com.owncloud.android.operations.UploadFileOperation;
  51 import com.owncloud.android.operations.RemoteOperationResult.ResultCode;
  52 import com.owncloud.android.ui.activity.FailedUploadActivity;
  53 import com.owncloud.android.ui.activity.FileActivity;
  54 import com.owncloud.android.ui.activity.FileDisplayActivity;
  55 import com.owncloud.android.ui.activity.InstantUploadActivity;
  56 import com.owncloud.android.ui.preview.PreviewImageActivity;
  57 import com.owncloud.android.ui.preview.PreviewImageFragment;
  58 import com.owncloud.android.utils.OwnCloudVersion;
  59
  60
  61 import eu.alefzero.webdav.OnDatatransferProgressListener;
  62 import eu.alefzero.webdav.WebdavEntry;
  63 import eu.alefzero.webdav.WebdavUtils;
  64
  65
  66 import android.accounts.Account;
  67 import android.accounts.AccountManager;
  68 import android.accounts.AccountsException;
  69 import android.app.Notification;
  70 import android.app.NotificationManager;
  71 import android.app.PendingIntent;
  72 import android.app.Service;
  73 import android.content.Intent;
  74 import android.os.Binder;
  75 import android.os.Handler;
  76 import android.os.HandlerThread;
  77 import android.os.IBinder;
  78 import android.os.Looper;
  79 import android.os.Message;
  80 import android.os.Process;
  81 import android.webkit.MimeTypeMap;
  82 import android.widget.RemoteViews;
  83
  84
  85 import eu.alefzero.webdav.WebdavClient;
  86
  87 public class FileUploader extends Service implements OnDatatransferProgressListener {
  88
  89     private static final String UPLOAD_FINISH_MESSAGE = "UPLOAD_FINISH";
  90     public static final String EXTRA_UPLOAD_RESULT = "RESULT";
  91     public static final String EXTRA_REMOTE_PATH = "REMOTE_PATH";
  92     public static final String EXTRA_OLD_REMOTE_PATH = "OLD_REMOTE_PATH";
  93     public static final String EXTRA_OLD_FILE_PATH = "OLD_FILE_PATH";
  94     public static final String ACCOUNT_NAME = "ACCOUNT_NAME";
  95
  96     public static final String KEY_FILE = "FILE";
  97     public static final String KEY_LOCAL_FILE = "LOCAL_FILE";
  98     public static final String KEY_REMOTE_FILE = "REMOTE_FILE";
  99     public static final String KEY_MIME_TYPE = "MIME_TYPE";
 100
 101     public static final String KEY_ACCOUNT = "ACCOUNT";
 102
 103     public static final String KEY_UPLOAD_TYPE = "UPLOAD_TYPE";
 104     public static final String KEY_FORCE_OVERWRITE = "KEY_FORCE_OVERWRITE";
 105     public static final String KEY_INSTANT_UPLOAD = "INSTANT_UPLOAD";
 106     public static final String KEY_LOCAL_BEHAVIOUR = "BEHAVIOUR";
 107
 108     public static final int LOCAL_BEHAVIOUR_COPY = 0;
 109     public static final int LOCAL_BEHAVIOUR_MOVE = 1;
 110     public static final int LOCAL_BEHAVIOUR_FORGET = 2;
 111
 112     public static final int UPLOAD_SINGLE_FILE = 0;
 113     public static final int UPLOAD_MULTIPLE_FILES = 1;
 114
 115     private static final String TAG = FileUploader.class.getSimpleName();
 116
 117     private Looper mServiceLooper;
 118     private ServiceHandler mServiceHandler;
 119     private IBinder mBinder;
 120     private WebdavClient mUploadClient = null;
 121     private Account mLastAccount = null;
 122     private FileDataStorageManager mStorageManager;
 123
 124     private ConcurrentMap<String, UploadFileOperation> mPendingUploads = new ConcurrentHashMap<String, UploadFileOperation>();
 125     private UploadFileOperation mCurrentUpload = null;
 126
 127     private NotificationManager mNotificationManager;
 128     private Notification mNotification;
 129     private int mLastPercent;
 130     private RemoteViews mDefaultNotificationContentView;
 131
 132
 133     public static String getUploadFinishMessage() {
 134         return FileUploader.class.getName().toString() + UPLOAD_FINISH_MESSAGE;
 135     }
 136
 137     /**
 138      * Builds a key for mPendingUploads from the account and file to upload
 139      *
 140      * @param account   Account where the file to upload is stored
 141      * @param file      File to upload
 142      */
 143     private String buildRemoteName(Account account, OCFile file) {
 144         return account.name + file.getRemotePath();
 145     }
 146
 147     private String buildRemoteName(Account account, String remotePath) {
 148         return account.name + remotePath;
 149     }
 150
 151     /**
 152      * Checks if an ownCloud server version should support chunked uploads.
 153      *
 154      * @param version OwnCloud version instance corresponding to an ownCloud
 155      *            server.
 156      * @return 'True' if the ownCloud server with version supports chunked
 157      *         uploads.
 158      */
 159     private static boolean chunkedUploadIsSupported(OwnCloudVersion version) {
 160         return (version != null && version.compareTo(OwnCloudVersion.owncloud_v4_5) >= 0);
 161     }
 162
 163     /**
 164      * Service initialization
 165      */
 166     @Override
 167     public void onCreate() {
 168         super.onCreate();
 169         Log_OC.i(TAG, "mPendingUploads size:" + mPendingUploads.size());
 170         mNotificationManager = (NotificationManager) getSystemService(NOTIFICATION_SERVICE);
 171         HandlerThread thread = new HandlerThread("FileUploaderThread", Process.THREAD_PRIORITY_BACKGROUND);
 172         thread.start();
 173         mServiceLooper = thread.getLooper();
 174         mServiceHandler = new ServiceHandler(mServiceLooper, this);
 175         mBinder = new FileUploaderBinder();
 176     }
 177
 178     /**
 179      * Entry point to add one or several files to the queue of uploads.
 180      *
 181      * New uploads are added calling to startService(), resulting in a call to
 182      * this method. This ensures the service will keep on working although the
 183      * caller activity goes away.
 184      */
 185     @Override
 186     public int onStartCommand(Intent intent, int flags, int startId) {
 187         if (!intent.hasExtra(KEY_ACCOUNT) || !intent.hasExtra(KEY_UPLOAD_TYPE)
 188                 || !(intent.hasExtra(KEY_LOCAL_FILE) || intent.hasExtra(KEY_FILE))) {
 189             Log_OC.e(TAG, "Not enough information provided in intent");
 190             return Service.START_NOT_STICKY;
 191         }
 192         int uploadType = intent.getIntExtra(KEY_UPLOAD_TYPE, -1);
 193         if (uploadType == -1) {
 194             Log_OC.e(TAG, "Incorrect upload type provided");
 195             return Service.START_NOT_STICKY;
 196         }
 197         Account account = intent.getParcelableExtra(KEY_ACCOUNT);
 198
 199         String[] localPaths = null, remotePaths = null, mimeTypes = null;
 200         OCFile[] files = null;
 201         if (uploadType == UPLOAD_SINGLE_FILE) {
 202
 203             if (intent.hasExtra(KEY_FILE)) {
 204                 files = new OCFile[] { intent.getParcelableExtra(KEY_FILE) };
 205
 206             } else {
 207                 localPaths = new String[] { intent.getStringExtra(KEY_LOCAL_FILE) };
 208                 remotePaths = new String[] { intent.getStringExtra(KEY_REMOTE_FILE) };
 209                 mimeTypes = new String[] { intent.getStringExtra(KEY_MIME_TYPE) };
 210             }
 211
 212         } else { // mUploadType == UPLOAD_MULTIPLE_FILES
 213
 214             if (intent.hasExtra(KEY_FILE)) {
 215                 files = (OCFile[]) intent.getParcelableArrayExtra(KEY_FILE); // TODO
 216                                                                              // will
 217                                                                              // this
 218                                                                              // casting
 219                                                                              // work
 220                                                                              // fine?
 221
 222             } else {
 223                 localPaths = intent.getStringArrayExtra(KEY_LOCAL_FILE);
 224                 remotePaths = intent.getStringArrayExtra(KEY_REMOTE_FILE);
 225                 mimeTypes = intent.getStringArrayExtra(KEY_MIME_TYPE);
 226             }
 227         }
 228
 229         FileDataStorageManager storageManager = new FileDataStorageManager(account, getContentResolver());
 230
 231         boolean forceOverwrite = intent.getBooleanExtra(KEY_FORCE_OVERWRITE, false);
 232         boolean isInstant = intent.getBooleanExtra(KEY_INSTANT_UPLOAD, false);
 233         int localAction = intent.getIntExtra(KEY_LOCAL_BEHAVIOUR, LOCAL_BEHAVIOUR_COPY);
 234
 235         if (intent.hasExtra(KEY_FILE) && files == null) {
 236             Log_OC.e(TAG, "Incorrect array for OCFiles provided in upload intent");
 237             return Service.START_NOT_STICKY;
 238
 239         } else if (!intent.hasExtra(KEY_FILE)) {
 240             if (localPaths == null) {
 241                 Log_OC.e(TAG, "Incorrect array for local paths provided in upload intent");
 242                 return Service.START_NOT_STICKY;
 243             }
 244             if (remotePaths == null) {
 245                 Log_OC.e(TAG, "Incorrect array for remote paths provided in upload intent");
 246                 return Service.START_NOT_STICKY;
 247             }
 248             if (localPaths.length != remotePaths.length) {
 249                 Log_OC.e(TAG, "Different number of remote paths and local paths!");
 250                 return Service.START_NOT_STICKY;
 251             }
 252
 253             files = new OCFile[localPaths.length];
 254             for (int i = 0; i < localPaths.length; i++) {
 255                 files[i] = obtainNewOCFileToUpload(remotePaths[i], localPaths[i], ((mimeTypes != null) ? mimeTypes[i]
 256                         : (String) null), storageManager);
 257                 if (files[i] == null) {
 258                     // TODO @andomaex add failure Notiification
 259                     return Service.START_NOT_STICKY;
 260                 }
 261             }
 262         }
 263
 264         OwnCloudVersion ocv = new OwnCloudVersion(AccountManager.get(this).getUserData(account,
 265                 AccountAuthenticator.KEY_OC_VERSION));
 266         boolean chunked = FileUploader.chunkedUploadIsSupported(ocv);
 267         AbstractList<String> requestedUploads = new Vector<String>();
 268         String uploadKey = null;
 269         UploadFileOperation newUpload = null;
 270         try {
 271             for (int i = 0; i < files.length; i++) {
 272                 uploadKey = buildRemoteName(account, files[i].getRemotePath());
 273                 if (chunked) {
 274                     newUpload = new ChunkedUploadFileOperation(account, files[i], isInstant, forceOverwrite,
 275                             localAction);
 276                 } else {
 277                     newUpload = new UploadFileOperation(account, files[i], isInstant, forceOverwrite, localAction);
 278                 }
 279                 if (isInstant) {
 280                     newUpload.setRemoteFolderToBeCreated();
 281                 }
 282                 mPendingUploads.putIfAbsent(uploadKey, newUpload); // Grants that the file only upload once time
 283
 284                 newUpload.addDatatransferProgressListener(this);
 285                 newUpload.addDatatransferProgressListener((FileUploaderBinder)mBinder);
 286                 requestedUploads.add(uploadKey);
 287             }
 288
 289         } catch (IllegalArgumentException e) {
 290             Log_OC.e(TAG, "Not enough information provided in intent: " + e.getMessage());
 291             return START_NOT_STICKY;
 292
 293         } catch (IllegalStateException e) {
 294             Log_OC.e(TAG, "Bad information provided in intent: " + e.getMessage());
 295             return START_NOT_STICKY;
 296
 297         } catch (Exception e) {
 298             Log_OC.e(TAG, "Unexpected exception while processing upload intent", e);
 299             return START_NOT_STICKY;
 300
 301         }
 302
 303         if (requestedUploads.size() > 0) {
 304             Message msg = mServiceHandler.obtainMessage();
 305             msg.arg1 = startId;
 306             msg.obj = requestedUploads;
 307             mServiceHandler.sendMessage(msg);
 308         }
 309         Log_OC.i(TAG, "mPendingUploads size:" + mPendingUploads.size());
 310         return Service.START_NOT_STICKY;
 311     }
 312
 313     /**
 314      * Provides a binder object that clients can use to perform operations on
 315      * the queue of uploads, excepting the addition of new files.
 316      *
 317      * Implemented to perform cancellation, pause and resume of existing
 318      * uploads.
 319      */
 320     @Override
 321     public IBinder onBind(Intent arg0) {
 322         return mBinder;
 323     }
 324
 325     /**
 326      * Called when ALL the bound clients were onbound.
 327      */
 328     @Override
 329     public boolean onUnbind(Intent intent) {
 330         ((FileUploaderBinder)mBinder).clearListeners();
 331         return false;   // not accepting rebinding (default behaviour)
 332     }
 333
 334
 335     /**
 336      * Binder to let client components to perform operations on the queue of
 337      * uploads.
 338      *
 339      * It provides by itself the available operations.
 340      */
 341     public class FileUploaderBinder extends Binder implements OnDatatransferProgressListener {
 342
 343         /**
 344          * Map of listeners that will be reported about progress of uploads from a {@link FileUploaderBinder} instance
 345          */
 346         private Map<String, OnDatatransferProgressListener> mBoundListeners = new HashMap<String, OnDatatransferProgressListener>();
 347
 348         /**
 349          * Cancels a pending or current upload of a remote file.
 350          *
 351          * @param account Owncloud account where the remote file will be stored.
 352          * @param file A file in the queue of pending uploads
 353          */
 354         public void cancel(Account account, OCFile file) {
 355             UploadFileOperation upload = null;
 356             synchronized (mPendingUploads) {
 357                 upload = mPendingUploads.remove(buildRemoteName(account, file));
 358             }
 359             if (upload != null) {
 360                 upload.cancel();
 361             }
 362         }
 363
 364
 365
 366         public void clearListeners() {
 367             mBoundListeners.clear();
 368         }
 369
 370
 371
 372
 373         /**
 374          * Returns True when the file described by 'file' is being uploaded to
 375          * the ownCloud account 'account' or waiting for it
 376          *
 377          * If 'file' is a directory, returns 'true' if some of its descendant files is uploading or waiting to upload.
 378          *
 379          * @param account Owncloud account where the remote file will be stored.
 380          * @param file A file that could be in the queue of pending uploads
 381          */
 382         public boolean isUploading(Account account, OCFile file) {
 383             if (account == null || file == null)
 384                 return false;
 385             String targetKey = buildRemoteName(account, file);
 386             synchronized (mPendingUploads) {
 387                 if (file.isFolder()) {
 388                     // this can be slow if there are many uploads :(
 389                     Iterator<String> it = mPendingUploads.keySet().iterator();
 390                     boolean found = false;
 391                     while (it.hasNext() && !found) {
 392                         found = it.next().startsWith(targetKey);
 393                     }
 394                     return found;
 395                 } else {
 396                     return (mPendingUploads.containsKey(targetKey));
 397                 }
 398             }
 399         }
 400
 401
 402         /**
 403          * Adds a listener interested in the progress of the upload for a concrete file.
 404          *
 405          * @param listener      Object to notify about progress of transfer.
 406          * @param account       ownCloud account holding the file of interest.
 407          * @param file          {@link OCfile} of interest for listener.
 408          */
 409         public void addDatatransferProgressListener (OnDatatransferProgressListener listener, Account account, OCFile file) {
 410             if (account == null || file == null || listener == null) return;
 411             String targetKey = buildRemoteName(account, file);
 412             mBoundListeners.put(targetKey, listener);
 413         }
 414
 415
 416
 417         /**
 418          * Removes a listener interested in the progress of the upload for a concrete file.
 419          *
 420          * @param listener      Object to notify about progress of transfer.
 421          * @param account       ownCloud account holding the file of interest.
 422          * @param file          {@link OCfile} of interest for listener.
 423          */
 424         public void removeDatatransferProgressListener (OnDatatransferProgressListener listener, Account account, OCFile file) {
 425             if (account == null || file == null || listener == null) return;
 426             String targetKey = buildRemoteName(account, file);
 427             if (mBoundListeners.get(targetKey) == listener) {
 428                 mBoundListeners.remove(targetKey);
 429             }
 430         }
 431
 432
 433         @Override
 434         public void onTransferProgress(long progressRate) {
 435             // old way, should not be in use any more
 436         }
 437
 438
 439         @Override
 440         public void onTransferProgress(long progressRate, long totalTransferredSoFar, long totalToTransfer,
 441                 String fileName) {
 442             String key = buildRemoteName(mCurrentUpload.getAccount(), mCurrentUpload.getFile());
 443             OnDatatransferProgressListener boundListener = mBoundListeners.get(key);
 444             if (boundListener != null) {
 445                 boundListener.onTransferProgress(progressRate, totalTransferredSoFar, totalToTransfer, fileName);
 446             }
 447         }
 448
 449     }
 450
 451     /**
 452      * Upload worker. Performs the pending uploads in the order they were
 453      * requested.
 454      *
 455      * Created with the Looper of a new thread, started in
 456      * {@link FileUploader#onCreate()}.
 457      */
 458     private static class ServiceHandler extends Handler {
 459         // don't make it a final class, and don't remove the static ; lint will
 460         // warn about a possible memory leak
 461         FileUploader mService;
 462
 463         public ServiceHandler(Looper looper, FileUploader service) {
 464             super(looper);
 465             if (service == null)
 466                 throw new IllegalArgumentException("Received invalid NULL in parameter 'service'");
 467             mService = service;
 468         }
 469
 470         @Override
 471         public void handleMessage(Message msg) {
 472             @SuppressWarnings("unchecked")
 473             AbstractList<String> requestedUploads = (AbstractList<String>) msg.obj;
 474             if (msg.obj != null) {
 475                 Iterator<String> it = requestedUploads.iterator();
 476                 while (it.hasNext()) {
 477                     mService.uploadFile(it.next());
 478                 }
 479             }
 480             mService.stopSelf(msg.arg1);
 481         }
 482     }
 483
 484     /**
 485      * Core upload method: sends the file(s) to upload
 486      *
 487      * @param uploadKey Key to access the upload to perform, contained in
 488      *            mPendingUploads
 489      */
 490     public void uploadFile(String uploadKey) {
 491
 492         synchronized (mPendingUploads) {
 493             mCurrentUpload = mPendingUploads.get(uploadKey);
 494         }
 495
 496         if (mCurrentUpload != null) {
 497
 498             notifyUploadStart(mCurrentUpload);
 499
 500             RemoteOperationResult uploadResult = null, grantResult = null;
 501
 502             try {
 503                 /// prepare client object to send requests to the ownCloud server
 504                 if (mUploadClient == null || !mLastAccount.equals(mCurrentUpload.getAccount())) {
 505                     mLastAccount = mCurrentUpload.getAccount();
 506                     mStorageManager = new FileDataStorageManager(mLastAccount, getContentResolver());
 507                     mUploadClient = OwnCloudClientUtils.createOwnCloudClient(mLastAccount, getApplicationContext());
 508                 }
 509
 510                 /// check the existence of the parent folder for the file to upload
 511                 String remoteParentPath = new File(mCurrentUpload.getRemotePath()).getParent();
 512                 remoteParentPath = remoteParentPath.endsWith(OCFile.PATH_SEPARATOR) ? remoteParentPath : remoteParentPath + OCFile.PATH_SEPARATOR;
 513                 grantResult = grantFolderExistence(remoteParentPath);
 514
 515                 /// perform the upload
 516                 if (grantResult.isSuccess()) {
 517                     OCFile parent = mStorageManager.getFileByPath(remoteParentPath);
 518                     mCurrentUpload.getFile().setParentId(parent.getFileId());
 519                     uploadResult = mCurrentUpload.execute(mUploadClient);
 520                     if (uploadResult.isSuccess()) {
 521                         saveUploadedFile();
 522                     }
 523                 } else {
 524                     uploadResult = grantResult;
 525                 }
 526
 527             } catch (AccountsException e) {
 528                 Log_OC.e(TAG, "Error while trying to get autorization for " + mLastAccount.name, e);
 529                 uploadResult = new RemoteOperationResult(e);
 530
 531             } catch (IOException e) {
 532                 Log_OC.e(TAG, "Error while trying to get autorization for " + mLastAccount.name, e);
 533                 uploadResult = new RemoteOperationResult(e);
 534
 535             } finally {
 536                 synchronized (mPendingUploads) {
 537                     mPendingUploads.remove(uploadKey);
 538                     Log_OC.i(TAG, "Remove CurrentUploadItem from pending upload Item Map.");
 539                 }
 540                 if (uploadResult.isException()) {
 541                     // enforce the creation of a new client object for next uploads; this grant that a new socket will
 542                     // be created in the future if the current exception is due to an abrupt lose of network connection
 543                     mUploadClient = null;
 544                 }
 545             }
 546
 547             /// notify result
 548
 549             notifyUploadResult(uploadResult, mCurrentUpload);
 550             sendFinalBroadcast(mCurrentUpload, uploadResult);
 551
 552         }
 553
 554     }
 555
 556     /**
 557      * Checks the existence of the folder where the current file will be uploaded both in the remote server
 558      * and in the local database.
 559      *
 560      * If the upload is set to enforce the creation of the folder, the method tries to create it both remote
 561      * and locally.
 562      *
 563      *  @param  pathToGrant     Full remote path whose existence will be granted.
 564      *  @return  An {@link OCFile} instance corresponding to the folder where the file will be uploaded.
 565      */
 566     private RemoteOperationResult grantFolderExistence(String pathToGrant) {
 567         RemoteOperation operation = new ExistenceCheckOperation(pathToGrant, this, false);
 568         RemoteOperationResult result = operation.execute(mUploadClient);
 569         if (!result.isSuccess() && result.getCode() == ResultCode.FILE_NOT_FOUND && mCurrentUpload.isRemoteFolderToBeCreated()) {
 570             operation = new CreateFolderOperation(  pathToGrant,
 571                                                     true,
 572                                                     mStorageManager    );
 573             result = operation.execute(mUploadClient);
 574         }
 575         if (result.isSuccess()) {
 576             OCFile parentDir = mStorageManager.getFileByPath(pathToGrant);
 577             if (parentDir == null) {
 578                 parentDir = createLocalFolder(pathToGrant);
 579             }
 580             if (parentDir != null) {
 581                 result = new RemoteOperationResult(ResultCode.OK);
 582             } else {
 583                 result = new RemoteOperationResult(ResultCode.UNKNOWN_ERROR);
 584             }
 585         }
 586         return result;
 587     }
 588
 589
 590     private OCFile createLocalFolder(String remotePath) {
 591         String parentPath = new File(remotePath).getParent();
 592         parentPath = parentPath.endsWith(OCFile.PATH_SEPARATOR) ? parentPath : parentPath + OCFile.PATH_SEPARATOR;
 593         OCFile parent = mStorageManager.getFileByPath(parentPath);
 594         if (parent == null) {
 595             parent = createLocalFolder(parentPath);
 596         }
 597         if (parent != null) {
 598             OCFile createdFolder = new OCFile(remotePath);
 599             createdFolder.setMimetype("DIR");
 600             createdFolder.setParentId(parent.getFileId());
 601             mStorageManager.saveFile(createdFolder);
 602             return createdFolder;
 603         }
 604         return null;
 605     }
 606
 607
 608     /**
 609      * Saves a OC File after a successful upload.
 610      *
 611      * A PROPFIND is necessary to keep the props in the local database
 612      * synchronized with the server, specially the modification time and Etag
 613      * (where available)
 614      *
 615      * TODO refactor this ugly thing
 616      */
 617     private void saveUploadedFile() {
 618         OCFile file = mCurrentUpload.getFile();
 619         long syncDate = System.currentTimeMillis();
 620         file.setLastSyncDateForData(syncDate);
 621
 622         // / new PROPFIND to keep data consistent with server in theory, should
 623         // return the same we already have
 624         PropFindMethod propfind = null;
 625         RemoteOperationResult result = null;
 626         try {
 627             propfind = new PropFindMethod(mUploadClient.getBaseUri() + WebdavUtils.encodePath(mCurrentUpload.getRemotePath()),
 628                     DavConstants.PROPFIND_ALL_PROP,
 629                     DavConstants.DEPTH_0);
 630             int status = mUploadClient.executeMethod(propfind);
 631             boolean isMultiStatus = (status == HttpStatus.SC_MULTI_STATUS);
 632             if (isMultiStatus) {
 633                 MultiStatus resp = propfind.getResponseBodyAsMultiStatus();
 634                 WebdavEntry we = new WebdavEntry(resp.getResponses()[0], mUploadClient.getBaseUri().getPath());
 635                 updateOCFile(file, we);
 636                 file.setLastSyncDateForProperties(syncDate);
 637
 638             } else {
 639                 mUploadClient.exhaustResponse(propfind.getResponseBodyAsStream());
 640             }
 641
 642             result = new RemoteOperationResult(isMultiStatus, status, propfind.getResponseHeaders());
 643             Log_OC.i(TAG, "Update: synchronizing properties for uploaded " + mCurrentUpload.getRemotePath() + ": "
 644                     + result.getLogMessage());
 645
 646         } catch (Exception e) {
 647             result = new RemoteOperationResult(e);
 648             Log_OC.e(TAG, "Update: synchronizing properties for uploaded " + mCurrentUpload.getRemotePath() + ": "
 649                     + result.getLogMessage(), e);
 650
 651         } finally {
 652             if (propfind != null)
 653                 propfind.releaseConnection();
 654         }
 655
 656         // / maybe this would be better as part of UploadFileOperation... or
 657         // maybe all this method
 658         if (mCurrentUpload.wasRenamed()) {
 659             OCFile oldFile = mCurrentUpload.getOldFile();
 660             if (oldFile.fileExists()) {
 661                 oldFile.setStoragePath(null);
 662                 mStorageManager.saveFile(oldFile);
 663
 664             } // else: it was just an automatic renaming due to a name
 665               // coincidence; nothing else is needed, the storagePath is right
 666               // in the instance returned by mCurrentUpload.getFile()
 667         }
 668
 669         mStorageManager.saveFile(file);
 670     }
 671
 672     private void updateOCFile(OCFile file, WebdavEntry we) {
 673         file.setCreationTimestamp(we.createTimestamp());
 674         file.setFileLength(we.contentLength());
 675         file.setMimetype(we.contentType());
 676         file.setModificationTimestamp(we.modifiedTimestamp());
 677         file.setModificationTimestampAtLastSyncForData(we.modifiedTimestamp());
 678         // file.setEtag(mCurrentUpload.getEtag());    // TODO Etag, where available
 679     }
 680
 681     private OCFile obtainNewOCFileToUpload(String remotePath, String localPath, String mimeType,
 682             FileDataStorageManager storageManager) {
 683         OCFile newFile = new OCFile(remotePath);
 684         newFile.setStoragePath(localPath);
 685         newFile.setLastSyncDateForProperties(0);
 686         newFile.setLastSyncDateForData(0);
 687
 688         // size
 689         if (localPath != null && localPath.length() > 0) {
 690             File localFile = new File(localPath);
 691             newFile.setFileLength(localFile.length());
 692             newFile.setLastSyncDateForData(localFile.lastModified());
 693         } // don't worry about not assigning size, the problems with localPath
 694           // are checked when the UploadFileOperation instance is created
 695
 696         // MIME type
 697         if (mimeType == null || mimeType.length() <= 0) {
 698             try {
 699                 mimeType = MimeTypeMap.getSingleton().getMimeTypeFromExtension(
 700                         remotePath.substring(remotePath.lastIndexOf('.') + 1));
 701             } catch (IndexOutOfBoundsException e) {
 702                 Log_OC.e(TAG, "Trying to find out MIME type of a file without extension: " + remotePath);
 703             }
 704         }
 705         if (mimeType == null) {
 706             mimeType = "application/octet-stream";
 707         }
 708         newFile.setMimetype(mimeType);
 709
 710         return newFile;
 711     }
 712
 713     /**
 714      * Creates a status notification to show the upload progress
 715      *
 716      * @param upload Upload operation starting.
 717      */
 718     @SuppressWarnings("deprecation")
 719     private void notifyUploadStart(UploadFileOperation upload) {
 720         // / create status notification with a progress bar
 721         mLastPercent = 0;
 722         mNotification = new Notification(R.drawable.icon, getString(R.string.uploader_upload_in_progress_ticker),
 723                 System.currentTimeMillis());
 724         mNotification.flags |= Notification.FLAG_ONGOING_EVENT;
 725         mDefaultNotificationContentView = mNotification.contentView;
 726         mNotification.contentView = new RemoteViews(getApplicationContext().getPackageName(),
 727                 R.layout.progressbar_layout);
 728         mNotification.contentView.setProgressBar(R.id.status_progress, 100, 0, false);
 729         mNotification.contentView.setTextViewText(R.id.status_text,
 730                 String.format(getString(R.string.uploader_upload_in_progress_content), 0, upload.getFileName()));
 731         mNotification.contentView.setImageViewResource(R.id.status_icon, R.drawable.icon);
 732
 733         /// includes a pending intent in the notification showing the details view of the file
 734         Intent showDetailsIntent = new Intent(this, FileDisplayActivity.class);
 735         showDetailsIntent.putExtra(FileActivity.EXTRA_FILE, upload.getFile());
 736         showDetailsIntent.putExtra(FileActivity.EXTRA_ACCOUNT, upload.getAccount());
 737         showDetailsIntent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
 738         mNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(),
 739                 (int) System.currentTimeMillis(), showDetailsIntent, 0);
 740
 741         mNotificationManager.notify(R.string.uploader_upload_in_progress_ticker, mNotification);
 742     }
 743
 744     /**
 745      * Callback method to update the progress bar in the status notification
 746      */
 747     @Override
 748     public void onTransferProgress(long progressRate, long totalTransferredSoFar, long totalToTransfer, String fileName) {
 749         int percent = (int) (100.0 * ((double) totalTransferredSoFar) / ((double) totalToTransfer));
 750         if (percent != mLastPercent) {
 751             mNotification.contentView.setProgressBar(R.id.status_progress, 100, percent, false);
 752             String text = String.format(getString(R.string.uploader_upload_in_progress_content), percent, fileName);
 753             mNotification.contentView.setTextViewText(R.id.status_text, text);
 754             mNotificationManager.notify(R.string.uploader_upload_in_progress_ticker, mNotification);
 755         }
 756         mLastPercent = percent;
 757     }
 758
 759     /**
 760      * Callback method to update the progress bar in the status notification
 761      * (old version)
 762      */
 763     @Override
 764     public void onTransferProgress(long progressRate) {
 765         // NOTHING TO DO HERE ANYMORE
 766     }
 767
 768     /**
 769      * Updates the status notification with the result of an upload operation.
 770      *
 771      * @param uploadResult Result of the upload operation.
 772      * @param upload Finished upload operation
 773      */
 774     private void notifyUploadResult(RemoteOperationResult uploadResult, UploadFileOperation upload) {
 775         Log_OC.d(TAG, "NotifyUploadResult with resultCode: " + uploadResult.getCode());
 776         if (uploadResult.isCancelled()) {
 777             // / cancelled operation -> silent removal of progress notification
 778             mNotificationManager.cancel(R.string.uploader_upload_in_progress_ticker);
 779
 780         } else if (uploadResult.isSuccess()) {
 781             // / success -> silent update of progress notification to success
 782             // message
 783             mNotification.flags ^= Notification.FLAG_ONGOING_EVENT; // remove
 784                                                                     // the
 785                                                                     // ongoing
 786                                                                     // flag
 787             mNotification.flags |= Notification.FLAG_AUTO_CANCEL;
 788             mNotification.contentView = mDefaultNotificationContentView;
 789
 790             /// includes a pending intent in the notification showing the details view of the file
 791             Intent showDetailsIntent = null;
 792             if (PreviewImageFragment.canBePreviewed(upload.getFile())) {
 793                 showDetailsIntent = new Intent(this, PreviewImageActivity.class);
 794             } else {
 795                 showDetailsIntent = new Intent(this, FileDisplayActivity.class);
 796             }
 797             showDetailsIntent.putExtra(FileActivity.EXTRA_FILE, upload.getFile());
 798             showDetailsIntent.putExtra(FileActivity.EXTRA_ACCOUNT, upload.getAccount());
 799             showDetailsIntent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
 800             mNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(),
 801                     (int) System.currentTimeMillis(), showDetailsIntent, 0);
 802
 803             mNotification.setLatestEventInfo(getApplicationContext(),
 804                     getString(R.string.uploader_upload_succeeded_ticker),
 805                     String.format(getString(R.string.uploader_upload_succeeded_content_single), upload.getFileName()),
 806                     mNotification.contentIntent);
 807
 808             mNotificationManager.notify(R.string.uploader_upload_in_progress_ticker, mNotification); // NOT
 809                                                                                                      // AN
 810             DbHandler db = new DbHandler(this.getBaseContext());
 811             db.removeIUPendingFile(mCurrentUpload.getOriginalStoragePath());
 812             db.close();
 813
 814         } else {
 815
 816             // / fail -> explicit failure notification
 817             mNotificationManager.cancel(R.string.uploader_upload_in_progress_ticker);
 818             Notification finalNotification = new Notification(R.drawable.icon,
 819                     getString(R.string.uploader_upload_failed_ticker), System.currentTimeMillis());
 820             finalNotification.flags |= Notification.FLAG_AUTO_CANCEL;
 821             String content = null;
 822
 823             boolean needsToUpdateCredentials = (uploadResult.getCode() == ResultCode.UNAUTHORIZED ||
 824                     //(uploadResult.isTemporalRedirection() && uploadResult.isIdPRedirection() &&
 825                     (uploadResult.isIdPRedirection() &&
 826                             MainApp.getAuthTokenTypeSamlSessionCookie().equals(mUploadClient.getAuthTokenType())));
 827             if (needsToUpdateCredentials) {
 828                 // let the user update credentials with one click
 829                 Intent updateAccountCredentials = new Intent(this, AuthenticatorActivity.class);
 830                 updateAccountCredentials.putExtra(AuthenticatorActivity.EXTRA_ACCOUNT, upload.getAccount());
 831                 updateAccountCredentials.putExtra(AuthenticatorActivity.EXTRA_ENFORCED_UPDATE, true);
 832                 updateAccountCredentials.putExtra(AuthenticatorActivity.EXTRA_ACTION, AuthenticatorActivity.ACTION_UPDATE_TOKEN);
 833                 updateAccountCredentials.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
 834                 updateAccountCredentials.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
 835                 updateAccountCredentials.addFlags(Intent.FLAG_FROM_BACKGROUND);
 836                 finalNotification.contentIntent = PendingIntent.getActivity(this, (int)System.currentTimeMillis(), updateAccountCredentials, PendingIntent.FLAG_ONE_SHOT);
 837                 content =  String.format(getString(R.string.uploader_upload_failed_content_single), upload.getFileName());
 838                 finalNotification.setLatestEventInfo(getApplicationContext(),
 839                         getString(R.string.uploader_upload_failed_ticker), content, finalNotification.contentIntent);
 840                 mUploadClient = null;   // grant that future retries on the same account will get the fresh credentials
 841             } else {
 842                 // TODO put something smart in the contentIntent below
 843             //    finalNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(), (int)System.currentTimeMillis(), new Intent(), 0);
 844             //}
 845
 846                 if (uploadResult.getCode() == ResultCode.LOCAL_STORAGE_FULL
 847                         || uploadResult.getCode() == ResultCode.LOCAL_STORAGE_NOT_COPIED) {
 848                     // TODO we need a class to provide error messages for the users
 849                     // from a RemoteOperationResult and a RemoteOperation
 850                     content = String.format(getString(R.string.error__upload__local_file_not_copied), upload.getFileName(),
 851                             getString(R.string.app_name));
 852                 } else if (uploadResult.getCode() == ResultCode.QUOTA_EXCEEDED) {
 853                     content = getString(R.string.failed_upload_quota_exceeded_text);
 854                 } else {
 855                     content = String
 856                             .format(getString(R.string.uploader_upload_failed_content_single), upload.getFileName());
 857                 }
 858
 859                 // we add only for instant-uploads the InstantUploadActivity and the
 860                 // db entry
 861                 Intent detailUploadIntent = null;
 862                 if (upload.isInstant() && InstantUploadActivity.IS_ENABLED) {
 863                     detailUploadIntent = new Intent(this, InstantUploadActivity.class);
 864                     detailUploadIntent.putExtra(FileUploader.KEY_ACCOUNT, upload.getAccount());
 865                 } else {
 866                     detailUploadIntent = new Intent(this, FailedUploadActivity.class);
 867                     detailUploadIntent.putExtra(FailedUploadActivity.MESSAGE, content);
 868                 }
 869                 finalNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(),
 870                         (int) System.currentTimeMillis(), detailUploadIntent, PendingIntent.FLAG_UPDATE_CURRENT
 871                         | PendingIntent.FLAG_ONE_SHOT);
 872
 873                 if (upload.isInstant()) {
 874                     DbHandler db = null;
 875                     try {
 876                         db = new DbHandler(this.getBaseContext());
 877                         String message = uploadResult.getLogMessage() + " errorCode: " + uploadResult.getCode();
 878                         Log_OC.e(TAG, message + " Http-Code: " + uploadResult.getHttpCode());
 879                         if (uploadResult.getCode() == ResultCode.QUOTA_EXCEEDED) {
 880                             message = getString(R.string.failed_upload_quota_exceeded_text);
 881                             if (db.updateFileState(upload.getOriginalStoragePath(), DbHandler.UPLOAD_STATUS_UPLOAD_FAILED,
 882                                     message) == 0) {
 883                                 db.putFileForLater(upload.getOriginalStoragePath(), upload.getAccount().name, message);
 884                             }
 885                         }
 886                     } finally {
 887                         if (db != null) {
 888                             db.close();
 889                         }
 890                     }
 891                 }
 892             }
 893             finalNotification.setLatestEventInfo(getApplicationContext(),
 894                     getString(R.string.uploader_upload_failed_ticker), content, finalNotification.contentIntent);
 895
 896             mNotificationManager.notify(R.string.uploader_upload_failed_ticker, finalNotification);
 897         }
 898
 899     }
 900
 901     /**
 902      * Sends a broadcast in order to the interested activities can update their
 903      * view
 904      *
 905      * @param upload Finished upload operation
 906      * @param uploadResult Result of the upload operation
 907      */
 908     private void sendFinalBroadcast(UploadFileOperation upload, RemoteOperationResult uploadResult) {
 909         Intent end = new Intent(getUploadFinishMessage());
 910         end.putExtra(EXTRA_REMOTE_PATH, upload.getRemotePath()); // real remote
 911                                                                  // path, after
 912                                                                  // possible
 913                                                                  // automatic
 914                                                                  // renaming
 915         if (upload.wasRenamed()) {
 916             end.putExtra(EXTRA_OLD_REMOTE_PATH, upload.getOldFile().getRemotePath());
 917         }
 918         end.putExtra(EXTRA_OLD_FILE_PATH, upload.getOriginalStoragePath());
 919         end.putExtra(ACCOUNT_NAME, upload.getAccount().name);
 920         end.putExtra(EXTRA_UPLOAD_RESULT, uploadResult.isSuccess());
 921         sendStickyBroadcast(end);
 922     }
 923
 924 }