Improved cancellation of downloads: fast abort of operation and fixed thread synchron...
[pub/Android/ownCloud.git] / src / com / owncloud / android / files / services / FileDownloader.java
index d88dbb0..4969c90 100644 (file)
@@ -1,17 +1,20 @@
 package com.owncloud.android.files.services;\r
 \r
 import java.io.File;\r
-import java.util.Collections;\r
-import java.util.HashMap;\r
-import java.util.Map;\r
+import java.util.AbstractList;\r
+import java.util.Iterator;\r
+import java.util.Vector;\r
+import java.util.concurrent.ConcurrentHashMap;\r
+import java.util.concurrent.ConcurrentMap;\r
 \r
-import com.owncloud.android.authenticator.AccountAuthenticator;\r
 import com.owncloud.android.db.ProviderMeta.ProviderTableMeta;\r
 import eu.alefzero.webdav.OnDatatransferProgressListener;\r
-import com.owncloud.android.utils.OwnCloudClientUtils;\r
+\r
+import com.owncloud.android.network.OwnCloudClientUtils;\r
+import com.owncloud.android.operations.DownloadFileOperation;\r
+import com.owncloud.android.operations.RemoteOperationResult;\r
 \r
 import android.accounts.Account;\r
-import android.accounts.AccountManager;\r
 import android.app.Notification;\r
 import android.app.NotificationManager;\r
 import android.app.PendingIntent;\r
@@ -19,6 +22,7 @@ import android.app.Service;
 import android.content.ContentValues;\r
 import android.content.Intent;\r
 import android.net.Uri;\r
+import android.os.Binder;\r
 import android.os.Environment;\r
 import android.os.Handler;\r
 import android.os.HandlerThread;\r
@@ -42,28 +46,19 @@ public class FileDownloader extends Service implements OnDatatransferProgressLis
     \r
     private static final String TAG = "FileDownloader";\r
 \r
-    private NotificationManager mNotificationMngr;\r
     private Looper mServiceLooper;\r
     private ServiceHandler mServiceHandler;\r
-    private Account mAccount;\r
-    private String mFilePath;\r
-    private String mRemotePath;\r
-    private int mLastPercent;\r
-    private long mTotalDownloadSize;\r
-    private long mCurrentDownloadSize;\r
-    private Notification mNotification;\r
+    private IBinder mBinder;\r
+    private WebdavClient mDownloadClient = null;\r
+    private Account mLastAccount = null;\r
     \r
-    /**\r
-     * Static map with the files being download and the path to the temporal file were are download\r
-     */\r
-    private static Map<String, String> mDownloadsInProgress = Collections.synchronizedMap(new HashMap<String, String>());\r
+    private ConcurrentMap<String, DownloadFileOperation> mPendingDownloads = new ConcurrentHashMap<String, DownloadFileOperation>();\r
+    private DownloadFileOperation mCurrentDownload = null;\r
+    \r
+    private NotificationManager mNotificationMngr;\r
+    private Notification mNotification;\r
+    private int mLastPercent;\r
     \r
-    /**\r
-     * Returns True when the file referred by 'remotePath' in the ownCloud account 'account' is downloading\r
-     */\r
-    public static boolean isDownloading(Account account, String remotePath) {\r
-        return (mDownloadsInProgress.get(buildRemoteName(account.name, remotePath)) != null);\r
-    }\r
     \r
     /**\r
      * Builds a key for mDownloadsInProgress from the accountName and remotePath\r
@@ -71,19 +66,6 @@ public class FileDownloader extends Service implements OnDatatransferProgressLis
     private static String buildRemoteName(String accountName, String remotePath) {\r
         return accountName + remotePath;\r
     }\r
-\r
-    \r
-    private final class ServiceHandler extends Handler {\r
-        public ServiceHandler(Looper looper) {\r
-            super(looper);\r
-        }\r
-\r
-        @Override\r
-        public void handleMessage(Message msg) {\r
-            downloadFile();\r
-            stopSelf(msg.arg1);\r
-        }\r
-    }\r
     \r
     public static final String getSavePath(String accountName) {\r
         File sdCard = Environment.getExternalStorageDirectory();\r
@@ -97,6 +79,10 @@ public class FileDownloader extends Service implements OnDatatransferProgressLis
             // URL encoding is an 'easy fix' to overcome that NTFS and FAT32 don't allow ":" in file names, that can be in the accountName since 0.1.190B\r
     }\r
 \r
+    \r
+    /**\r
+     * Service initialization\r
+     */\r
     @Override\r
     public void onCreate() {\r
         super.onCreate();\r
@@ -106,13 +92,16 @@ public class FileDownloader extends Service implements OnDatatransferProgressLis
         thread.start();\r
         mServiceLooper = thread.getLooper();\r
         mServiceHandler = new ServiceHandler(mServiceLooper);\r
+        mBinder = new FileDownloaderBinder();\r
     }\r
 \r
