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

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