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