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