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

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