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