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