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