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.lib.common.operations.RemoteOperationResult.ResultCode;
  42 import com.owncloud.android.lib.resources.files.ExistenceCheckRemoteOperation;
  43 import com.owncloud.android.lib.resources.files.ReadRemoteFileOperation;
  44 import com.owncloud.android.lib.resources.files.FileUtils;
  45 import com.owncloud.android.lib.resources.status.OwnCloudVersion;
  46 import com.owncloud.android.lib.common.accounts.AccountUtils.Constants;
  47 import com.owncloud.android.lib.common.network.OnDatatransferProgressListener;
  48 import com.owncloud.android.lib.common.OwnCloudClientFactory;
  49 import com.owncloud.android.lib.common.OwnCloudClient;
  50 import com.owncloud.android.ui.activity.FailedUploadActivity;
  51 import com.owncloud.android.ui.activity.FileActivity;
  52 import com.owncloud.android.ui.activity.FileDisplayActivity;
  53 import com.owncloud.android.ui.activity.InstantUploadActivity;
  54 import com.owncloud.android.ui.preview.PreviewImageActivity;
  55 import com.owncloud.android.ui.preview.PreviewImageFragment;
  56 import com.owncloud.android.utils.Log_OC;
  57 import com.owncloud.android.utils.NotificationBuilderWithProgressBar;
  58
  59 import android.accounts.Account;
  60 import android.accounts.AccountManager;
  61 import android.accounts.AccountsException;
  62 import android.app.NotificationManager;
  63 import android.app.PendingIntent;
  64 import android.app.Service;
  65 import android.content.Intent;
  66 import android.os.Binder;
  67 import android.os.Handler;
  68 import android.os.HandlerThread;
  69 import android.os.IBinder;
  70 import android.os.Looper;
  71 import android.os.Message;
  72 import android.os.Process;
  73 import android.support.v4.app.NotificationCompat;
  74 import android.webkit.MimeTypeMap;
  75
  76
  77
  78 public class FileUploader extends Service implements OnDatatransferProgressListener {
  79
  80     private static final String UPLOAD_FINISH_MESSAGE = "UPLOAD_FINISH";
  81     public static final String EXTRA_UPLOAD_RESULT = "RESULT";
  82     public static final String EXTRA_REMOTE_PATH = "REMOTE_PATH";
  83     public static final String EXTRA_OLD_REMOTE_PATH = "OLD_REMOTE_PATH";
  84     public static final String EXTRA_OLD_FILE_PATH = "OLD_FILE_PATH";
  85     public static final String ACCOUNT_NAME = "ACCOUNT_NAME";
  86
  87     public static final String KEY_FILE = "FILE";
  88     public static final String KEY_LOCAL_FILE = "LOCAL_FILE";
  89     public static final String KEY_REMOTE_FILE = "REMOTE_FILE";
  90     public static final String KEY_MIME_TYPE = "MIME_TYPE";
  91
  92     public static final String KEY_ACCOUNT = "ACCOUNT";
  93
  94     public static final String KEY_UPLOAD_TYPE = "UPLOAD_TYPE";
  95     public static final String KEY_FORCE_OVERWRITE = "KEY_FORCE_OVERWRITE";
  96     public static final String KEY_INSTANT_UPLOAD = "INSTANT_UPLOAD";
  97     public static final String KEY_LOCAL_BEHAVIOUR = "BEHAVIOUR";
  98
  99     public static final int LOCAL_BEHAVIOUR_COPY = 0;
 100     public static final int LOCAL_BEHAVIOUR_MOVE = 1;
 101     public static final int LOCAL_BEHAVIOUR_FORGET = 2;
 102
 103     public static final int UPLOAD_SINGLE_FILE = 0;
 104     public static final int UPLOAD_MULTIPLE_FILES = 1;
 105
 106     private static final String TAG = FileUploader.class.getSimpleName();
 107
 108     private Looper mServiceLooper;
 109     private ServiceHandler mServiceHandler;
 110     private IBinder mBinder;
 111     private OwnCloudClient mUploadClient = null;
 112     private Account mLastAccount = null;
 113     private FileDataStorageManager mStorageManager;
 114
 115     private ConcurrentMap<String, UploadFileOperation> mPendingUploads = new ConcurrentHashMap<String, UploadFileOperation>();
 116     private UploadFileOperation mCurrentUpload = null;
 117
 118     private NotificationManager mNotificationManager;
 119     private NotificationCompat.Builder mNotificationBuilder;
 120     private int mLastPercent;
 121
 122
 123     public static String getUploadFinishMessage() {
 124         return FileUploader.class.getName().toString() + UPLOAD_FINISH_MESSAGE;
 125     }
 126
 127     /**
 128      * Builds a key for mPendingUploads from the account and file to upload
 129      *
 130      * @param account   Account where the file to upload is stored
 131      * @param file      File to upload
 132      */
 133     private String buildRemoteName(Account account, OCFile file) {
 134         return account.name + file.getRemotePath();
 135     }
 136
 137     private String buildRemoteName(Account account, String remotePath) {
 138         return account.name + remotePath;
 139     }
 140
 141     /**
 142      * Checks if an ownCloud server version should support chunked uploads.
 143      *
 144      * @param version OwnCloud version instance corresponding to an ownCloud
 145      *            server.
 146      * @return 'True' if the ownCloud server with version supports chunked
 147      *         uploads.
 148      */
 149     private static boolean chunkedUploadIsSupported(OwnCloudVersion version) {
 150         return (version != null && version.compareTo(OwnCloudVersion.owncloud_v4_5) >= 0);
 151     }
 152
 153     /**
 154      * Service initialization
 155      */
 156     @Override
 157     public void onCreate() {
 158         super.onCreate();
 159         Log_OC.i(TAG, "mPendingUploads size:" + mPendingUploads.size());
 160         mNotificationManager = (NotificationManager) getSystemService(NOTIFICATION_SERVICE);
 161         HandlerThread thread = new HandlerThread("FileUploaderThread", Process.THREAD_PRIORITY_BACKGROUND);
 162         thread.start();
 163         mServiceLooper = thread.getLooper();
 164         mServiceHandler = new ServiceHandler(mServiceLooper, this);
 165         mBinder = new FileUploaderBinder();
 166     }
 167
 168     /**
 169      * Entry point to add one or several files to the queue of uploads.
 170      *
 171      * New uploads are added calling to startService(), resulting in a call to
 172      * this method. This ensures the service will keep on working although the
 173      * caller activity goes away.
 174      */
 175     @Override
 176     public int onStartCommand(Intent intent, int flags, int startId) {
 177         if (!intent.hasExtra(KEY_ACCOUNT) || !intent.hasExtra(KEY_UPLOAD_TYPE)
 178                 || !(intent.hasExtra(KEY_LOCAL_FILE) || intent.hasExtra(KEY_FILE))) {
 179             Log_OC.e(TAG, "Not enough information provided in intent");
 180             return Service.START_NOT_STICKY;
 181         }
 182         int uploadType = intent.getIntExtra(KEY_UPLOAD_TYPE, -1);
 183         if (uploadType == -1) {
 184             Log_OC.e(TAG, "Incorrect upload type provided");
 185             return Service.START_NOT_STICKY;
 186         }
 187         Account account = intent.getParcelableExtra(KEY_ACCOUNT);
 188
 189         String[] localPaths = null, remotePaths = null, mimeTypes = null;
 190         OCFile[] files = null;
 191         if (uploadType == UPLOAD_SINGLE_FILE) {
 192
 193             if (intent.hasExtra(KEY_FILE)) {
 194                 files = new OCFile[] { intent.getParcelableExtra(KEY_FILE) };
 195
 196             } else {
 197                 localPaths = new String[] { intent.getStringExtra(KEY_LOCAL_FILE) };
 198                 remotePaths = new String[] { intent.getStringExtra(KEY_REMOTE_FILE) };
 199                 mimeTypes = new String[] { intent.getStringExtra(KEY_MIME_TYPE) };
 200             }
 201
 202         } else { // mUploadType == UPLOAD_MULTIPLE_FILES
 203
 204             if (intent.hasExtra(KEY_FILE)) {
 205                 files = (OCFile[]) intent.getParcelableArrayExtra(KEY_FILE); // TODO
 206                                                                              // will
 207                                                                              // this
 208                                                                              // casting
 209                                                                              // work
 210                                                                              // fine?
 211
 212             } else {
 213                 localPaths = intent.getStringArrayExtra(KEY_LOCAL_FILE);
 214                 remotePaths = intent.getStringArrayExtra(KEY_REMOTE_FILE);
 215                 mimeTypes = intent.getStringArrayExtra(KEY_MIME_TYPE);
 216             }
 217         }
 218
 219         FileDataStorageManager storageManager = new FileDataStorageManager(account, getContentResolver());
 220
 221         boolean forceOverwrite = intent.getBooleanExtra(KEY_FORCE_OVERWRITE, false);
 222         boolean isInstant = intent.getBooleanExtra(KEY_INSTANT_UPLOAD, false);
 223         int localAction = intent.getIntExtra(KEY_LOCAL_BEHAVIOUR, LOCAL_BEHAVIOUR_COPY);
 224
 225         if (intent.hasExtra(KEY_FILE) && files == null) {
 226             Log_OC.e(TAG, "Incorrect array for OCFiles provided in upload intent");
 227             return Service.START_NOT_STICKY;
 228
 229         } else if (!intent.hasExtra(KEY_FILE)) {
 230             if (localPaths == null) {
 231                 Log_OC.e(TAG, "Incorrect array for local paths provided in upload intent");
 232                 return Service.START_NOT_STICKY;
 233             }
 234             if (remotePaths == null) {
 235                 Log_OC.e(TAG, "Incorrect array for remote paths provided in upload intent");
 236                 return Service.START_NOT_STICKY;
 237             }
 238             if (localPaths.length != remotePaths.length) {
 239                 Log_OC.e(TAG, "Different number of remote paths and local paths!");
 240                 return Service.START_NOT_STICKY;
 241             }
 242
 243             files = new OCFile[localPaths.length];
 244             for (int i = 0; i < localPaths.length; i++) {
 245                 files[i] = obtainNewOCFileToUpload(remotePaths[i], localPaths[i], ((mimeTypes != null) ? mimeTypes[i]
 246                         : (String) null), storageManager);
 247                 if (files[i] == null) {
 248                     // TODO @andomaex add failure Notification
 249                     return Service.START_NOT_STICKY;
 250                 }
 251             }
 252         }
 253
 254         AccountManager aMgr = AccountManager.get(this);
 255         String version = aMgr.getUserData(account, Constants.KEY_OC_VERSION);
 256         String versionString = aMgr.getUserData(account, Constants.KEY_OC_VERSION_STRING);
 257         OwnCloudVersion ocv = new OwnCloudVersion(version, versionString);
 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             operation = new CreateFolderOperation( pathToGrant,
 554                     true,
 555                     mStorageManager    );
 556             result = operation.execute(mUploadClient);
 557         }
 558         if (result.isSuccess()) {
 559             OCFile parentDir = mStorageManager.getFileByPath(pathToGrant);
 560             if (parentDir == null) {
 561                 parentDir = createLocalFolder(pathToGrant);
 562             }
 563             if (parentDir != null) {
 564                 result = new RemoteOperationResult(ResultCode.OK);
 565             } else {
 566                 result = new RemoteOperationResult(ResultCode.UNKNOWN_ERROR);
 567             }
 568         }
 569         return result;
 570     }
 571
 572
 573     private OCFile createLocalFolder(String remotePath) {
 574         String parentPath = new File(remotePath).getParent();
 575         parentPath = parentPath.endsWith(OCFile.PATH_SEPARATOR) ? parentPath : parentPath + OCFile.PATH_SEPARATOR;
 576         OCFile parent = mStorageManager.getFileByPath(parentPath);
 577         if (parent == null) {
 578             parent = createLocalFolder(parentPath);
 579         }
 580         if (parent != null) {
 581             OCFile createdFolder = new OCFile(remotePath);
 582             createdFolder.setMimetype("DIR");
 583             createdFolder.setParentId(parent.getFileId());
 584             mStorageManager.saveFile(createdFolder);
 585             return createdFolder;
 586         }
 587         return null;
 588     }
 589
 590
 591     /**
 592      * Saves a OC File after a successful upload.
 593      *
 594      * A PROPFIND is necessary to keep the props in the local database
 595      * synchronized with the server, specially the modification time and Etag
 596      * (where available)
 597      *
 598      * TODO refactor this ugly thing
 599      */
 600     private void saveUploadedFile() {
 601         OCFile file = mCurrentUpload.getFile();
 602         if (file.fileExists()) {
 603             file = mStorageManager.getFileById(file.getFileId());
 604         }
 605         long syncDate = System.currentTimeMillis();
 606         file.setLastSyncDateForData(syncDate);
 607
 608         // new PROPFIND to keep data consistent with server
 609         // in theory, should return the same we already have
 610         ReadRemoteFileOperation operation = new ReadRemoteFileOperation(mCurrentUpload.getRemotePath());
 611         RemoteOperationResult result = operation.execute(mUploadClient);
 612         if (result.isSuccess()) {
 613             updateOCFile(file, (RemoteFile) result.getData().get(0));
 614             file.setLastSyncDateForProperties(syncDate);
 615         }
 616
 617         // / maybe this would be better as part of UploadFileOperation... or
 618         // maybe all this method
 619         if (mCurrentUpload.wasRenamed()) {
 620             OCFile oldFile = mCurrentUpload.getOldFile();
 621             if (oldFile.fileExists()) {
 622                 oldFile.setStoragePath(null);
 623                 mStorageManager.saveFile(oldFile);
 624
 625             } // else: it was just an automatic renaming due to a name
 626               // coincidence; nothing else is needed, the storagePath is right
 627               // in the instance returned by mCurrentUpload.getFile()
 628         }
 629
 630         mStorageManager.saveFile(file);
 631     }
 632
 633     private void updateOCFile(OCFile file, RemoteFile remoteFile) {
 634         file.setCreationTimestamp(remoteFile.getCreationTimestamp());
 635         file.setFileLength(remoteFile.getLength());
 636         file.setMimetype(remoteFile.getMimeType());
 637         file.setModificationTimestamp(remoteFile.getModifiedTimestamp());
 638         file.setModificationTimestampAtLastSyncForData(remoteFile.getModifiedTimestamp());
 639         // file.setEtag(remoteFile.getEtag());    // TODO Etag, where available
 640     }
 641
 642     private OCFile obtainNewOCFileToUpload(String remotePath, String localPath, String mimeType,
 643             FileDataStorageManager storageManager) {
 644         OCFile newFile = new OCFile(remotePath);
 645         newFile.setStoragePath(localPath);
 646         newFile.setLastSyncDateForProperties(0);
 647         newFile.setLastSyncDateForData(0);
 648
 649         // size
 650         if (localPath != null && localPath.length() > 0) {
 651             File localFile = new File(localPath);
 652             newFile.setFileLength(localFile.length());
 653             newFile.setLastSyncDateForData(localFile.lastModified());
 654         } // don't worry about not assigning size, the problems with localPath
 655           // are checked when the UploadFileOperation instance is created
 656
 657         // MIME type
 658         if (mimeType == null || mimeType.length() <= 0) {
 659             try {
 660                 mimeType = MimeTypeMap.getSingleton().getMimeTypeFromExtension(
 661                         remotePath.substring(remotePath.lastIndexOf('.') + 1));
 662             } catch (IndexOutOfBoundsException e) {
 663                 Log_OC.e(TAG, "Trying to find out MIME type of a file without extension: " + remotePath);
 664             }
 665         }
 666         if (mimeType == null) {
 667             mimeType = "application/octet-stream";
 668         }
 669         newFile.setMimetype(mimeType);
 670
 671         return newFile;
 672     }
 673
 674     /**
 675      * Creates a status notification to show the upload progress
 676      *
 677      * @param upload Upload operation starting.
 678      */
 679     private void notifyUploadStart(UploadFileOperation upload) {
 680         // / create status notification with a progress bar
 681         mLastPercent = 0;
 682         mNotificationBuilder =
 683                 NotificationBuilderWithProgressBar.newNotificationBuilderWithProgressBar(this);
 684         mNotificationBuilder
 685                 .setOngoing(true)
 686                 .setSmallIcon(R.drawable.notification_icon)
 687                 .setTicker(getString(R.string.uploader_upload_in_progress_ticker))
 688                 .setContentTitle(getString(R.string.uploader_upload_in_progress_ticker))
 689                 .setProgress(100, 0, false)
 690                 .setContentText(
 691                         String.format(getString(R.string.uploader_upload_in_progress_content), 0, upload.getFileName()));
 692
 693         /// includes a pending intent in the notification showing the details view of the file
 694         Intent showDetailsIntent = new Intent(this, FileDisplayActivity.class);
 695         showDetailsIntent.putExtra(FileActivity.EXTRA_FILE, upload.getFile());
 696         showDetailsIntent.putExtra(FileActivity.EXTRA_ACCOUNT, upload.getAccount());
 697         showDetailsIntent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
 698         mNotificationBuilder.setContentIntent(PendingIntent.getActivity(
 699             this, (int) System.currentTimeMillis(), showDetailsIntent, 0
 700         ));
 701
 702         mNotificationManager.notify(R.string.uploader_upload_in_progress_ticker, mNotificationBuilder.build());
 703     }
 704
 705     /**
 706      * Callback method to update the progress bar in the status notification
 707      */
 708     @Override
 709     public void onTransferProgress(long progressRate, long totalTransferredSoFar, long totalToTransfer, String filePath) {
 710         int percent = (int) (100.0 * ((double) totalTransferredSoFar) / ((double) totalToTransfer));
 711         if (percent != mLastPercent) {
 712             mNotificationBuilder.setProgress(100, percent, false);
 713             String fileName = filePath.substring(filePath.lastIndexOf(FileUtils.PATH_SEPARATOR) + 1);
 714             String text = String.format(getString(R.string.uploader_upload_in_progress_content), percent, fileName);
 715             mNotificationBuilder.setContentText(text);
 716             mNotificationManager.notify(R.string.uploader_upload_in_progress_ticker, mNotificationBuilder.build());
 717         }
 718         mLastPercent = percent;
 719     }
 720
 721     /**
 722      * Updates the status notification with the result of an upload operation.
 723      *
 724      * @param uploadResult Result of the upload operation.
 725      * @param upload Finished upload operation
 726      */
 727     private void notifyUploadResult(RemoteOperationResult uploadResult, UploadFileOperation upload) {
 728         Log_OC.d(TAG, "NotifyUploadResult with resultCode: " + uploadResult.getCode());
 729         if (uploadResult.isCancelled()) {
 730             // / cancelled operation -> silent removal of progress notification
 731             mNotificationManager.cancel(R.string.uploader_upload_in_progress_ticker);
 732
 733         } else if (uploadResult.isSuccess()) {
 734             // / success -> silent update of progress notification to success
 735             // message
 736             mNotificationBuilder
 737                 .setOngoing(false)
 738                 .setAutoCancel(true)
 739                 .setProgress(0, 0, false);
 740
 741             /// includes a pending intent in the notification showing the details view of the file
 742             Intent showDetailsIntent = null;
 743             if (PreviewImageFragment.canBePreviewed(upload.getFile())) {
 744                 showDetailsIntent = new Intent(this, PreviewImageActivity.class);
 745             } else {
 746                 showDetailsIntent = new Intent(this, FileDisplayActivity.class);
 747             }
 748             showDetailsIntent.putExtra(FileActivity.EXTRA_FILE, upload.getFile());
 749             showDetailsIntent.putExtra(FileActivity.EXTRA_ACCOUNT, upload.getAccount());
 750             showDetailsIntent.putExtra(FileActivity.EXTRA_FROM_NOTIFICATION, true);;
 751             mNotificationBuilder
 752                 .setContentIntent(PendingIntent.getActivity(
 753                         this, (int) System.currentTimeMillis(), showDetailsIntent, 0
 754                 ))
 755                 .setTicker(getString(R.string.uploader_upload_succeeded_ticker))
 756                 .setContentTitle(getString(R.string.uploader_upload_succeeded_ticker))
 757                 .setContentText(
 758                         String.format(getString(R.string.uploader_upload_succeeded_content_single),
 759                         upload.getFileName())
 760                 );
 761
 762             mNotificationManager.notify(R.string.uploader_upload_in_progress_ticker, mNotificationBuilder.build());  // NOT
 763                                                                                                                      // AN
 764             DbHandler db = new DbHandler(this.getBaseContext());
 765             db.removeIUPendingFile(mCurrentUpload.getOriginalStoragePath());
 766             db.close();
 767
 768         } else {
 769
 770             // / fail -> explicit failure notification
 771             mNotificationManager.cancel(R.string.uploader_upload_in_progress_ticker);
 772             NotificationCompat.Builder errorBuilder = new NotificationCompat.Builder(this);
 773             errorBuilder
 774                 .setSmallIcon(R.drawable.notification_icon)
 775                 .setTicker(getString(R.string.uploader_upload_failed_ticker))
 776                 .setContentTitle(getString(R.string.uploader_upload_failed_ticker))
 777                 .setAutoCancel(true);
 778             String content = null;
 779
 780             boolean needsToUpdateCredentials = (uploadResult.getCode() == ResultCode.UNAUTHORIZED ||
 781                     //(uploadResult.isTemporalRedirection() && uploadResult.isIdPRedirection() &&
 782                     (uploadResult.isIdPRedirection() &&
 783                             mUploadClient.getCredentials() == null));
 784                             //MainApp.getAuthTokenTypeSamlSessionCookie().equals(mUploadClient.getAuthTokenType())));
 785             if (needsToUpdateCredentials) {
 786                 // let the user update credentials with one click
 787                 Intent updateAccountCredentials = new Intent(this, AuthenticatorActivity.class);
 788                 updateAccountCredentials.putExtra(AuthenticatorActivity.EXTRA_ACCOUNT, upload.getAccount());
 789                 updateAccountCredentials.putExtra(AuthenticatorActivity.EXTRA_ENFORCED_UPDATE, true);
 790                 updateAccountCredentials.putExtra(AuthenticatorActivity.EXTRA_ACTION, AuthenticatorActivity.ACTION_UPDATE_TOKEN);
 791                 updateAccountCredentials.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
 792                 updateAccountCredentials.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
 793                 updateAccountCredentials.addFlags(Intent.FLAG_FROM_BACKGROUND);
 794                 errorBuilder.setContentIntent(PendingIntent.getActivity(
 795                     this, (int) System.currentTimeMillis(), updateAccountCredentials, PendingIntent.FLAG_ONE_SHOT
 796                 ));
 797                 content =  String.format(getString(R.string.uploader_upload_failed_content_single), upload.getFileName());
 798                 mUploadClient = null;   // grant that future retries on the same account will get the fresh credentials
 799             } else {
 800                 // TODO put something smart in the contentIntent below
 801
 802                 if (uploadResult.getCode() == ResultCode.LOCAL_STORAGE_FULL
 803                         || uploadResult.getCode() == ResultCode.LOCAL_STORAGE_NOT_COPIED) {
 804                     // TODO we need a class to provide error messages for the users
 805                     // from a RemoteOperationResult and a RemoteOperation
 806                     content = String.format(getString(R.string.error__upload__local_file_not_copied), upload.getFileName(),
 807                             getString(R.string.app_name));
 808                 } else if (uploadResult.getCode() == ResultCode.QUOTA_EXCEEDED) {
 809                     content = getString(R.string.failed_upload_quota_exceeded_text);
 810                 } else {
 811                     content = String
 812                             .format(getString(R.string.uploader_upload_failed_content_single), upload.getFileName());
 813                 }
 814
 815                 // we add only for instant-uploads the InstantUploadActivity and the
 816                 // db entry
 817                 Intent detailUploadIntent = null;
 818                 if (upload.isInstant() && InstantUploadActivity.IS_ENABLED) {
 819                     detailUploadIntent = new Intent(this, InstantUploadActivity.class);
 820                     detailUploadIntent.putExtra(FileUploader.KEY_ACCOUNT, upload.getAccount());
 821                 } else {
 822                     detailUploadIntent = new Intent(this, FailedUploadActivity.class);
 823                     detailUploadIntent.putExtra(FailedUploadActivity.MESSAGE, content);
 824                 }
 825                 errorBuilder
 826                     .setContentIntent(PendingIntent.getActivity(
 827                         this, (int) System.currentTimeMillis(), detailUploadIntent, PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_ONE_SHOT
 828                     ))
 829                     .setContentText(content);
 830
 831                 if (upload.isInstant()) {
 832                     DbHandler db = null;
 833                     try {
 834                         db = new DbHandler(this.getBaseContext());
 835                         String message = uploadResult.getLogMessage() + " errorCode: " + uploadResult.getCode();
 836                         Log_OC.e(TAG, message + " Http-Code: " + uploadResult.getHttpCode());
 837                         if (uploadResult.getCode() == ResultCode.QUOTA_EXCEEDED) {
 838                             message = getString(R.string.failed_upload_quota_exceeded_text);
 839                             if (db.updateFileState(upload.getOriginalStoragePath(), DbHandler.UPLOAD_STATUS_UPLOAD_FAILED,
 840                                     message) == 0) {
 841                                 db.putFileForLater(upload.getOriginalStoragePath(), upload.getAccount().name, message);
 842                             }
 843                         }
 844                     } finally {
 845                         if (db != null) {
 846                             db.close();
 847                         }
 848                     }
 849                 }
 850             }
 851
 852             errorBuilder.setContentText(content);
 853             mNotificationManager.notify(R.string.uploader_upload_failed_ticker, errorBuilder.build());
 854         }
 855
 856     }
 857
 858     /**
 859      * Sends a broadcast in order to the interested activities can update their
 860      * view
 861      *
 862      * @param upload Finished upload operation
 863      * @param uploadResult Result of the upload operation
 864      */
 865     private void sendFinalBroadcast(UploadFileOperation upload, RemoteOperationResult uploadResult) {
 866         Intent end = new Intent(getUploadFinishMessage());
 867         end.putExtra(EXTRA_REMOTE_PATH, upload.getRemotePath()); // real remote
 868                                                                  // path, after
 869                                                                  // possible
 870                                                                  // automatic
 871                                                                  // renaming
 872         if (upload.wasRenamed()) {
 873             end.putExtra(EXTRA_OLD_REMOTE_PATH, upload.getOldFile().getRemotePath());
 874         }
 875         end.putExtra(EXTRA_OLD_FILE_PATH, upload.getOriginalStoragePath());
 876         end.putExtra(ACCOUNT_NAME, upload.getAccount().name);
 877         end.putExtra(EXTRA_UPLOAD_RESULT, uploadResult.isSuccess());
 878         sendStickyBroadcast(end);
 879     }
 880
 881 }