-    @Override\r
-    public IBinder onBind(Intent arg0) {\r
-        return null;\r
-    }\r
-\r
+    \r
+    /**\r
+     * Entry point to add one or several files to the queue of downloads.\r
+     * \r
+     * New downloads are added calling to startService(), resulting in a call to this method. This ensures the service will keep on working \r
+     * although the caller activity goes away.\r
+     */\r
     @Override\r
     public int onStartCommand(Intent intent, int flags, int startId) {\r
         if (    !intent.hasExtra(EXTRA_ACCOUNT) ||\r
@@ -122,116 +111,242 @@ public class FileDownloader extends Service implements OnDatatransferProgressLis
             Log.e(TAG, "Not enough information provided in intent");\r
             return START_NOT_STICKY;\r
         }\r
-        mAccount = intent.getParcelableExtra(EXTRA_ACCOUNT);\r
-        mFilePath = intent.getStringExtra(EXTRA_FILE_PATH);\r
-        mRemotePath = intent.getStringExtra(EXTRA_REMOTE_PATH);\r
-        mTotalDownloadSize = intent.getLongExtra(EXTRA_FILE_SIZE, -1);\r
-        mCurrentDownloadSize = mLastPercent = 0;\r
+        Account account = intent.getParcelableExtra(EXTRA_ACCOUNT);\r
+        String filePath = intent.getStringExtra(EXTRA_FILE_PATH);\r
+        String remotePath = intent.getStringExtra(EXTRA_REMOTE_PATH);\r
+        long totalDownloadSize = intent.getLongExtra(EXTRA_FILE_SIZE, -1);\r
 \r
-        Message msg = mServiceHandler.obtainMessage();\r
-        msg.arg1 = startId;\r
-        mServiceHandler.sendMessage(msg);\r
+        AbstractList<String> requestedDownloads = new Vector<String>(); // dvelasco: now this will always contain just one element, but that can change in a near future\r
+        String downloadKey = buildRemoteName(account.name, remotePath);\r
+        try {\r
+            DownloadFileOperation newDownload = new DownloadFileOperation(account, filePath, remotePath, (String)null, totalDownloadSize, false); \r
+            mPendingDownloads.putIfAbsent(downloadKey, newDownload);\r
+            newDownload.addDatatransferProgressListener(this);\r
+            requestedDownloads.add(downloadKey);\r
+            \r
+        } catch (IllegalArgumentException e) {\r
+            Log.e(TAG, "Not enough information provided in intent: " + e.getMessage());\r
+            return START_NOT_STICKY;\r
+        }\r
+        \r
+        if (requestedDownloads.size() > 0) {\r
+            Message msg = mServiceHandler.obtainMessage();\r
+            msg.arg1 = startId;\r
+            msg.obj = requestedDownloads;\r
+            mServiceHandler.sendMessage(msg);\r
+        }\r
 \r
         return START_NOT_STICKY;\r
     }\r
-\r
+    \r
+    \r
     /**\r
-     * Core download method: requests the file to download and stores it.\r
+     * Provides a binder object that clients can use to perform operations on the queue of downloads, excepting the addition of new files. \r
+     * \r
+     * Implemented to perform cancellation, pause and resume of existing downloads.\r
      */\r
