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