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