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