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