-    private void downloadFile() {\r
-        boolean downloadResult = false;\r
+    @Override\r
+    public IBinder onBind(Intent arg0) {\r
+        return mBinder;\r
+    }\r
 \r
-        /// prepare client object to send the request to the ownCloud server\r
-        WebdavClient wdc = OwnCloudClientUtils.createOwnCloudClient(mAccount, getApplicationContext());\r
-        wdc.setDataTransferProgressListener(this);\r
+    \r
+    /**\r
+     *  Binder to let client components to perform operations on the queue of downloads.\r
+     * \r
+     *  It provides by itself the available operations.\r
+     */\r
+    public class FileDownloaderBinder extends Binder {\r
         \r
-        /// download will be in a temporal file\r
-        File tmpFile = new File(getTemporalPath(mAccount.name) + mFilePath);\r
+        /**\r
+         * Cancels a pending or current download of a remote file.\r
+         * \r
+         * @param account       Owncloud account where the remote file is stored.\r
+         * @param remotePath    URL to the remote file in the queue of downloads.\r
+         */\r
+        public void cancel(Account account, String remotePath) {\r
+            DownloadFileOperation download = null;\r
+            synchronized (mPendingDownloads) {\r
+                download = mPendingDownloads.remove(buildRemoteName(account.name, remotePath));\r
+            }\r
+            if (download != null) {\r
+                download.cancel();\r
+            }\r
+        }\r
         \r
-        /// create status notification to show the download progress\r
-        mNotification = new Notification(R.drawable.icon, getString(R.string.downloader_download_in_progress_ticker), System.currentTimeMillis());\r
-        mNotification.flags |= Notification.FLAG_ONGOING_EVENT;\r
-        mNotification.contentView = new RemoteViews(getApplicationContext().getPackageName(), R.layout.progressbar_layout);\r
-        mNotification.contentView.setProgressBar(R.id.status_progress, 100, 0, mTotalDownloadSize == -1);\r
-        mNotification.contentView.setTextViewText(R.id.status_text, String.format(getString(R.string.downloader_download_in_progress_content), 0, tmpFile.getName()));\r
-        mNotification.contentView.setImageViewResource(R.id.status_icon, R.drawable.icon);\r
-        // TODO put something smart in the contentIntent below\r
-        mNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(), 0, new Intent(), PendingIntent.FLAG_UPDATE_CURRENT);\r
-        mNotificationMngr.notify(R.string.downloader_download_in_progress_ticker, mNotification);\r
         \r
+        /**\r
+         * Returns True when the file referred by 'remotePath' in the ownCloud account 'account' is downloading\r
+         * \r
+         * @param account       Owncloud account where the remote file is stored.\r
+         * @param remotePath    URL to the remote file in the queue of downloads.\r
+         */\r
+        public boolean isDownloading(Account account, String remotePath) {\r
+            synchronized (mPendingDownloads) {\r
+                return (mPendingDownloads.containsKey(buildRemoteName(account.name, remotePath)));\r
+            }\r
+        }\r
+    }\r
+    \r
+    /** \r
+     * Download worker. Performs the pending downloads in the order they were requested. \r
+     * \r
+     * Created with the Looper of a new thread, started in {@link FileUploader#onCreate()}. \r
+     */\r
+    private final class ServiceHandler extends Handler {\r
+        public ServiceHandler(Looper looper) {\r
+            super(looper);\r
+        }\r
 \r
-        /// perform the download\r
-        tmpFile.getParentFile().mkdirs();\r
-        mDownloadsInProgress.put(buildRemoteName(mAccount.name, mRemotePath), tmpFile.getAbsolutePath());\r
-        File newFile = null;\r
-        try {\r
-            if (wdc.downloadFile(mRemotePath, tmpFile)) {\r
-                newFile = new File(getSavePath(mAccount.name) + mFilePath);\r
-                newFile.getParentFile().mkdirs();\r
-                boolean moved = tmpFile.renameTo(newFile);\r
+        @Override\r
+        public void handleMessage(Message msg) {\r
+            @SuppressWarnings("unchecked")\r
+            AbstractList<String> requestedDownloads = (AbstractList<String>) msg.obj;\r
+            if (msg.obj != null) {\r
+                Iterator<String> it = requestedDownloads.iterator();\r
+                while (it.hasNext()) {\r
+                    downloadFile(it.next());\r
+                }\r
+            }\r
+            stopSelf(msg.arg1);\r
+        }\r
+    }\r
+    \r
+    \r
+\r
+    /**\r
+     * Core download method: requests a file to download and stores it.\r
+     * \r
+     * @param downloadKey   Key to access the download to perform, contained in mPendingDownloads \r
+     */\r
+    private void downloadFile(String downloadKey) {\r
+        \r
+        synchronized(mPendingDownloads) {\r
+            mCurrentDownload = mPendingDownloads.get(downloadKey);\r
+        }\r
+        \r
+        if (mCurrentDownload != null) {\r
             \r
-                if (moved) {\r
+            notifyDownloadStart(mCurrentDownload);\r
+\r
+            /// prepare client object to send the request to the ownCloud server\r
+            if (mDownloadClient == null || mLastAccount != mCurrentDownload.getAccount()) {\r
+                mLastAccount = mCurrentDownload.getAccount();\r
+                mDownloadClient = OwnCloudClientUtils.createOwnCloudClient(mLastAccount, getApplicationContext());\r
+            }\r
+\r
+            /// perform the download\r
+            //mDownloadsInProgress.add(buildRemoteName(mLastAccount.name, mCurrentDownload.getRemotePath()));\r
+            RemoteOperationResult downloadResult = null;\r
+            File newLocalFile = null;\r
+            //try {\r
+                downloadResult = mCurrentDownload.execute(mDownloadClient);\r
+                if (downloadResult.isSuccess()) {\r
                     ContentValues cv = new ContentValues();\r
-                    cv.put(ProviderTableMeta.FILE_STORAGE_PATH, newFile.getAbsolutePath());\r
+                    newLocalFile = new File(getSavePath(mCurrentDownload.getAccount().name) + mCurrentDownload.getLocalPath());\r
+                    cv.put(ProviderTableMeta.FILE_STORAGE_PATH, newLocalFile.getAbsolutePath());\r
                     getContentResolver().update(\r
                             ProviderTableMeta.CONTENT_URI,\r
                             cv,\r
                             ProviderTableMeta.FILE_NAME + "=? AND "\r
                                     + ProviderTableMeta.FILE_ACCOUNT_OWNER + "=?",\r
-                            new String[] {\r
-                                mFilePath.substring(mFilePath.lastIndexOf('/') + 1),\r
-                                mAccount.name });\r
-                    downloadResult = true;\r
+                                    new String[] {\r
+                                    mCurrentDownload.getLocalPath().substring(mCurrentDownload.getLocalPath().lastIndexOf('/') + 1),\r
+                                    mLastAccount.name });\r
                 }\r
-            }\r
-        } finally {\r
-            mDownloadsInProgress.remove(buildRemoteName(mAccount.name, mRemotePath));\r
-        }\r
-\r
+            \r
+            /*} finally {\r
+                mDownloadsInProgress.remove(buildRemoteName(mLastAccount.name, mCurrentDownload.getRemotePath()));\r
+            }*/\r
         \r
-        /// notify result\r
-        mNotificationMngr.cancel(R.string.downloader_download_in_progress_ticker);\r
-        int tickerId = (downloadResult) ? R.string.downloader_download_succeeded_ticker : R.string.downloader_download_failed_ticker;\r
-        int contentId = (downloadResult) ? R.string.downloader_download_succeeded_content : R.string.downloader_download_failed_content;\r
-        Notification finalNotification = new Notification(R.drawable.icon, getString(tickerId), System.currentTimeMillis());\r
-        finalNotification.flags |= Notification.FLAG_AUTO_CANCEL;\r
-        // TODO put something smart in the contentIntent below\r
-        finalNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(), 0, new Intent(), PendingIntent.FLAG_UPDATE_CURRENT);\r
-        finalNotification.setLatestEventInfo(getApplicationContext(), getString(tickerId), String.format(getString(contentId), tmpFile.getName()), finalNotification.contentIntent);\r
-        mNotificationMngr.notify(tickerId, finalNotification);\r
+            mPendingDownloads.remove(downloadKey);\r
+            \r
+            /// notify result\r
+            notifyDownloadResult(mCurrentDownload, downloadResult);\r
             \r
-        sendFinalBroadcast(downloadResult, (downloadResult)?newFile.getAbsolutePath():null);\r
+            sendFinalBroadcast(mCurrentDownload, downloadResult, (downloadResult.isSuccess())? newLocalFile.getAbsolutePath():null);\r
+        }\r
     }\r
 \r
