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                 mCurrentUpload.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             Iterator<String> it = mPendingUploads.keySet().iterator();
 393             Log_OC.d(TAG, "Number of pending uploads= "  + mPendingUploads.size());
 394             while (it.hasNext()) {
 395                 String key = it.next();
 396                 Log_OC.d(TAG, "mPendingUploads CANCELLED " + key);
 397                 if (key.startsWith(account.name)) {
 398                     synchronized (mPendingUploads) {
 399                         mPendingUploads.remove(key);
 400                     }
 401                 }
 402             }
 403         }
 404
 405         public void clearListeners() {
 406             mBoundListeners.clear();
 407         }
 408
 409         /**
 410          * Returns True when the file described by 'file' is being uploaded to
 411          * the ownCloud account 'account' or waiting for it
 412          *
 413          * If 'file' is a directory, returns 'true' if some of its descendant files is uploading or waiting to upload.
 414          *
 415          * @param account   ownCloud account where the remote file will be stored.
 416          * @param file      A file that could be in the queue of pending uploads
 417          */
 418         public boolean isUploading(Account account, OCFile file) {
 419             if (account == null || file == null)
 420                 return false;
 421             String targetKey = buildRemoteName(account, file);
 422             synchronized (mPendingUploads) {
 423                 if (file.isFolder()) {
 424                     // this can be slow if there are many uploads :(
 425                     Iterator<String> it = mPendingUploads.keySet().iterator();
 426                     boolean found = false;
 427                     while (it.hasNext() && !found) {
 428                         found = it.next().startsWith(targetKey);
 429                     }
 430                     return found;
 431                 } else {
 432                     return (mPendingUploads.containsKey(targetKey));
 433                 }
 434             }
 435         }
 436
 437
 438         /**
 439          * Adds a listener interested in the progress of the upload for a concrete file.
 440          *
 441          * @param listener      Object to notify about progress of transfer.
 442          * @param account       ownCloud account holding the file of interest.
 443          * @param file          {@link OCFile} of interest for listener.
 444          */
 445         public void addDatatransferProgressListener (OnDatatransferProgressListener listener, Account account, OCFile file) {
 446             if (account == null || file == null || listener == null) return;
 447             String targetKey = buildRemoteName(account, file);
 448             mBoundListeners.put(targetKey, listener);
 449         }
 450
 451
 452
 453         /**
 454          * Removes a listener interested in the progress of the upload for a concrete file.
 455          *
 456          * @param listener      Object to notify about progress of transfer.
 457          * @param account       ownCloud account holding the file of interest.
 458          * @param file          {@link OCFile} of interest for listener.
 459          */
 460         public void removeDatatransferProgressListener (OnDatatransferProgressListener listener, Account account, OCFile file) {
 461             if (account == null || file == null || listener == null) return;
 462             String targetKey = buildRemoteName(account, file);
 463             if (mBoundListeners.get(targetKey) == listener) {
 464                 mBoundListeners.remove(targetKey);
 465             }
 466         }
 467
 468
 469         @Override
 470         public void onTransferProgress(long progressRate, long totalTransferredSoFar, long totalToTransfer,
 471                                        String fileName) {
 472             String key = buildRemoteName(mCurrentUpload.getAccount(), mCurrentUpload.getFile());
 473             OnDatatransferProgressListener boundListener = mBoundListeners.get(key);
 474             if (boundListener != null) {
 475                 boundListener.onTransferProgress(progressRate, totalTransferredSoFar, totalToTransfer, fileName);
 476             }
 477         }
 478
 479         /**
 480          * Review uploads and cancel it if its account doesn't exist
 481          */
 482         public void reviewUploads() {
 483             if (mCurrentUpload != null &&
 484                     !AccountUtils.exists(mCurrentUpload.getAccount(), getApplicationContext())) {
 485                 mCurrentUpload.cancel();
 486             }
 487             // The rest of uploads are cancelled when they try to start
 488         }
 489     }
 490
 491     /**
 492      * Upload worker. Performs the pending uploads in the order they were
 493      * requested.
 494      *
 495      * Created with the Looper of a new thread, started in
 496      * {@link FileUploader#onCreate()}.
 497      */
 498     private static class ServiceHandler extends Handler {
 499         // don't make it a final class, and don't remove the static ; lint will
 500         // warn about a possible memory leak
 501         FileUploader mService;
 502
 503         public ServiceHandler(Looper looper, FileUploader service) {
 504             super(looper);
 505             if (service == null)
 506                 throw new IllegalArgumentException("Received invalid NULL in parameter 'service'");
 507             mService = service;
 508         }
 509
 510         @Override
 511         public void handleMessage(Message msg) {
 512             @SuppressWarnings("unchecked")
 513             AbstractList<String> requestedUploads = (AbstractList<String>) msg.obj;
 514             if (msg.obj != null) {
 515                 Iterator<String> it = requestedUploads.iterator();
 516                 while (it.hasNext()) {
 517                     mService.uploadFile(it.next());
 518                 }
 519             }
 520             Log_OC.d(TAG, "Stopping command after id " + msg.arg1);
 521             mService.stopSelf(msg.arg1);
 522         }
 523     }
 524
 525     /**
 526      * Core upload method: sends the file(s) to upload
 527      *
 528      * @param uploadKey Key to access the upload to perform, contained in
 529      *            mPendingUploads
 530      */
 531     public void uploadFile(String uploadKey) {
 532
 533         synchronized (mPendingUploads) {
 534             mCurrentUpload = mPendingUploads.get(uploadKey);
 535         }
 536
 537         if (mCurrentUpload != null) {
 538
 539             // Detect if the account exists
 540             if (AccountUtils.exists(mCurrentUpload.getAccount(), getApplicationContext())) {
 541                 Log_OC.d(TAG, "Account " + mCurrentUpload.getAccount().toString() + " exists");
 542
 543                 notifyUploadStart(mCurrentUpload);
 544
 545                 RemoteOperationResult uploadResult = null, grantResult = null;
 546
 547                 try {
 548                     /// prepare client object to send requests to the ownCloud server
 549                     if (mUploadClient == null || !mLastAccount.equals(mCurrentUpload.getAccount())) {
 550                         mLastAccount = mCurrentUpload.getAccount();
 551                         mStorageManager =
 552                                 new FileDataStorageManager(mLastAccount, getContentResolver());
 553                         OwnCloudAccount ocAccount = new OwnCloudAccount(mLastAccount, this);
 554                         mUploadClient = OwnCloudClientManagerFactory.getDefaultSingleton().
 555                                 getClientFor(ocAccount, this);
 556                     }
 557
 558                     /// check the existence of the parent folder for the file to upload
 559                     String remoteParentPath = new File(mCurrentUpload.getRemotePath()).getParent();
 560                     remoteParentPath = remoteParentPath.endsWith(OCFile.PATH_SEPARATOR) ? remoteParentPath : remoteParentPath + OCFile.PATH_SEPARATOR;
 561                     grantResult = grantFolderExistence(remoteParentPath);
 562
 563                     /// perform the upload
 564                     if (grantResult.isSuccess()) {
 565                         OCFile parent = mStorageManager.getFileByPath(remoteParentPath);
 566                         mCurrentUpload.getFile().setParentId(parent.getFileId());
 567                         uploadResult = mCurrentUpload.execute(mUploadClient);
 568                         if (uploadResult.isSuccess()) {
 569                             saveUploadedFile();
 570                         }
 571                     } else {
 572                         uploadResult = grantResult;
 573                     }
 574
 575                 } catch (AccountsException e) {
 576                     Log_OC.e(TAG, "Error while trying to get autorization for " + mLastAccount.name, e);
 577                     uploadResult = new RemoteOperationResult(e);
 578
 579                 } catch (IOException e) {
 580                     Log_OC.e(TAG, "Error while trying to get autorization for " + mLastAccount.name, e);
 581                     uploadResult = new RemoteOperationResult(e);
 582
 583                 } finally {
 584                     synchronized (mPendingUploads) {
 585                         mPendingUploads.remove(uploadKey);
 586                         Log_OC.i(TAG, "Remove CurrentUploadItem from pending upload Item Map.");
 587                     }
 588                     if (uploadResult.isException()) {
 589                         // enforce the creation of a new client object for next uploads; this grant that a new socket will
 590                         // be created in the future if the current exception is due to an abrupt lose of network connection
 591                         mUploadClient = null;
 592                     }
 593                 }
 594
 595                 /// notify result
 596                 notifyUploadResult(uploadResult, mCurrentUpload);
 597                 sendFinalBroadcast(mCurrentUpload, uploadResult);
 598
 599             } else {
 600                 // Cancel the transfer
 601                 Log_OC.d(TAG, "Account " + mCurrentUpload.getAccount().toString() + " doesn't exist");
 602                 cancelUploadForAccount(mCurrentUpload.getAccount().name);
 603
 604             }
 605         }
 606
 607     }
 608
 609     /**
 610      * Checks the existence of the folder where the current file will be uploaded both in the remote server
 611      * and in the local database.
 612      *
 613      * If the upload is set to enforce the creation of the folder, the method tries to create it both remote
 614      * and locally.
 615      *
 616      *  @param  pathToGrant     Full remote path whose existence will be granted.
 617      *  @return  An {@link OCFile} instance corresponding to the folder where the file will be uploaded.
 618      */
 619     private RemoteOperationResult grantFolderExistence(String pathToGrant) {
 620         RemoteOperation operation = new ExistenceCheckRemoteOperation(pathToGrant, this, false);
 621         RemoteOperationResult result = operation.execute(mUploadClient);
 622         if (!result.isSuccess() && result.getCode() == ResultCode.FILE_NOT_FOUND &&
 623                 mCurrentUpload.isRemoteFolderToBeCreated()) {
 624             SyncOperation syncOp = new CreateFolderOperation( pathToGrant, true);
 625             result = syncOp.execute(mUploadClient, mStorageManager);
 626         }
 627         if (result.isSuccess()) {
 628             OCFile parentDir = mStorageManager.getFileByPath(pathToGrant);
 629             if (parentDir == null) {
 630                 parentDir = createLocalFolder(pathToGrant);
 631             }
 632             if (parentDir != null) {
 633                 result = new RemoteOperationResult(ResultCode.OK);
 634             } else {
 635                 result = new RemoteOperationResult(ResultCode.UNKNOWN_ERROR);
 636             }
 637         }
 638         return result;
 639     }
 640
 641
 642     private OCFile createLocalFolder(String remotePath) {
 643         String parentPath = new File(remotePath).getParent();
 644         parentPath = parentPath.endsWith(OCFile.PATH_SEPARATOR) ?
 645                 parentPath : parentPath + OCFile.PATH_SEPARATOR;
 646         OCFile parent = mStorageManager.getFileByPath(parentPath);
 647         if (parent == null) {
 648             parent = createLocalFolder(parentPath);
 649         }
 650         if (parent != null) {
 651             OCFile createdFolder = new OCFile(remotePath);
 652             createdFolder.setMimetype("DIR");
 653             createdFolder.setParentId(parent.getFileId());
 654             mStorageManager.saveFile(createdFolder);
 655             return createdFolder;
 656         }
 657         return null;
 658     }
 659
 660
 661     /**
 662      * Saves a OC File after a successful upload.
 663      *
 664      * A PROPFIND is necessary to keep the props in the local database
 665      * synchronized with the server, specially the modification time and Etag
 666      * (where available)
 667      *
 668      * TODO refactor this ugly thing
 669      */
 670     private void saveUploadedFile() {
 671         OCFile file = mCurrentUpload.getFile();
 672         if (file.fileExists()) {
 673             file = mStorageManager.getFileById(file.getFileId());
 674         }
 675         long syncDate = System.currentTimeMillis();
 676         file.setLastSyncDateForData(syncDate);
 677
 678         // new PROPFIND to keep data consistent with server
 679         // in theory, should return the same we already have
 680         ReadRemoteFileOperation operation = new ReadRemoteFileOperation(mCurrentUpload.getRemotePath());
 681         RemoteOperationResult result = operation.execute(mUploadClient);
 682         if (result.isSuccess()) {
 683             updateOCFile(file, (RemoteFile) result.getData().get(0));
 684             file.setLastSyncDateForProperties(syncDate);
 685         }
 686
 687         // / maybe this would be better as part of UploadFileOperation... or
 688         // maybe all this method
 689         if (mCurrentUpload.wasRenamed()) {
 690             OCFile oldFile = mCurrentUpload.getOldFile();
 691             if (oldFile.fileExists()) {
 692                 oldFile.setStoragePath(null);
 693                 mStorageManager.saveFile(oldFile);
 694
 695             } // else: it was just an automatic renaming due to a name
 696             // coincidence; nothing else is needed, the storagePath is right
 697             // in the instance returned by mCurrentUpload.getFile()
 698         }
 699         file.setNeedsUpdateThumbnail(true);
 700         mStorageManager.saveFile(file);
 701     }
 702
 703     private void updateOCFile(OCFile file, RemoteFile remoteFile) {
 704         file.setCreationTimestamp(remoteFile.getCreationTimestamp());
 705         file.setFileLength(remoteFile.getLength());
 706         file.setMimetype(remoteFile.getMimeType());
 707         file.setModificationTimestamp(remoteFile.getModifiedTimestamp());
 708         file.setModificationTimestampAtLastSyncForData(remoteFile.getModifiedTimestamp());
 709         // file.setEtag(remoteFile.getEtag());    // TODO Etag, where available
 710         file.setRemoteId(remoteFile.getRemoteId());
 711     }
 712
 713     private OCFile obtainNewOCFileToUpload(String remotePath, String localPath, String mimeType,
 714                                            FileDataStorageManager storageManager) {
 715
 716         // MIME type
 717         if (mimeType == null || mimeType.length() <= 0) {
 718             try {
 719                 mimeType = MimeTypeMap.getSingleton().getMimeTypeFromExtension(
 720                         remotePath.substring(remotePath.lastIndexOf('.') + 1));
 721             } catch (IndexOutOfBoundsException e) {
 722                 Log_OC.e(TAG, "Trying to find out MIME type of a file without extension: " + remotePath);
 723             }
 724         }
 725         if (mimeType == null) {
 726             mimeType = "application/octet-stream";
 727         }
 728
 729         if (isPdfFileFromContentProviderWithoutExtension(localPath, mimeType)){
 730             remotePath += FILE_EXTENSION_PDF;
 731         }
 732
 733         OCFile newFile = new OCFile(remotePath);
 734         newFile.setStoragePath(localPath);
 735         newFile.setLastSyncDateForProperties(0);
 736         newFile.setLastSyncDateForData(0);
 737
 738         // size
 739         if (localPath != null && localPath.length() > 0) {
 740             File localFile = new File(localPath);
 741             newFile.setFileLength(localFile.length());
 742             newFile.setLastSyncDateForData(localFile.lastModified());
 743         } // don't worry about not assigning size, the problems with localPath
 744         // are checked when the UploadFileOperation instance is created
 745
 746
 747         newFile.setMimetype(mimeType);
 748
 749         return newFile;
 750     }
 751
 752     /**
 753      * Creates a status notification to show the upload progress
 754      *
 755      * @param upload Upload operation starting.
 756      */
 757     private void notifyUploadStart(UploadFileOperation upload) {
 758         // / create status notification with a progress bar
 759         mLastPercent = 0;
 760         mNotificationBuilder =
 761                 NotificationBuilderWithProgressBar.newNotificationBuilderWithProgressBar(this);
 762         mNotificationBuilder
 763                 .setOngoing(true)
 764                 .setSmallIcon(R.drawable.notification_icon)
 765                 .setTicker(getString(R.string.uploader_upload_in_progress_ticker))
 766                 .setContentTitle(getString(R.string.uploader_upload_in_progress_ticker))
 767                 .setProgress(100, 0, false)
 768                 .setContentText(
 769                         String.format(getString(R.string.uploader_upload_in_progress_content), 0, upload.getFileName()));
 770
 771         /// includes a pending intent in the notification showing the details view of the file
 772         Intent showDetailsIntent = new Intent(this, FileDisplayActivity.class);
 773         showDetailsIntent.putExtra(FileActivity.EXTRA_FILE, upload.getFile());
 774         showDetailsIntent.putExtra(FileActivity.EXTRA_ACCOUNT, upload.getAccount());
 775         showDetailsIntent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
 776         mNotificationBuilder.setContentIntent(PendingIntent.getActivity(
 777                 this, (int) System.currentTimeMillis(), showDetailsIntent, 0
 778         ));
 779
 780         mNotificationManager.notify(R.string.uploader_upload_in_progress_ticker, mNotificationBuilder.build());
 781     }
 782
 783     /**
 784      * Callback method to update the progress bar in the status notification
 785      */
 786     @Override
 787     public void onTransferProgress(long progressRate, long totalTransferredSoFar, long totalToTransfer, String filePath) {
 788         int percent = (int) (100.0 * ((double) totalTransferredSoFar) / ((double) totalToTransfer));
 789         if (percent != mLastPercent) {
 790             mNotificationBuilder.setProgress(100, percent, false);
 791             String fileName = filePath.substring(filePath.lastIndexOf(FileUtils.PATH_SEPARATOR) + 1);
 792             String text = String.format(getString(R.string.uploader_upload_in_progress_content), percent, fileName);
 793             mNotificationBuilder.setContentText(text);
 794             mNotificationManager.notify(R.string.uploader_upload_in_progress_ticker, mNotificationBuilder.build());
 795         }
 796         mLastPercent = percent;
 797     }
 798
 799     /**
 800      * Updates the status notification with the result of an upload operation.
 801      *
 802      * @param uploadResult Result of the upload operation.
 803      * @param upload Finished upload operation
 804      */
 805     private void notifyUploadResult(
 806             RemoteOperationResult uploadResult, UploadFileOperation upload) {
 807         Log_OC.d(TAG, "NotifyUploadResult with resultCode: " + uploadResult.getCode());
 808         // / cancelled operation or success -> silent removal of progress notification
 809         mNotificationManager.cancel(R.string.uploader_upload_in_progress_ticker);
 810
 811         // Show the result: success or fail notification
 812         if (!uploadResult.isCancelled()) {
 813             int tickerId = (uploadResult.isSuccess()) ? R.string.uploader_upload_succeeded_ticker :
 814                     R.string.uploader_upload_failed_ticker;
 815
 816             String content = null;
 817
 818             // check credentials error
 819             boolean needsToUpdateCredentials = (
 820                     uploadResult.getCode() == ResultCode.UNAUTHORIZED ||
 821                             uploadResult.isIdPRedirection()
 822             );
 823             tickerId = (needsToUpdateCredentials) ?
 824                     R.string.uploader_upload_failed_credentials_error : tickerId;
 825
 826             mNotificationBuilder
 827                     .setTicker(getString(tickerId))
 828                     .setContentTitle(getString(tickerId))
 829                     .setAutoCancel(true)
 830                     .setOngoing(false)
 831                     .setProgress(0, 0, false);
 832
 833             content =  ErrorMessageAdapter.getErrorCauseMessage(
 834                     uploadResult, upload, getResources()
 835             );
 836
 837             if (needsToUpdateCredentials) {
 838                 // let the user update credentials with one click
 839                 Intent updateAccountCredentials = new Intent(this, AuthenticatorActivity.class);
 840                 updateAccountCredentials.putExtra(
 841                         AuthenticatorActivity.EXTRA_ACCOUNT, upload.getAccount()
 842                 );
 843                 updateAccountCredentials.putExtra(
 844                         AuthenticatorActivity.EXTRA_ACTION,
 845                         AuthenticatorActivity.ACTION_UPDATE_EXPIRED_TOKEN
 846                 );
 847                 updateAccountCredentials.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
 848                 updateAccountCredentials.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
 849                 updateAccountCredentials.addFlags(Intent.FLAG_FROM_BACKGROUND);
 850                 mNotificationBuilder.setContentIntent(PendingIntent.getActivity(
 851                         this,
 852                         (int) System.currentTimeMillis(),
 853                         updateAccountCredentials,
 854                         PendingIntent.FLAG_ONE_SHOT
 855                 ));
 856
 857                 mUploadClient = null;
 858                 // grant that future retries on the same account will get the fresh credentials
 859             } else {
 860                 mNotificationBuilder.setContentText(content);
 861
 862                 if (upload.isInstant()) {
 863                     DbHandler db = null;
 864                     try {
 865                         db = new DbHandler(this.getBaseContext());
 866                         String message = uploadResult.getLogMessage() + " errorCode: " +
 867                                 uploadResult.getCode();
 868                         Log_OC.e(TAG, message + " Http-Code: " + uploadResult.getHttpCode());
 869                         if (uploadResult.getCode() == ResultCode.QUOTA_EXCEEDED) {
 870                             //message = getString(R.string.failed_upload_quota_exceeded_text);
 871                             if (db.updateFileState(
 872                                     upload.getOriginalStoragePath(),
 873                                     DbHandler.UPLOAD_STATUS_UPLOAD_FAILED,
 874                                     message) == 0) {
 875                                 db.putFileForLater(
 876                                         upload.getOriginalStoragePath(),
 877                                         upload.getAccount().name,
 878                                         message
 879                                 );
 880                             }
 881                         }
 882                     } finally {
 883                         if (db != null) {
 884                             db.close();
 885                         }
 886                     }
 887                 }
 888             }
 889
 890             mNotificationBuilder.setContentText(content);
 891             mNotificationManager.notify(tickerId, mNotificationBuilder.build());
 892
 893             if (uploadResult.isSuccess()) {
 894
 895                 DbHandler db = new DbHandler(this.getBaseContext());
 896                 db.removeIUPendingFile(mCurrentUpload.getOriginalStoragePath());
 897                 db.close();
 898
 899                 // remove success notification, with a delay of 2 seconds
 900                 NotificationDelayer.cancelWithDelay(
 901                         mNotificationManager,
 902                         R.string.uploader_upload_succeeded_ticker,
 903                         2000);
 904
 905             }
 906         }
 907     }
 908
 909     /**
 910      * Sends a broadcast in order to the interested activities can update their
 911      * view
 912      *
 913      * @param upload Finished upload operation
 914      * @param uploadResult Result of the upload operation
 915      */
 916     private void sendFinalBroadcast(UploadFileOperation upload, RemoteOperationResult uploadResult) {
 917         Intent end = new Intent(getUploadFinishMessage());
 918         end.putExtra(EXTRA_REMOTE_PATH, upload.getRemotePath()); // real remote
 919         // path, after
 920         // possible
 921         // automatic
 922         // renaming
 923         if (upload.wasRenamed()) {
 924             end.putExtra(EXTRA_OLD_REMOTE_PATH, upload.getOldFile().getRemotePath());
 925         }
 926         end.putExtra(EXTRA_OLD_FILE_PATH, upload.getOriginalStoragePath());
 927         end.putExtra(ACCOUNT_NAME, upload.getAccount().name);
 928         end.putExtra(EXTRA_UPLOAD_RESULT, uploadResult.isSuccess());
 929         sendStickyBroadcast(end);
 930     }
 931
 932     /**
 933      * Checks if content provider, using the content:// scheme, returns a file with mime-type
 934      * 'application/pdf' but file has not extension
 935      * @param localPath
 936      * @param mimeType
 937      * @return true if is needed to add the pdf file extension to the file
 938      */
 939     private boolean isPdfFileFromContentProviderWithoutExtension(String localPath, String mimeType) {
 940         return localPath.startsWith(UriUtils.URI_CONTENT_SCHEME) &&
 941                 mimeType.equals(MIME_TYPE_PDF) &&
 942                 !localPath.endsWith(FILE_EXTENSION_PDF);
 943     }
 944
 945     /**
 946      * Remove uploads of an account
 947      * @param accountName
 948      */
 949     private void cancelUploadForAccount(String accountName){
 950         // this can be slow if there are many uploads :(
 951         Iterator<String> it = mPendingUploads.keySet().iterator();
 952         Log_OC.d(TAG, "Number of pending updloads= "  + mPendingUploads.size());
 953         while (it.hasNext()) {
 954             String key = it.next();
 955             Log_OC.d(TAG, "mPendingUploads CANCELLED " + key);
 956             if (key.startsWith(accountName)) {
 957                 synchronized (mPendingUploads) {
 958                     mPendingUploads.remove(key);
 959                 }
 960             }
 961         }
 962     }
 963 }