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