+    \r
     /**\r
      * Callback method to update the progress bar in the status notification.\r
      */\r
     @Override\r
-    public void transferProgress(long progressRate) {\r
-        mCurrentDownloadSize += progressRate;\r
-        int percent = (int)(100.0*((double)mCurrentDownloadSize)/((double)mTotalDownloadSize));\r
+    public void onTransferProgress(long progressRate, long totalTransferredSoFar, long totalToTransfer, String fileName) {\r
+        int percent = (int)(100.0*((double)totalTransferredSoFar)/((double)totalToTransfer));\r
         if (percent != mLastPercent) {\r
-          mNotification.contentView.setProgressBar(R.id.status_progress, 100, (int)(100*mCurrentDownloadSize/mTotalDownloadSize), mTotalDownloadSize == -1);\r
-          mNotification.contentView.setTextViewText(R.id.status_text, String.format(getString(R.string.downloader_download_in_progress_content), percent, new File(mFilePath).getName()));\r
+          mNotification.contentView.setProgressBar(R.id.status_progress, 100, percent, totalToTransfer == -1);\r
+          mNotification.contentView.setTextViewText(R.id.status_text, String.format(getString(R.string.downloader_download_in_progress_content), percent, fileName));\r
           mNotificationMngr.notify(R.string.downloader_download_in_progress_ticker, mNotification);\r
         }\r
-        \r
         mLastPercent = percent;\r
     }\r
     \r
+    \r
+    /**\r
+     * Callback method to update the progress bar in the status notification (old version)\r
+     */\r
+    @Override\r
+    public void onTransferProgress(long progressRate) {\r
+        // NOTHING TO DO HERE ANYMORE\r
+    }\r
+    \r
 \r
     /**\r
+     * Creates a status notification to show the download progress\r
+     * \r
+     * @param download  Download operation starting.\r
+     */\r
+    private void notifyDownloadStart(DownloadFileOperation download) {\r
+        /// create status notification to show the download progress\r
+        mLastPercent = 0;\r
+        mNotification = new Notification(R.drawable.icon, getString(R.string.downloader_download_in_progress_ticker), System.currentTimeMillis());\r
+        mNotification.flags |= Notification.FLAG_ONGOING_EVENT;\r
+        mNotification.contentView = new RemoteViews(getApplicationContext().getPackageName(), R.layout.progressbar_layout);\r
+        mNotification.contentView.setProgressBar(R.id.status_progress, 100, 0, download.getSize() == -1);\r
+        mNotification.contentView.setTextViewText(R.id.status_text, String.format(getString(R.string.downloader_download_in_progress_content), 0, new File(download.getLocalPath()).getName()));\r
+        mNotification.contentView.setImageViewResource(R.id.status_icon, R.drawable.icon);\r
+        // TODO put something smart in the contentIntent below\r
+        mNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(), 0, new Intent(), PendingIntent.FLAG_UPDATE_CURRENT);\r
+        mNotificationMngr.notify(R.string.downloader_download_in_progress_ticker, mNotification);\r
+    }\r
+\r
+    \r
+    /**\r
+     * Updates the status notification with the result of a download operation.\r
+     * \r
+     * @param downloadResult    Result of the download operation.\r
+     * @param download          Finished download operation\r
+     */\r
+    private void notifyDownloadResult(DownloadFileOperation download, RemoteOperationResult downloadResult) {\r
+        mNotificationMngr.cancel(R.string.downloader_download_in_progress_ticker);\r
+        if (!downloadResult.isCancelled()) {\r
+            int tickerId = (downloadResult.isSuccess()) ? R.string.downloader_download_succeeded_ticker : R.string.downloader_download_failed_ticker;\r
+            int contentId = (downloadResult.isSuccess()) ? R.string.downloader_download_succeeded_content : R.string.downloader_download_failed_content;\r
+            Notification finalNotification = new Notification(R.drawable.icon, getString(tickerId), System.currentTimeMillis());\r
+            finalNotification.flags |= Notification.FLAG_AUTO_CANCEL;\r
+            // TODO put something smart in the contentIntent below\r
+            finalNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(), 0, new Intent(), PendingIntent.FLAG_UPDATE_CURRENT);\r
+            finalNotification.setLatestEventInfo(getApplicationContext(), getString(tickerId), String.format(getString(contentId), new File(download.getLocalPath()).getName()), finalNotification.contentIntent);\r
+            mNotificationMngr.notify(tickerId, finalNotification);\r
+        }\r
+    }\r
+    \r
+    \r
+    /**\r
      * Sends a broadcast in order to the interested activities can update their view\r
      * \r
-     * @param downloadResult        'True' if the download was successful\r
-     * @param newFilePath           Absolute path to the download file\r
+     * @param download          Finished download operation\r
+     * @param downloadResult    Result of the download operation\r
+     * @param newFilePath       Absolute path to the downloaded file\r
      */\r
-    private void sendFinalBroadcast(boolean downloadResult, String newFilePath) {\r
+    private void sendFinalBroadcast(DownloadFileOperation download, RemoteOperationResult downloadResult, String newFilePath) {\r
         Intent end = new Intent(DOWNLOAD_FINISH_MESSAGE);\r
-        end.putExtra(EXTRA_DOWNLOAD_RESULT, downloadResult);\r
-        end.putExtra(ACCOUNT_NAME, mAccount.name);\r
-        end.putExtra(EXTRA_REMOTE_PATH, mRemotePath);\r
-        if (downloadResult) {\r
+        end.putExtra(EXTRA_DOWNLOAD_RESULT, downloadResult.isSuccess());\r
+        end.putExtra(ACCOUNT_NAME, download.getAccount().name);\r
+        end.putExtra(EXTRA_REMOTE_PATH, download.getRemotePath());\r
+        if (downloadResult.isSuccess()) {\r
             end.putExtra(EXTRA_FILE_PATH, newFilePath);\r
         }\r
         sendBroadcast(end);\r