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