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