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