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