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