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.operations.CreateFolderOperation;
  37 import com.owncloud.android.lib.operations.common.RemoteFile;
  38 import com.owncloud.android.lib.operations.common.RemoteOperation;
  39 import com.owncloud.android.lib.operations.common.RemoteOperationResult;
  40 import com.owncloud.android.operations.UploadFileOperation;
  41 import com.owncloud.android.lib.operations.common.RemoteOperationResult.ResultCode;
  42 import com.owncloud.android.lib.operations.remote.ExistenceCheckRemoteOperation;
  43 import com.owncloud.android.lib.operations.remote.ReadRemoteFileOperation;
  44 import com.owncloud.android.lib.utils.FileUtils;
  45 import com.owncloud.android.lib.utils.OwnCloudVersion;
  46 import com.owncloud.android.lib.network.OnDatatransferProgressListener;
  47 import com.owncloud.android.lib.accounts.OwnCloudAccount;
  48 import com.owncloud.android.lib.network.OwnCloudClientFactory;
  49 import com.owncloud.android.lib.network.OwnCloudClient;
  50 import com.owncloud.android.ui.activity.FailedUploadActivity;
  51 import com.owncloud.android.ui.activity.FileActivity;
  52 import com.owncloud.android.ui.activity.FileDisplayActivity;
  53 import com.owncloud.android.ui.activity.InstantUploadActivity;
  54 import com.owncloud.android.ui.preview.PreviewImageActivity;
  55 import com.owncloud.android.ui.preview.PreviewImageFragment;
  56 import com.owncloud.android.utils.DisplayUtils;
  57 import com.owncloud.android.utils.Log_OC;
  58
  59 import android.accounts.Account;
  60 import android.accounts.AccountManager;
  61 import android.accounts.AccountsException;
  62 import android.app.Notification;
  63 import android.app.NotificationManager;
  64 import android.app.PendingIntent;
  65 import android.app.Service;
  66 import android.content.Intent;
  67 import android.os.Binder;
  68 import android.os.Handler;
  69 import android.os.HandlerThread;
  70 import android.os.IBinder;
  71 import android.os.Looper;
  72 import android.os.Message;
  73 import android.os.Process;
  74 import android.webkit.MimeTypeMap;
  75 import android.widget.RemoteViews;
  76
  77
  78
  79 public class FileUploader extends Service implements OnDatatransferProgressListener {
  80
  81     private static final String UPLOAD_FINISH_MESSAGE = "UPLOAD_FINISH";
  82     public static final String EXTRA_UPLOAD_RESULT = "RESULT";
  83     public static final String EXTRA_REMOTE_PATH = "REMOTE_PATH";
  84     public static final String EXTRA_OLD_REMOTE_PATH = "OLD_REMOTE_PATH";
  85     public static final String EXTRA_OLD_FILE_PATH = "OLD_FILE_PATH";
  86     public static final String ACCOUNT_NAME = "ACCOUNT_NAME";
  87
  88     public static final String KEY_FILE = "FILE";
  89     public static final String KEY_LOCAL_FILE = "LOCAL_FILE";
  90     public static final String KEY_REMOTE_FILE = "REMOTE_FILE";
  91     public static final String KEY_MIME_TYPE = "MIME_TYPE";
  92
  93     public static final String KEY_ACCOUNT = "ACCOUNT";
  94
  95     public static final String KEY_UPLOAD_TYPE = "UPLOAD_TYPE";
  96     public static final String KEY_FORCE_OVERWRITE = "KEY_FORCE_OVERWRITE";
  97     public static final String KEY_INSTANT_UPLOAD = "INSTANT_UPLOAD";
  98     public static final String KEY_LOCAL_BEHAVIOUR = "BEHAVIOUR";
  99
 100     public static final int LOCAL_BEHAVIOUR_COPY = 0;
 101     public static final int LOCAL_BEHAVIOUR_MOVE = 1;
 102     public static final int LOCAL_BEHAVIOUR_FORGET = 2;
 103
 104     public static final int UPLOAD_SINGLE_FILE = 0;
 105     public static final int UPLOAD_MULTIPLE_FILES = 1;
 106
 107     private static final String TAG = FileUploader.class.getSimpleName();
 108
 109     private Looper mServiceLooper;
 110     private ServiceHandler mServiceHandler;
 111     private IBinder mBinder;
 112     private OwnCloudClient mUploadClient = null;
 113     private Account mLastAccount = null;
 114     private FileDataStorageManager mStorageManager;
 115
 116     private ConcurrentMap<String, UploadFileOperation> mPendingUploads = new ConcurrentHashMap<String, UploadFileOperation>();
 117     private UploadFileOperation mCurrentUpload = null;
 118
 119     private NotificationManager mNotificationManager;
 120     private Notification mNotification;
 121     private int mLastPercent;
 122     private RemoteViews mDefaultNotificationContentView;
 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         OwnCloudVersion ocv = new OwnCloudVersion(AccountManager.get(this).getUserData(account, OwnCloudAccount.Constants.KEY_OC_VERSION));
 257         boolean chunked = FileUploader.chunkedUploadIsSupported(ocv);
 258         AbstractList<String> requestedUploads = new Vector<String>();
 259         String uploadKey = null;
 260         UploadFileOperation newUpload = null;
 261         try {
 262             for (int i = 0; i < files.length; i++) {
 263                 uploadKey = buildRemoteName(account, files[i].getRemotePath());
 264                 newUpload = new UploadFileOperation(account, files[i], chunked, isInstant, forceOverwrite, localAction,
 265                         getApplicationContext());
 266                 if (isInstant) {
 267                     newUpload.setRemoteFolderToBeCreated();
 268                 }
 269                 mPendingUploads.putIfAbsent(uploadKey, newUpload); // Grants that the file only upload once time
 270
 271                 newUpload.addDatatransferProgressListener(this);
 272                 newUpload.addDatatransferProgressListener((FileUploaderBinder)mBinder);
 273                 requestedUploads.add(uploadKey);
 274             }
 275
 276         } catch (IllegalArgumentException e) {
 277             Log_OC.e(TAG, "Not enough information provided in intent: " + e.getMessage());
 278             return START_NOT_STICKY;
 279
 280         } catch (IllegalStateException e) {
 281             Log_OC.e(TAG, "Bad information provided in intent: " + e.getMessage());
 282             return START_NOT_STICKY;
 283
 284         } catch (Exception e) {
 285             Log_OC.e(TAG, "Unexpected exception while processing upload intent", e);
 286             return START_NOT_STICKY;
 287
 288         }
 289
 290         if (requestedUploads.size() > 0) {
 291             Message msg = mServiceHandler.obtainMessage();
 292             msg.arg1 = startId;
 293             msg.obj = requestedUploads;
 294             mServiceHandler.sendMessage(msg);
 295         }
 296         Log_OC.i(TAG, "mPendingUploads size:" + mPendingUploads.size());
 297         return Service.START_NOT_STICKY;
 298     }
 299
 300     /**
 301      * Provides a binder object that clients can use to perform operations on
 302      * the queue of uploads, excepting the addition of new files.
 303      *
 304      * Implemented to perform cancellation, pause and resume of existing
 305      * uploads.
 306      */
 307     @Override
 308     public IBinder onBind(Intent arg0) {
 309         return mBinder;
 310     }
 311
 312     /**
 313      * Called when ALL the bound clients were onbound.
 314      */
 315     @Override
 316     public boolean onUnbind(Intent intent) {
 317         ((FileUploaderBinder)mBinder).clearListeners();
 318         return false;   // not accepting rebinding (default behaviour)
 319     }
 320
 321
 322     /**
 323      * Binder to let client components to perform operations on the queue of
 324      * uploads.
 325      *
 326      * It provides by itself the available operations.
 327      */
 328     public class FileUploaderBinder extends Binder implements OnDatatransferProgressListener {
 329
 330         /**
 331          * Map of listeners that will be reported about progress of uploads from a {@link FileUploaderBinder} instance
 332          */
 333         private Map<String, OnDatatransferProgressListener> mBoundListeners = new HashMap<String, OnDatatransferProgressListener>();
 334
 335         /**
 336          * Cancels a pending or current upload of a remote file.
 337          *
 338          * @param account Owncloud account where the remote file will be stored.
 339          * @param file A file in the queue of pending uploads
 340          */
 341         public void cancel(Account account, OCFile file) {
 342             UploadFileOperation upload = null;
 343             synchronized (mPendingUploads) {
 344                 upload = mPendingUploads.remove(buildRemoteName(account, file));
 345             }
 346             if (upload != null) {
 347                 upload.cancel();
 348             }
 349         }
 350
 351
 352
 353         public void clearListeners() {
 354             mBoundListeners.clear();
 355         }
 356
 357
 358
 359
 360         /**
 361          * Returns True when the file described by 'file' is being uploaded to
 362          * the ownCloud account 'account' or waiting for it
 363          *
 364          * If 'file' is a directory, returns 'true' if some of its descendant files is uploading or waiting to upload.
 365          *
 366          * @param account Owncloud account where the remote file will be stored.
 367          * @param file A file that could be in the queue of pending uploads
 368          */
 369         public boolean isUploading(Account account, OCFile file) {
 370             if (account == null || file == null)
 371                 return false;
 372             String targetKey = buildRemoteName(account, file);
 373             synchronized (mPendingUploads) {
 374                 if (file.isFolder()) {
 375                     // this can be slow if there are many uploads :(
 376                     Iterator<String> it = mPendingUploads.keySet().iterator();
 377                     boolean found = false;
 378                     while (it.hasNext() && !found) {
 379                         found = it.next().startsWith(targetKey);
 380                     }
 381                     return found;
 382                 } else {
 383                     return (mPendingUploads.containsKey(targetKey));
 384                 }
 385             }
 386         }
 387
 388
 389         /**
 390          * Adds a listener interested in the progress of the upload for a concrete file.
 391          *
 392          * @param listener      Object to notify about progress of transfer.
 393          * @param account       ownCloud account holding the file of interest.
 394          * @param file          {@link OCfile} of interest for listener.
 395          */
 396         public void addDatatransferProgressListener (OnDatatransferProgressListener listener, Account account, OCFile file) {
 397             if (account == null || file == null || listener == null) return;
 398             String targetKey = buildRemoteName(account, file);
 399             mBoundListeners.put(targetKey, listener);
 400         }
 401
 402
 403
 404         /**
 405          * Removes a listener interested in the progress of the upload for a concrete file.
 406          *
 407          * @param listener      Object to notify about progress of transfer.
 408          * @param account       ownCloud account holding the file of interest.
 409          * @param file          {@link OCfile} of interest for listener.
 410          */
 411         public void removeDatatransferProgressListener (OnDatatransferProgressListener listener, Account account, OCFile file) {
 412             if (account == null || file == null || listener == null) return;
 413             String targetKey = buildRemoteName(account, file);
 414             if (mBoundListeners.get(targetKey) == listener) {
 415                 mBoundListeners.remove(targetKey);
 416             }
 417         }
 418
 419
 420         @Override
 421         public void onTransferProgress(long progressRate, long totalTransferredSoFar, long totalToTransfer,
 422                 String fileName) {
 423             String key = buildRemoteName(mCurrentUpload.getAccount(), mCurrentUpload.getFile());
 424             OnDatatransferProgressListener boundListener = mBoundListeners.get(key);
 425             if (boundListener != null) {
 426                 boundListener.onTransferProgress(progressRate, totalTransferredSoFar, totalToTransfer, fileName);
 427             }
 428         }
 429
 430     }
 431
 432     /**
 433      * Upload worker. Performs the pending uploads in the order they were
 434      * requested.
 435      *
 436      * Created with the Looper of a new thread, started in
 437      * {@link FileUploader#onCreate()}.
 438      */
 439     private static class ServiceHandler extends Handler {
 440         // don't make it a final class, and don't remove the static ; lint will
 441         // warn about a possible memory leak
 442         FileUploader mService;
 443
 444         public ServiceHandler(Looper looper, FileUploader service) {
 445             super(looper);
 446             if (service == null)
 447                 throw new IllegalArgumentException("Received invalid NULL in parameter 'service'");
 448             mService = service;
 449         }
 450
 451         @Override
 452         public void handleMessage(Message msg) {
 453             @SuppressWarnings("unchecked")
 454             AbstractList<String> requestedUploads = (AbstractList<String>) msg.obj;
 455             if (msg.obj != null) {
 456                 Iterator<String> it = requestedUploads.iterator();
 457                 while (it.hasNext()) {
 458                     mService.uploadFile(it.next());
 459                 }
 460             }
 461             mService.stopSelf(msg.arg1);
 462         }
 463     }
 464
 465     /**
 466      * Core upload method: sends the file(s) to upload
 467      *
 468      * @param uploadKey Key to access the upload to perform, contained in
 469      *            mPendingUploads
 470      */
 471     public void uploadFile(String uploadKey) {
 472
 473         synchronized (mPendingUploads) {
 474             mCurrentUpload = mPendingUploads.get(uploadKey);
 475         }
 476
 477         if (mCurrentUpload != null) {
 478
 479             notifyUploadStart(mCurrentUpload);
 480
 481             RemoteOperationResult uploadResult = null, grantResult = null;
 482
 483             try {
 484                 /// prepare client object to send requests to the ownCloud server
 485                 if (mUploadClient == null || !mLastAccount.equals(mCurrentUpload.getAccount())) {
 486                     mLastAccount = mCurrentUpload.getAccount();
 487                     mStorageManager = new FileDataStorageManager(mLastAccount, getContentResolver());
 488                     mUploadClient = OwnCloudClientFactory.createOwnCloudClient(mLastAccount, getApplicationContext());
 489                 }
 490
 491                 /// check the existence of the parent folder for the file to upload
 492                 String remoteParentPath = new File(mCurrentUpload.getRemotePath()).getParent();
 493                 remoteParentPath = remoteParentPath.endsWith(OCFile.PATH_SEPARATOR) ? remoteParentPath : remoteParentPath + OCFile.PATH_SEPARATOR;
 494                 grantResult = grantFolderExistence(remoteParentPath);
 495
 496                 /// perform the upload
 497                 if (grantResult.isSuccess()) {
 498                     OCFile parent = mStorageManager.getFileByPath(remoteParentPath);
 499                     mCurrentUpload.getFile().setParentId(parent.getFileId());
 500                     uploadResult = mCurrentUpload.execute(mUploadClient);
 501                     if (uploadResult.isSuccess()) {
 502                         saveUploadedFile();
 503                     }
 504                 } else {
 505                     uploadResult = grantResult;
 506                 }
 507
 508             } catch (AccountsException e) {
 509                 Log_OC.e(TAG, "Error while trying to get autorization for " + mLastAccount.name, e);
 510                 uploadResult = new RemoteOperationResult(e);
 511
 512             } catch (IOException e) {
 513                 Log_OC.e(TAG, "Error while trying to get autorization for " + mLastAccount.name, e);
 514                 uploadResult = new RemoteOperationResult(e);
 515
 516             } finally {
 517                 synchronized (mPendingUploads) {
 518                     mPendingUploads.remove(uploadKey);
 519                     Log_OC.i(TAG, "Remove CurrentUploadItem from pending upload Item Map.");
 520                 }
 521                 if (uploadResult.isException()) {
 522                     // enforce the creation of a new client object for next uploads; this grant that a new socket will
 523                     // be created in the future if the current exception is due to an abrupt lose of network connection
 524                     mUploadClient = null;
 525                 }
 526             }
 527
 528             /// notify result
 529
 530             notifyUploadResult(uploadResult, mCurrentUpload);
 531             sendFinalBroadcast(mCurrentUpload, uploadResult);
 532
 533         }
 534
 535     }
 536
 537     /**
 538      * Checks the existence of the folder where the current file will be uploaded both in the remote server
 539      * and in the local database.
 540      *
 541      * If the upload is set to enforce the creation of the folder, the method tries to create it both remote
 542      * and locally.
 543      *
 544      *  @param  pathToGrant     Full remote path whose existence will be granted.
 545      *  @return  An {@link OCFile} instance corresponding to the folder where the file will be uploaded.
 546      */
 547     private RemoteOperationResult grantFolderExistence(String pathToGrant) {
 548         RemoteOperation operation = new ExistenceCheckRemoteOperation(pathToGrant, this, false);
 549         RemoteOperationResult result = operation.execute(mUploadClient);
 550         if (!result.isSuccess() && result.getCode() == ResultCode.FILE_NOT_FOUND && mCurrentUpload.isRemoteFolderToBeCreated()) {
 551             operation = new CreateFolderOperation( pathToGrant,
 552                     true,
 553                     mStorageManager    );
 554             result = operation.execute(mUploadClient);
 555         }
 556         if (result.isSuccess()) {
 557             OCFile parentDir = mStorageManager.getFileByPath(pathToGrant);
 558             if (parentDir == null) {
 559                 parentDir = createLocalFolder(pathToGrant);
 560             }
 561             if (parentDir != null) {
 562                 result = new RemoteOperationResult(ResultCode.OK);
 563             } else {
 564                 result = new RemoteOperationResult(ResultCode.UNKNOWN_ERROR);
 565             }
 566         }
 567         return result;
 568     }
 569
 570
 571     private OCFile createLocalFolder(String remotePath) {
 572         String parentPath = new File(remotePath).getParent();
 573         parentPath = parentPath.endsWith(OCFile.PATH_SEPARATOR) ? parentPath : parentPath + OCFile.PATH_SEPARATOR;
 574         OCFile parent = mStorageManager.getFileByPath(parentPath);
 575         if (parent == null) {
 576             parent = createLocalFolder(parentPath);
 577         }
 578         if (parent != null) {
 579             OCFile createdFolder = new OCFile(remotePath);
 580             createdFolder.setMimetype("DIR");
 581             createdFolder.setParentId(parent.getFileId());
 582             mStorageManager.saveFile(createdFolder);
 583             return createdFolder;
 584         }
 585         return null;
 586     }
 587
 588
 589     /**
 590      * Saves a OC File after a successful upload.
 591      *
 592      * A PROPFIND is necessary to keep the props in the local database
 593      * synchronized with the server, specially the modification time and Etag
 594      * (where available)
 595      *
 596      * TODO refactor this ugly thing
 597      */
 598     private void saveUploadedFile() {
 599         OCFile file = mCurrentUpload.getFile();
 600         long syncDate = System.currentTimeMillis();
 601         file.setLastSyncDateForData(syncDate);
 602
 603         // new PROPFIND to keep data consistent with server
 604         // in theory, should return the same we already have
 605         ReadRemoteFileOperation operation = new ReadRemoteFileOperation(mCurrentUpload.getRemotePath());
 606         RemoteOperationResult result = operation.execute(mUploadClient);
 607         if (result.isSuccess()) {
 608             updateOCFile(file, (RemoteFile) result.getData().get(0));
 609             file.setLastSyncDateForProperties(syncDate);
 610         }
 611
 612         // / maybe this would be better as part of UploadFileOperation... or
 613         // maybe all this method
 614         if (mCurrentUpload.wasRenamed()) {
 615             OCFile oldFile = mCurrentUpload.getOldFile();
 616             if (oldFile.fileExists()) {
 617                 oldFile.setStoragePath(null);
 618                 mStorageManager.saveFile(oldFile);
 619
 620             } // else: it was just an automatic renaming due to a name
 621               // coincidence; nothing else is needed, the storagePath is right
 622               // in the instance returned by mCurrentUpload.getFile()
 623         }
 624
 625         mStorageManager.saveFile(file);
 626     }
 627
 628     private void updateOCFile(OCFile file, RemoteFile remoteFile) {
 629         file.setCreationTimestamp(remoteFile.getCreationTimestamp());
 630         file.setFileLength(remoteFile.getLength());
 631         file.setMimetype(remoteFile.getMimeType());
 632         file.setModificationTimestamp(remoteFile.getModifiedTimestamp());
 633         file.setModificationTimestampAtLastSyncForData(remoteFile.getModifiedTimestamp());
 634         // file.setEtag(remoteFile.getEtag());    // TODO Etag, where available
 635     }
 636
 637     private OCFile obtainNewOCFileToUpload(String remotePath, String localPath, String mimeType,
 638             FileDataStorageManager storageManager) {
 639         OCFile newFile = new OCFile(remotePath);
 640         newFile.setStoragePath(localPath);
 641         newFile.setLastSyncDateForProperties(0);
 642         newFile.setLastSyncDateForData(0);
 643
 644         // size
 645         if (localPath != null && localPath.length() > 0) {
 646             File localFile = new File(localPath);
 647             newFile.setFileLength(localFile.length());
 648             newFile.setLastSyncDateForData(localFile.lastModified());
 649         } // don't worry about not assigning size, the problems with localPath
 650           // are checked when the UploadFileOperation instance is created
 651
 652         // MIME type
 653         if (mimeType == null || mimeType.length() <= 0) {
 654             try {
 655                 mimeType = MimeTypeMap.getSingleton().getMimeTypeFromExtension(
 656                         remotePath.substring(remotePath.lastIndexOf('.') + 1));
 657             } catch (IndexOutOfBoundsException e) {
 658                 Log_OC.e(TAG, "Trying to find out MIME type of a file without extension: " + remotePath);
 659             }
 660         }
 661         if (mimeType == null) {
 662             mimeType = "application/octet-stream";
 663         }
 664         newFile.setMimetype(mimeType);
 665
 666         return newFile;
 667     }
 668
 669     /**
 670      * Creates a status notification to show the upload progress
 671      *
 672      * @param upload Upload operation starting.
 673      */
 674     @SuppressWarnings("deprecation")
 675     private void notifyUploadStart(UploadFileOperation upload) {
 676         // / create status notification with a progress bar
 677         mLastPercent = 0;
 678         mNotification = new Notification(DisplayUtils.getSeasonalIconId(), getString(R.string.uploader_upload_in_progress_ticker),
 679                 System.currentTimeMillis());
 680         mNotification.flags |= Notification.FLAG_ONGOING_EVENT;
 681         mDefaultNotificationContentView = mNotification.contentView;
 682         mNotification.contentView = new RemoteViews(getApplicationContext().getPackageName(),
 683                 R.layout.progressbar_layout);
 684         mNotification.contentView.setProgressBar(R.id.status_progress, 100, 0, false);
 685         mNotification.contentView.setTextViewText(R.id.status_text,
 686                 String.format(getString(R.string.uploader_upload_in_progress_content), 0, upload.getFileName()));
 687         mNotification.contentView.setImageViewResource(R.id.status_icon, DisplayUtils.getSeasonalIconId());
 688
 689         /// includes a pending intent in the notification showing the details view of the file
 690         Intent showDetailsIntent = new Intent(this, FileDisplayActivity.class);
 691         showDetailsIntent.putExtra(FileActivity.EXTRA_FILE, upload.getFile());
 692         showDetailsIntent.putExtra(FileActivity.EXTRA_ACCOUNT, upload.getAccount());
 693         showDetailsIntent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
 694         mNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(),
 695                 (int) System.currentTimeMillis(), showDetailsIntent, 0);
 696
 697         mNotificationManager.notify(R.string.uploader_upload_in_progress_ticker, mNotification);
 698     }
 699
 700     /**
 701      * Callback method to update the progress bar in the status notification
 702      */
 703     @Override
 704     public void onTransferProgress(long progressRate, long totalTransferredSoFar, long totalToTransfer, String filePath) {
 705         int percent = (int) (100.0 * ((double) totalTransferredSoFar) / ((double) totalToTransfer));
 706         if (percent != mLastPercent) {
 707             mNotification.contentView.setProgressBar(R.id.status_progress, 100, percent, false);
 708             String fileName = filePath.substring(filePath.lastIndexOf(FileUtils.PATH_SEPARATOR) + 1);
 709             String text = String.format(getString(R.string.uploader_upload_in_progress_content), percent, fileName);
 710             mNotification.contentView.setTextViewText(R.id.status_text, text);
 711             mNotificationManager.notify(R.string.uploader_upload_in_progress_ticker, mNotification);
 712         }
 713         mLastPercent = percent;
 714     }
 715
 716     /**
 717      * Updates the status notification with the result of an upload operation.
 718      *
 719      * @param uploadResult Result of the upload operation.
 720      * @param upload Finished upload operation
 721      */
 722     private void notifyUploadResult(RemoteOperationResult uploadResult, UploadFileOperation upload) {
 723         Log_OC.d(TAG, "NotifyUploadResult with resultCode: " + uploadResult.getCode());
 724         if (uploadResult.isCancelled()) {
 725             // / cancelled operation -> silent removal of progress notification
 726             mNotificationManager.cancel(R.string.uploader_upload_in_progress_ticker);
 727
 728         } else if (uploadResult.isSuccess()) {
 729             // / success -> silent update of progress notification to success
 730             // message
 731             mNotification.flags ^= Notification.FLAG_ONGOING_EVENT; // remove
 732                                                                     // the
 733                                                                     // ongoing
 734                                                                     // flag
 735             mNotification.flags |= Notification.FLAG_AUTO_CANCEL;
 736             mNotification.contentView = mDefaultNotificationContentView;
 737
 738             /// includes a pending intent in the notification showing the details view of the file
 739             Intent showDetailsIntent = null;
 740             if (PreviewImageFragment.canBePreviewed(upload.getFile())) {
 741                 showDetailsIntent = new Intent(this, PreviewImageActivity.class);
 742             } else {
 743                 showDetailsIntent = new Intent(this, FileDisplayActivity.class);
 744             }
 745             showDetailsIntent.putExtra(FileActivity.EXTRA_FILE, upload.getFile());
 746             showDetailsIntent.putExtra(FileActivity.EXTRA_ACCOUNT, upload.getAccount());
 747             showDetailsIntent.putExtra(FileActivity.EXTRA_FROM_NOTIFICATION, true);
 748             showDetailsIntent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
 749             mNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(),
 750                     (int) System.currentTimeMillis(), showDetailsIntent, 0);
 751
 752             mNotification.setLatestEventInfo(getApplicationContext(),
 753                     getString(R.string.uploader_upload_succeeded_ticker),
 754                     String.format(getString(R.string.uploader_upload_succeeded_content_single), upload.getFileName()),
 755                     mNotification.contentIntent);
 756
 757             mNotificationManager.notify(R.string.uploader_upload_in_progress_ticker, mNotification); // NOT
 758                                                                                                      // AN
 759             DbHandler db = new DbHandler(this.getBaseContext());
 760             db.removeIUPendingFile(mCurrentUpload.getOriginalStoragePath());
 761             db.close();
 762
 763         } else {
 764
 765             // / fail -> explicit failure notification
 766             mNotificationManager.cancel(R.string.uploader_upload_in_progress_ticker);
 767             Notification finalNotification = new Notification(DisplayUtils.getSeasonalIconId(),
 768                     getString(R.string.uploader_upload_failed_ticker), System.currentTimeMillis());
 769             finalNotification.flags |= Notification.FLAG_AUTO_CANCEL;
 770             String content = null;
 771
 772             boolean needsToUpdateCredentials = (uploadResult.getCode() == ResultCode.UNAUTHORIZED ||
 773                     //(uploadResult.isTemporalRedirection() && uploadResult.isIdPRedirection() &&
 774                     (uploadResult.isIdPRedirection() &&
 775                             mUploadClient.getCredentials() == null));
 776                             //MainApp.getAuthTokenTypeSamlSessionCookie().equals(mUploadClient.getAuthTokenType())));
 777             if (needsToUpdateCredentials) {
 778                 // let the user update credentials with one click
 779                 Intent updateAccountCredentials = new Intent(this, AuthenticatorActivity.class);
 780                 updateAccountCredentials.putExtra(AuthenticatorActivity.EXTRA_ACCOUNT, upload.getAccount());
 781                 updateAccountCredentials.putExtra(AuthenticatorActivity.EXTRA_ENFORCED_UPDATE, true);
 782                 updateAccountCredentials.putExtra(AuthenticatorActivity.EXTRA_ACTION, AuthenticatorActivity.ACTION_UPDATE_TOKEN);
 783                 updateAccountCredentials.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
 784                 updateAccountCredentials.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
 785                 updateAccountCredentials.addFlags(Intent.FLAG_FROM_BACKGROUND);
 786                 finalNotification.contentIntent = PendingIntent.getActivity(this, (int)System.currentTimeMillis(), updateAccountCredentials, PendingIntent.FLAG_ONE_SHOT);
 787                 content =  String.format(getString(R.string.uploader_upload_failed_content_single), upload.getFileName());
 788                 finalNotification.setLatestEventInfo(getApplicationContext(),
 789                         getString(R.string.uploader_upload_failed_ticker), content, finalNotification.contentIntent);
 790                 mUploadClient = null;   // grant that future retries on the same account will get the fresh credentials
 791             } else {
 792                 // TODO put something smart in the contentIntent below
 793             //    finalNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(), (int)System.currentTimeMillis(), new Intent(), 0);
 794             //}
 795
 796                 if (uploadResult.getCode() == ResultCode.LOCAL_STORAGE_FULL
 797                         || uploadResult.getCode() == ResultCode.LOCAL_STORAGE_NOT_COPIED) {
 798                     // TODO we need a class to provide error messages for the users
 799                     // from a RemoteOperationResult and a RemoteOperation
 800                     content = String.format(getString(R.string.error__upload__local_file_not_copied), upload.getFileName(),
 801                             getString(R.string.app_name));
 802                 } else if (uploadResult.getCode() == ResultCode.QUOTA_EXCEEDED) {
 803                     content = getString(R.string.failed_upload_quota_exceeded_text);
 804                 } else {
 805                     content = String
 806                             .format(getString(R.string.uploader_upload_failed_content_single), upload.getFileName());
 807                 }
 808
 809                 // we add only for instant-uploads the InstantUploadActivity and the
 810                 // db entry
 811                 Intent detailUploadIntent = null;
 812                 if (upload.isInstant() && InstantUploadActivity.IS_ENABLED) {
 813                     detailUploadIntent = new Intent(this, InstantUploadActivity.class);
 814                     detailUploadIntent.putExtra(FileUploader.KEY_ACCOUNT, upload.getAccount());
 815                 } else {
 816                     detailUploadIntent = new Intent(this, FailedUploadActivity.class);
 817                     detailUploadIntent.putExtra(FailedUploadActivity.MESSAGE, content);
 818                 }
 819                 finalNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(),
 820                         (int) System.currentTimeMillis(), detailUploadIntent, PendingIntent.FLAG_UPDATE_CURRENT
 821                         | PendingIntent.FLAG_ONE_SHOT);
 822
 823                 if (upload.isInstant()) {
 824                     DbHandler db = null;
 825                     try {
 826                         db = new DbHandler(this.getBaseContext());
 827                         String message = uploadResult.getLogMessage() + " errorCode: " + uploadResult.getCode();
 828                         Log_OC.e(TAG, message + " Http-Code: " + uploadResult.getHttpCode());
 829                         if (uploadResult.getCode() == ResultCode.QUOTA_EXCEEDED) {
 830                             message = getString(R.string.failed_upload_quota_exceeded_text);
 831                             if (db.updateFileState(upload.getOriginalStoragePath(), DbHandler.UPLOAD_STATUS_UPLOAD_FAILED,
 832                                     message) == 0) {
 833                                 db.putFileForLater(upload.getOriginalStoragePath(), upload.getAccount().name, message);
 834                             }
 835                         }
 836                     } finally {
 837                         if (db != null) {
 838                             db.close();
 839                         }
 840                     }
 841                 }
 842             }
 843             finalNotification.setLatestEventInfo(getApplicationContext(),
 844                     getString(R.string.uploader_upload_failed_ticker), content, finalNotification.contentIntent);
 845
 846             mNotificationManager.notify(R.string.uploader_upload_failed_ticker, finalNotification);
 847         }
 848
 849     }
 850
 851     /**
 852      * Sends a broadcast in order to the interested activities can update their
 853      * view
 854      *
 855      * @param upload Finished upload operation
 856      * @param uploadResult Result of the upload operation
 857      */
 858     private void sendFinalBroadcast(UploadFileOperation upload, RemoteOperationResult uploadResult) {
 859         Intent end = new Intent(getUploadFinishMessage());
 860         end.putExtra(EXTRA_REMOTE_PATH, upload.getRemotePath()); // real remote
 861                                                                  // path, after
 862                                                                  // possible
 863                                                                  // automatic
 864                                                                  // renaming
 865         if (upload.wasRenamed()) {
 866             end.putExtra(EXTRA_OLD_REMOTE_PATH, upload.getOldFile().getRemotePath());
 867         }
 868         end.putExtra(EXTRA_OLD_FILE_PATH, upload.getOriginalStoragePath());
 869         end.putExtra(ACCOUNT_NAME, upload.getAccount().name);
 870         end.putExtra(EXTRA_UPLOAD_RESULT, uploadResult.isSuccess());
 871         sendStickyBroadcast(end);
 872     }
 873
 874 }