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.MultiStatus;
  33 import org.apache.jackrabbit.webdav.client.methods.PropFindMethod;
  34
  35 import com.owncloud.android.authentication.AccountAuthenticator;
  36 import com.owncloud.android.authentication.AuthenticatorActivity;
  37 import com.owncloud.android.datamodel.FileDataStorageManager;
  38 import com.owncloud.android.datamodel.OCFile;
  39 import com.owncloud.android.operations.ChunkedUploadFileOperation;
  40 import com.owncloud.android.operations.CreateFolderOperation;
  41 import com.owncloud.android.operations.ExistenceCheckOperation;
  42 import com.owncloud.android.operations.RemoteOperation;
  43 import com.owncloud.android.operations.RemoteOperationResult;
  44 import com.owncloud.android.operations.UploadFileOperation;
  45 import com.owncloud.android.operations.RemoteOperationResult.ResultCode;
  46 import com.owncloud.android.utils.OwnCloudVersion;
  47
  48 import eu.alefzero.webdav.OnDatatransferProgressListener;
  49 import eu.alefzero.webdav.WebdavEntry;
  50 import eu.alefzero.webdav.WebdavUtils;
  51
  52 import com.owncloud.android.network.OwnCloudClientUtils;
  53
  54 import android.accounts.Account;
  55 import android.accounts.AccountManager;
  56 import android.accounts.AccountsException;
  57 import android.app.Notification;
  58 import android.app.NotificationManager;
  59 import android.app.PendingIntent;
  60 import android.app.Service;
  61 import android.content.Intent;
  62 import android.os.Binder;
  63 import android.os.Handler;
  64 import android.os.HandlerThread;
  65 import android.os.IBinder;
  66 import android.os.Looper;
  67 import android.os.Message;
  68 import android.os.Process;
  69 import android.webkit.MimeTypeMap;
  70 import android.widget.RemoteViews;
  71
  72 import com.owncloud.android.Log_OC;
  73 import com.owncloud.android.R;
  74 import com.owncloud.android.db.DbHandler;
  75 import com.owncloud.android.ui.activity.FailedUploadActivity;
  76 import com.owncloud.android.ui.activity.FileActivity;
  77 import com.owncloud.android.ui.activity.FileDisplayActivity;
  78 import com.owncloud.android.ui.activity.InstantUploadActivity;
  79 import com.owncloud.android.ui.preview.PreviewImageActivity;
  80 import com.owncloud.android.ui.preview.PreviewImageFragment;
  81
  82 import eu.alefzero.webdav.WebdavClient;
  83
  84 public class FileUploader extends Service implements OnDatatransferProgressListener {
  85
  86     public static final String UPLOAD_FINISH_MESSAGE = "UPLOAD_FINISH";
  87     public static final String EXTRA_UPLOAD_RESULT = "RESULT";
  88     public static final String EXTRA_REMOTE_PATH = "REMOTE_PATH";
  89     public static final String EXTRA_OLD_REMOTE_PATH = "OLD_REMOTE_PATH";
  90     public static final String EXTRA_OLD_FILE_PATH = "OLD_FILE_PATH";
  91     public static final String ACCOUNT_NAME = "ACCOUNT_NAME";
  92
  93     public static final String KEY_FILE = "FILE";
  94     public static final String KEY_LOCAL_FILE = "LOCAL_FILE";
  95     public static final String KEY_REMOTE_FILE = "REMOTE_FILE";
  96     public static final String KEY_MIME_TYPE = "MIME_TYPE";
  97
  98     public static final String KEY_ACCOUNT = "ACCOUNT";
  99
 100     public static final String KEY_UPLOAD_TYPE = "UPLOAD_TYPE";
 101     public static final String KEY_FORCE_OVERWRITE = "KEY_FORCE_OVERWRITE";
 102     public static final String KEY_INSTANT_UPLOAD = "INSTANT_UPLOAD";
 103     public static final String KEY_LOCAL_BEHAVIOUR = "BEHAVIOUR";
 104
 105     public static final int LOCAL_BEHAVIOUR_COPY = 0;
 106     public static final int LOCAL_BEHAVIOUR_MOVE = 1;
 107     public static final int LOCAL_BEHAVIOUR_FORGET = 2;
 108
 109     public static final int UPLOAD_SINGLE_FILE = 0;
 110     public static final int UPLOAD_MULTIPLE_FILES = 1;
 111
 112     private static final String TAG = FileUploader.class.getSimpleName();
 113
 114     private Looper mServiceLooper;
 115     private ServiceHandler mServiceHandler;
 116     private IBinder mBinder;
 117     private WebdavClient mUploadClient = null;
 118     private Account mLastAccount = null;
 119     private FileDataStorageManager mStorageManager;
 120
 121     private ConcurrentMap<String, UploadFileOperation> mPendingUploads = new ConcurrentHashMap<String, UploadFileOperation>();
 122     private UploadFileOperation mCurrentUpload = null;
 123
 124     private NotificationManager mNotificationManager;
 125     private Notification mNotification;
 126     private int mLastPercent;
 127     private RemoteViews mDefaultNotificationContentView;
 128
 129     /**
 130      * Builds a key for mPendingUploads from the account and file to upload
 131      *
 132      * @param account   Account where the file to upload is stored
 133      * @param file      File to upload
 134      */
 135     private String buildRemoteName(Account account, OCFile file) {
 136         return account.name + file.getRemotePath();
 137     }
 138
 139     private String buildRemoteName(Account account, String remotePath) {
 140         return account.name + remotePath;
 141     }
 142
 143     /**
 144      * Checks if an ownCloud server version should support chunked uploads.
 145      *
 146      * @param version OwnCloud version instance corresponding to an ownCloud
 147      *            server.
 148      * @return 'True' if the ownCloud server with version supports chunked
 149      *         uploads.
 150      */
 151     private static boolean chunkedUploadIsSupported(OwnCloudVersion version) {
 152         return (version != null && version.compareTo(OwnCloudVersion.owncloud_v4_5) >= 0);
 153     }
 154
 155     /**
 156      * Service initialization
 157      */
 158     @Override
 159     public void onCreate() {
 160         super.onCreate();
 161         Log_OC.i(TAG, "mPendingUploads size:" + mPendingUploads.size());
 162         mNotificationManager = (NotificationManager) getSystemService(NOTIFICATION_SERVICE);
 163         HandlerThread thread = new HandlerThread("FileUploaderThread", Process.THREAD_PRIORITY_BACKGROUND);
 164         thread.start();
 165         mServiceLooper = thread.getLooper();
 166         mServiceHandler = new ServiceHandler(mServiceLooper, this);
 167         mBinder = new FileUploaderBinder();
 168     }
 169
 170     /**
 171      * Entry point to add one or several files to the queue of uploads.
 172      *
 173      * New uploads are added calling to startService(), resulting in a call to
 174      * this method. This ensures the service will keep on working although the
 175      * caller activity goes away.
 176      */
 177     @Override
 178     public int onStartCommand(Intent intent, int flags, int startId) {
 179         if (!intent.hasExtra(KEY_ACCOUNT) || !intent.hasExtra(KEY_UPLOAD_TYPE)
 180                 || !(intent.hasExtra(KEY_LOCAL_FILE) || intent.hasExtra(KEY_FILE))) {
 181             Log_OC.e(TAG, "Not enough information provided in intent");
 182             return Service.START_NOT_STICKY;
 183         }
 184         int uploadType = intent.getIntExtra(KEY_UPLOAD_TYPE, -1);
 185         if (uploadType == -1) {
 186             Log_OC.e(TAG, "Incorrect upload type provided");
 187             return Service.START_NOT_STICKY;
 188         }
 189         Account account = intent.getParcelableExtra(KEY_ACCOUNT);
 190
 191         String[] localPaths = null, remotePaths = null, mimeTypes = null;
 192         OCFile[] files = null;
 193         if (uploadType == UPLOAD_SINGLE_FILE) {
 194
 195             if (intent.hasExtra(KEY_FILE)) {
 196                 files = new OCFile[] { intent.getParcelableExtra(KEY_FILE) };
 197
 198             } else {
 199                 localPaths = new String[] { intent.getStringExtra(KEY_LOCAL_FILE) };
 200                 remotePaths = new String[] { intent.getStringExtra(KEY_REMOTE_FILE) };
 201                 mimeTypes = new String[] { intent.getStringExtra(KEY_MIME_TYPE) };
 202             }
 203
 204         } else { // mUploadType == UPLOAD_MULTIPLE_FILES
 205
 206             if (intent.hasExtra(KEY_FILE)) {
 207                 files = (OCFile[]) intent.getParcelableArrayExtra(KEY_FILE); // TODO
 208                                                                              // will
 209                                                                              // this
 210                                                                              // casting
 211                                                                              // work
 212                                                                              // fine?
 213
 214             } else {
 215                 localPaths = intent.getStringArrayExtra(KEY_LOCAL_FILE);
 216                 remotePaths = intent.getStringArrayExtra(KEY_REMOTE_FILE);
 217                 mimeTypes = intent.getStringArrayExtra(KEY_MIME_TYPE);
 218             }
 219         }
 220
 221         FileDataStorageManager storageManager = new FileDataStorageManager(account, getContentResolver());
 222
 223         boolean forceOverwrite = intent.getBooleanExtra(KEY_FORCE_OVERWRITE, false);
 224         boolean isInstant = intent.getBooleanExtra(KEY_INSTANT_UPLOAD, false);
 225         int localAction = intent.getIntExtra(KEY_LOCAL_BEHAVIOUR, LOCAL_BEHAVIOUR_COPY);
 226
 227         if (intent.hasExtra(KEY_FILE) && files == null) {
 228             Log_OC.e(TAG, "Incorrect array for OCFiles provided in upload intent");
 229             return Service.START_NOT_STICKY;
 230
 231         } else if (!intent.hasExtra(KEY_FILE)) {
 232             if (localPaths == null) {
 233                 Log_OC.e(TAG, "Incorrect array for local paths provided in upload intent");
 234                 return Service.START_NOT_STICKY;
 235             }
 236             if (remotePaths == null) {
 237                 Log_OC.e(TAG, "Incorrect array for remote paths provided in upload intent");
 238                 return Service.START_NOT_STICKY;
 239             }
 240             if (localPaths.length != remotePaths.length) {
 241                 Log_OC.e(TAG, "Different number of remote paths and local paths!");
 242                 return Service.START_NOT_STICKY;
 243             }
 244
 245             files = new OCFile[localPaths.length];
 246             for (int i = 0; i < localPaths.length; i++) {
 247                 files[i] = obtainNewOCFileToUpload(remotePaths[i], localPaths[i], ((mimeTypes != null) ? mimeTypes[i]
 248                         : (String) null), storageManager);
 249                 if (files[i] == null) {
 250                     // TODO @andomaex add failure Notiification
 251                     return Service.START_NOT_STICKY;
 252                 }
 253             }
 254         }
 255
 256         OwnCloudVersion ocv = new OwnCloudVersion(AccountManager.get(this).getUserData(account,
 257                 AccountAuthenticator.KEY_OC_VERSION));
 258         boolean chunked = FileUploader.chunkedUploadIsSupported(ocv);
 259         AbstractList<String> requestedUploads = new Vector<String>();
 260         String uploadKey = null;
 261         UploadFileOperation newUpload = null;
 262         try {
 263             for (int i = 0; i < files.length; i++) {
 264                 uploadKey = buildRemoteName(account, files[i].getRemotePath());
 265                 if (chunked) {
 266                     newUpload = new ChunkedUploadFileOperation(account, files[i], isInstant, forceOverwrite,
 267                             localAction);
 268                 } else {
 269                     newUpload = new UploadFileOperation(account, files[i], isInstant, forceOverwrite, localAction);
 270                 }
 271                 if (isInstant) {
 272                     newUpload.setRemoteFolderToBeCreated();
 273                 }
 274                 mPendingUploads.putIfAbsent(uploadKey, newUpload);
 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.isDirectory()) {
 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 = OwnCloudClientUtils.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 ExistenceCheckOperation(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()
 619                     + WebdavUtils.encodePath(mCurrentUpload.getRemotePath()));
 620             int status = mUploadClient.executeMethod(propfind);
 621             boolean isMultiStatus = (status == HttpStatus.SC_MULTI_STATUS);
 622             if (isMultiStatus) {
 623                 MultiStatus resp = propfind.getResponseBodyAsMultiStatus();
 624                 WebdavEntry we = new WebdavEntry(resp.getResponses()[0], mUploadClient.getBaseUri().getPath());
 625                 updateOCFile(file, we);
 626                 file.setLastSyncDateForProperties(syncDate);
 627
 628             } else {
 629                 mUploadClient.exhaustResponse(propfind.getResponseBodyAsStream());
 630             }
 631
 632             result = new RemoteOperationResult(isMultiStatus, status, propfind.getResponseHeaders());
 633             Log_OC.i(TAG, "Update: synchronizing properties for uploaded " + mCurrentUpload.getRemotePath() + ": "
 634                     + result.getLogMessage());
 635
 636         } catch (Exception e) {
 637             result = new RemoteOperationResult(e);
 638             Log_OC.e(TAG, "Update: synchronizing properties for uploaded " + mCurrentUpload.getRemotePath() + ": "
 639                     + result.getLogMessage(), e);
 640
 641         } finally {
 642             if (propfind != null)
 643                 propfind.releaseConnection();
 644         }
 645
 646         // / maybe this would be better as part of UploadFileOperation... or
 647         // maybe all this method
 648         if (mCurrentUpload.wasRenamed()) {
 649             OCFile oldFile = mCurrentUpload.getOldFile();
 650             if (oldFile.fileExists()) {
 651                 oldFile.setStoragePath(null);
 652                 mStorageManager.saveFile(oldFile);
 653
 654             } // else: it was just an automatic renaming due to a name
 655               // coincidence; nothing else is needed, the storagePath is right
 656               // in the instance returned by mCurrentUpload.getFile()
 657         }
 658
 659         mStorageManager.saveFile(file);
 660     }
 661
 662     private void updateOCFile(OCFile file, WebdavEntry we) {
 663         file.setCreationTimestamp(we.createTimestamp());
 664         file.setFileLength(we.contentLength());
 665         file.setMimetype(we.contentType());
 666         file.setModificationTimestamp(we.modifiedTimestamp());
 667         file.setModificationTimestampAtLastSyncForData(we.modifiedTimestamp());
 668         // file.setEtag(mCurrentUpload.getEtag());    // TODO Etag, where available
 669     }
 670
 671     private OCFile obtainNewOCFileToUpload(String remotePath, String localPath, String mimeType,
 672             FileDataStorageManager storageManager) {
 673         OCFile newFile = new OCFile(remotePath);
 674         newFile.setStoragePath(localPath);
 675         newFile.setLastSyncDateForProperties(0);
 676         newFile.setLastSyncDateForData(0);
 677
 678         // size
 679         if (localPath != null && localPath.length() > 0) {
 680             File localFile = new File(localPath);
 681             newFile.setFileLength(localFile.length());
 682             newFile.setLastSyncDateForData(localFile.lastModified());
 683         } // don't worry about not assigning size, the problems with localPath
 684           // are checked when the UploadFileOperation instance is created
 685
 686         // MIME type
 687         if (mimeType == null || mimeType.length() <= 0) {
 688             try {
 689                 mimeType = MimeTypeMap.getSingleton().getMimeTypeFromExtension(
 690                         remotePath.substring(remotePath.lastIndexOf('.') + 1));
 691             } catch (IndexOutOfBoundsException e) {
 692                 Log_OC.e(TAG, "Trying to find out MIME type of a file without extension: " + remotePath);
 693             }
 694         }
 695         if (mimeType == null) {
 696             mimeType = "application/octet-stream";
 697         }
 698         newFile.setMimetype(mimeType);
 699
 700         return newFile;
 701     }
 702
 703     /**
 704      * Creates a status notification to show the upload progress
 705      *
 706      * @param upload Upload operation starting.
 707      */
 708     @SuppressWarnings("deprecation")
 709     private void notifyUploadStart(UploadFileOperation upload) {
 710         // / create status notification with a progress bar
 711         mLastPercent = 0;
 712         mNotification = new Notification(R.drawable.icon, getString(R.string.uploader_upload_in_progress_ticker),
 713                 System.currentTimeMillis());
 714         mNotification.flags |= Notification.FLAG_ONGOING_EVENT;
 715         mDefaultNotificationContentView = mNotification.contentView;
 716         mNotification.contentView = new RemoteViews(getApplicationContext().getPackageName(),
 717                 R.layout.progressbar_layout);
 718         mNotification.contentView.setProgressBar(R.id.status_progress, 100, 0, false);
 719         mNotification.contentView.setTextViewText(R.id.status_text,
 720                 String.format(getString(R.string.uploader_upload_in_progress_content), 0, upload.getFileName()));
 721         mNotification.contentView.setImageViewResource(R.id.status_icon, R.drawable.icon);
 722
 723         /// includes a pending intent in the notification showing the details view of the file
 724         Intent showDetailsIntent = null;
 725         if (PreviewImageFragment.canBePreviewed(upload.getFile())) {
 726             showDetailsIntent = new Intent(this, PreviewImageActivity.class);
 727         } else {
 728             showDetailsIntent = new Intent(this, FileDisplayActivity.class);
 729         }
 730         showDetailsIntent.putExtra(FileActivity.EXTRA_FILE, upload.getFile());
 731         showDetailsIntent.putExtra(FileActivity.EXTRA_ACCOUNT, upload.getAccount());
 732         showDetailsIntent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
 733         mNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(),
 734                 (int) System.currentTimeMillis(), showDetailsIntent, 0);
 735
 736         mNotificationManager.notify(R.string.uploader_upload_in_progress_ticker, mNotification);
 737     }
 738
 739     /**
 740      * Callback method to update the progress bar in the status notification
 741      */
 742     @Override
 743     public void onTransferProgress(long progressRate, long totalTransferredSoFar, long totalToTransfer, String fileName) {
 744         int percent = (int) (100.0 * ((double) totalTransferredSoFar) / ((double) totalToTransfer));
 745         if (percent != mLastPercent) {
 746             mNotification.contentView.setProgressBar(R.id.status_progress, 100, percent, false);
 747             String text = String.format(getString(R.string.uploader_upload_in_progress_content), percent, fileName);
 748             mNotification.contentView.setTextViewText(R.id.status_text, text);
 749             mNotificationManager.notify(R.string.uploader_upload_in_progress_ticker, mNotification);
 750         }
 751         mLastPercent = percent;
 752     }
 753
 754     /**
 755      * Callback method to update the progress bar in the status notification
 756      * (old version)
 757      */
 758     @Override
 759     public void onTransferProgress(long progressRate) {
 760         // NOTHING TO DO HERE ANYMORE
 761     }
 762
 763     /**
 764      * Updates the status notification with the result of an upload operation.
 765      *
 766      * @param uploadResult Result of the upload operation.
 767      * @param upload Finished upload operation
 768      */
 769     private void notifyUploadResult(RemoteOperationResult uploadResult, UploadFileOperation upload) {
 770         Log_OC.d(TAG, "NotifyUploadResult with resultCode: " + uploadResult.getCode());
 771         if (uploadResult.isCancelled()) {
 772             // / cancelled operation -> silent removal of progress notification
 773             mNotificationManager.cancel(R.string.uploader_upload_in_progress_ticker);
 774
 775         } else if (uploadResult.isSuccess()) {
 776             // / success -> silent update of progress notification to success
 777             // message
 778             mNotification.flags ^= Notification.FLAG_ONGOING_EVENT; // remove
 779                                                                     // the
 780                                                                     // ongoing
 781                                                                     // flag
 782             mNotification.flags |= Notification.FLAG_AUTO_CANCEL;
 783             mNotification.contentView = mDefaultNotificationContentView;
 784
 785             /// includes a pending intent in the notification showing the details view of the file
 786             Intent showDetailsIntent = null;
 787             if (PreviewImageFragment.canBePreviewed(upload.getFile())) {
 788                 showDetailsIntent = new Intent(this, PreviewImageActivity.class);
 789             } else {
 790                 showDetailsIntent = new Intent(this, FileDisplayActivity.class);
 791             }
 792             showDetailsIntent.putExtra(FileActivity.EXTRA_FILE, upload.getFile());
 793             showDetailsIntent.putExtra(FileActivity.EXTRA_ACCOUNT, upload.getAccount());
 794             showDetailsIntent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
 795             mNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(),
 796                     (int) System.currentTimeMillis(), showDetailsIntent, 0);
 797
 798             mNotification.setLatestEventInfo(getApplicationContext(),
 799                     getString(R.string.uploader_upload_succeeded_ticker),
 800                     String.format(getString(R.string.uploader_upload_succeeded_content_single), upload.getFileName()),
 801                     mNotification.contentIntent);
 802
 803             mNotificationManager.notify(R.string.uploader_upload_in_progress_ticker, mNotification); // NOT
 804                                                                                                      // AN
 805             DbHandler db = new DbHandler(this.getBaseContext());
 806             db.removeIUPendingFile(mCurrentUpload.getOriginalStoragePath());
 807             db.close();
 808
 809         } else {
 810
 811             // / fail -> explicit failure notification
 812             mNotificationManager.cancel(R.string.uploader_upload_in_progress_ticker);
 813             Notification finalNotification = new Notification(R.drawable.icon,
 814                     getString(R.string.uploader_upload_failed_ticker), System.currentTimeMillis());
 815             finalNotification.flags |= Notification.FLAG_AUTO_CANCEL;
 816             String content = null;
 817
 818             boolean needsToUpdateCredentials = (uploadResult.getCode() == ResultCode.UNAUTHORIZED ||
 819                     //(uploadResult.isTemporalRedirection() && uploadResult.isIdPRedirection() &&
 820                     (uploadResult.isIdPRedirection() &&
 821                             AccountAuthenticator.AUTH_TOKEN_TYPE_SAML_WEB_SSO_SESSION_COOKIE.equals(mUploadClient.getAuthTokenType())));
 822             if (needsToUpdateCredentials) {
 823                 // let the user update credentials with one click
 824                 Intent updateAccountCredentials = new Intent(this, AuthenticatorActivity.class);
 825                 updateAccountCredentials.putExtra(AuthenticatorActivity.EXTRA_ACCOUNT, upload.getAccount());
 826                 updateAccountCredentials.putExtra(AuthenticatorActivity.EXTRA_ENFORCED_UPDATE, true);
 827                 updateAccountCredentials.putExtra(AuthenticatorActivity.EXTRA_ACTION, AuthenticatorActivity.ACTION_UPDATE_TOKEN);
 828                 updateAccountCredentials.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
 829                 updateAccountCredentials.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
 830                 updateAccountCredentials.addFlags(Intent.FLAG_FROM_BACKGROUND);
 831                 finalNotification.contentIntent = PendingIntent.getActivity(this, (int)System.currentTimeMillis(), updateAccountCredentials, PendingIntent.FLAG_ONE_SHOT);
 832                 content =  String.format(getString(R.string.uploader_upload_failed_content_single), upload.getFileName());
 833                 finalNotification.setLatestEventInfo(getApplicationContext(),
 834                         getString(R.string.uploader_upload_failed_ticker), content, finalNotification.contentIntent);
 835                 mUploadClient = null;   // grant that future retries on the same account will get the fresh credentials
 836             } else {
 837                 // TODO put something smart in the contentIntent below
 838             //    finalNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(), (int)System.currentTimeMillis(), new Intent(), 0);
 839             //}
 840
 841                 if (uploadResult.getCode() == ResultCode.LOCAL_STORAGE_FULL
 842                         || uploadResult.getCode() == ResultCode.LOCAL_STORAGE_NOT_COPIED) {
 843                     // TODO we need a class to provide error messages for the users
 844                     // from a RemoteOperationResult and a RemoteOperation
 845                     content = String.format(getString(R.string.error__upload__local_file_not_copied), upload.getFileName(),
 846                             getString(R.string.app_name));
 847                 } else if (uploadResult.getCode() == ResultCode.QUOTA_EXCEEDED) {
 848                     content = getString(R.string.failed_upload_quota_exceeded_text);
 849                 } else {
 850                     content = String
 851                             .format(getString(R.string.uploader_upload_failed_content_single), upload.getFileName());
 852                 }
 853
 854                 // we add only for instant-uploads the InstantUploadActivity and the
 855                 // db entry
 856                 Intent detailUploadIntent = null;
 857                 if (upload.isInstant() && InstantUploadActivity.IS_ENABLED) {
 858                     detailUploadIntent = new Intent(this, InstantUploadActivity.class);
 859                     detailUploadIntent.putExtra(FileUploader.KEY_ACCOUNT, upload.getAccount());
 860                 } else {
 861                     detailUploadIntent = new Intent(this, FailedUploadActivity.class);
 862                     detailUploadIntent.putExtra(FailedUploadActivity.MESSAGE, content);
 863                 }
 864                 finalNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(),
 865                         (int) System.currentTimeMillis(), detailUploadIntent, PendingIntent.FLAG_UPDATE_CURRENT
 866                         | PendingIntent.FLAG_ONE_SHOT);
 867
 868                 if (upload.isInstant()) {
 869                     DbHandler db = null;
 870                     try {
 871                         db = new DbHandler(this.getBaseContext());
 872                         String message = uploadResult.getLogMessage() + " errorCode: " + uploadResult.getCode();
 873                         Log_OC.e(TAG, message + " Http-Code: " + uploadResult.getHttpCode());
 874                         if (uploadResult.getCode() == ResultCode.QUOTA_EXCEEDED) {
 875                             message = getString(R.string.failed_upload_quota_exceeded_text);
 876                             if (db.updateFileState(upload.getOriginalStoragePath(), DbHandler.UPLOAD_STATUS_UPLOAD_FAILED,
 877                                     message) == 0) {
 878                                 db.putFileForLater(upload.getOriginalStoragePath(), upload.getAccount().name, message);
 879                             }
 880                         }
 881                     } finally {
 882                         if (db != null) {
 883                             db.close();
 884                         }
 885                     }
 886                 }
 887             }
 888             finalNotification.setLatestEventInfo(getApplicationContext(),
 889                     getString(R.string.uploader_upload_failed_ticker), content, finalNotification.contentIntent);
 890
 891             mNotificationManager.notify(R.string.uploader_upload_failed_ticker, finalNotification);
 892         }
 893
 894     }
 895
 896     /**
 897      * Sends a broadcast in order to the interested activities can update their
 898      * view
 899      *
 900      * @param upload Finished upload operation
 901      * @param uploadResult Result of the upload operation
 902      */
 903     private void sendFinalBroadcast(UploadFileOperation upload, RemoteOperationResult uploadResult) {
 904         Intent end = new Intent(UPLOAD_FINISH_MESSAGE);
 905         end.putExtra(EXTRA_REMOTE_PATH, upload.getRemotePath()); // real remote
 906                                                                  // path, after
 907                                                                  // possible
 908                                                                  // automatic
 909                                                                  // renaming
 910         if (upload.wasRenamed()) {
 911             end.putExtra(EXTRA_OLD_REMOTE_PATH, upload.getOldFile().getRemotePath());
 912         }
 913         end.putExtra(EXTRA_OLD_FILE_PATH, upload.getOriginalStoragePath());
 914         end.putExtra(ACCOUNT_NAME, upload.getAccount().name);
 915         end.putExtra(EXTRA_UPLOAD_RESULT, uploadResult.isSuccess());
 916         sendStickyBroadcast(end);
 917     }
 918
 919 }