+/* ownCloud Android client application\r
+ * Copyright (C) 2012 Bartek Przybylski\r
+ *\r
+ * This program is free software: you can redistribute it and/or modify\r
+ * it under the terms of the GNU General Public License as published by\r
+ * the Free Software Foundation, either version 3 of the License, or\r
+ * (at your option) any later version.\r
+ *\r
+ * This program is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License\r
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.\r
+ *\r
+ */\r
+\r
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.datamodel.OCFile;\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
+import com.owncloud.android.ui.activity.FileDetailActivity;\r
+import com.owncloud.android.ui.fragment.FileDetailFragment;\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
import android.app.Service;\r
import android.content.ContentValues;\r
import android.content.Intent;\r
-import android.net.Uri;\r
-import android.os.Environment;\r
+import android.os.Binder;\r
import android.os.Handler;\r
import android.os.HandlerThread;\r
import android.os.IBinder;\r
import android.os.Process;\r
import android.util.Log;\r
import android.widget.RemoteViews;\r
+\r
import com.owncloud.android.R;\r
import eu.alefzero.webdav.WebdavClient;\r
\r
public class FileDownloader extends Service implements OnDatatransferProgressListener {\r
+ \r
+ public static final String EXTRA_ACCOUNT = "ACCOUNT";\r
+ public static final String EXTRA_FILE = "FILE";\r
+ \r
public static final String DOWNLOAD_FINISH_MESSAGE = "DOWNLOAD_FINISH";\r
public static final String EXTRA_DOWNLOAD_RESULT = "RESULT"; \r
- public static final String EXTRA_ACCOUNT = "ACCOUNT";\r
public static final String EXTRA_FILE_PATH = "FILE_PATH";\r
public static final String EXTRA_REMOTE_PATH = "REMOTE_PATH";\r
- public static final String EXTRA_FILE_SIZE = "FILE_SIZE";\r
public static final String ACCOUNT_NAME = "ACCOUNT_NAME";\r
\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 IBinder mBinder;\r
+ private WebdavClient mDownloadClient = null;\r
+ private Account mLastAccount = null;\r
+ \r
+ private ConcurrentMap<String, DownloadFileOperation> mPendingDownloads = new ConcurrentHashMap<String, DownloadFileOperation>();\r
+ private DownloadFileOperation mCurrentDownload = null;\r
+ \r
+ private NotificationManager mNotificationManager;\r
private Notification mNotification;\r
+ private int mLastPercent;\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
\r
/**\r
- * Returns True when the file referred by 'remotePath' in the ownCloud account 'account' is downloading\r
+ * Builds a key for mPendingDownloads from the account and file to download\r
+ * \r
+ * @param account Account where the file to download is stored\r
+ * @param file File to download\r
*/\r
- public static boolean isDownloading(Account account, String remotePath) {\r
- return (mDownloadsInProgress.get(buildRemoteName(account.name, remotePath)) != null);\r
+ private String buildRemoteName(Account account, OCFile file) {\r
+ return account.name + file.getRemotePath();\r
}\r
+\r
\r
/**\r
- * Builds a key for mDownloadsInProgress from the accountName and remotePath\r
+ * Service initialization\r
*/\r
- 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
- return sdCard.getAbsolutePath() + "/owncloud/" + Uri.encode(accountName, "@"); \r
- // 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
- public static final String getTemporalPath(String accountName) {\r
- File sdCard = Environment.getExternalStorageDirectory();\r
- return sdCard.getAbsolutePath() + "/owncloud/tmp/" + Uri.encode(accountName, "@");\r
- // 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
@Override\r
public void onCreate() {\r
super.onCreate();\r
- mNotificationMngr = (NotificationManager) getSystemService(NOTIFICATION_SERVICE);\r
- HandlerThread thread = new HandlerThread("FileDownladerThread",\r
+ mNotificationManager = (NotificationManager) getSystemService(NOTIFICATION_SERVICE);\r
+ HandlerThread thread = new HandlerThread("FileDownloaderThread",\r
Process.THREAD_PRIORITY_BACKGROUND);\r
thread.start();\r
mServiceLooper = thread.getLooper();\r
- mServiceHandler = new ServiceHandler(mServiceLooper);\r
- }\r
-\r
- @Override\r
- public IBinder onBind(Intent arg0) {\r
- return null;\r
+ mServiceHandler = new ServiceHandler(mServiceLooper, this);\r
+ mBinder = new FileDownloaderBinder();\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
- !intent.hasExtra(EXTRA_FILE_PATH) ||\r
- !intent.hasExtra(EXTRA_REMOTE_PATH)\r
+ !intent.hasExtra(EXTRA_FILE)\r
+ /*!intent.hasExtra(EXTRA_FILE_PATH) ||\r
+ !intent.hasExtra(EXTRA_REMOTE_PATH)*/\r
) {\r
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
-\r
- Message msg = mServiceHandler.obtainMessage();\r
- msg.arg1 = startId;\r
- mServiceHandler.sendMessage(msg);\r
+ Account account = intent.getParcelableExtra(EXTRA_ACCOUNT);\r
+ OCFile file = intent.getParcelableExtra(EXTRA_FILE);\r
+ \r
+ AbstractList<String> requestedDownloads = new Vector<String>(); // dvelasco: now this always contains just one element, but that can change in a near future (download of multiple selection)\r
+ String downloadKey = buildRemoteName(account, file);\r
+ try {\r
+ DownloadFileOperation newDownload = new DownloadFileOperation(account, file); \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 file A file in the queue of pending downloads\r
+ */\r
+ public void cancel(Account account, OCFile file) {\r
+ DownloadFileOperation download = null;\r
+ synchronized (mPendingDownloads) {\r
+ download = mPendingDownloads.remove(buildRemoteName(account, file));\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 described by 'file' in the ownCloud account 'account' is downloading or waiting to download\r
+ * \r
+ * @param account Owncloud account where the remote file is stored.\r
+ * @param file A file that could be in the queue of downloads.\r
+ */\r
+ public boolean isDownloading(Account account, OCFile file) {\r
+ synchronized (mPendingDownloads) {\r
+ return (mPendingDownloads.containsKey(buildRemoteName(account, file)));\r
+ }\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 static class ServiceHandler extends Handler {\r
+ // don't make it a final class, and don't remove the static ; lint will warn about a possible memory leak\r
+ FileDownloader mService;\r
+ public ServiceHandler(Looper looper, FileDownloader service) {\r
+ super(looper);\r
+ if (service == null)\r
+ throw new IllegalArgumentException("Received invalid NULL in parameter 'service'");\r
+ mService = service;\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
+ mService.downloadFile(it.next());\r
+ }\r
+ }\r
+ mService.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.equals(mCurrentDownload.getAccount())) {\r
+ mLastAccount = mCurrentDownload.getAccount();\r
+ mDownloadClient = OwnCloudClientUtils.createOwnCloudClient(mLastAccount, getApplicationContext());\r
+ }\r
+\r
+ /// perform the download\r
+ RemoteOperationResult downloadResult = 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
+ cv.put(ProviderTableMeta.FILE_STORAGE_PATH, mCurrentDownload.getSavePath());\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.getSavePath().substring(mCurrentDownload.getSavePath().lastIndexOf('/') + 1),\r
+ mLastAccount.name });\r
+ }\r
+ \r
+ } finally {\r
+ synchronized(mPendingDownloads) {\r
+ mPendingDownloads.remove(downloadKey);\r
}\r
}\r
- } finally {\r
- mDownloadsInProgress.remove(buildRemoteName(mAccount.name, mRemotePath));\r
+\r
+ \r
+ /// notify result\r
+ notifyDownloadResult(mCurrentDownload, downloadResult);\r
+ \r
+ sendFinalBroadcast(mCurrentDownload, downloadResult);\r
}\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 with a progress bar\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() < 0);\r
+ mNotification.contentView.setTextViewText(R.id.status_text, String.format(getString(R.string.downloader_download_in_progress_content), 0, new File(download.getSavePath()).getName()));\r
+ mNotification.contentView.setImageViewResource(R.id.status_icon, R.drawable.icon);\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
- \r
- sendFinalBroadcast(downloadResult, (downloadResult)?newFile.getAbsolutePath():null);\r
+ /// includes a pending intent in the notification showing the details view of the file\r
+ Intent showDetailsIntent = new Intent(this, FileDetailActivity.class);\r
+ showDetailsIntent.putExtra(FileDetailFragment.EXTRA_FILE, download.getFile());\r
+ showDetailsIntent.putExtra(FileDetailFragment.EXTRA_ACCOUNT, download.getAccount());\r
+ showDetailsIntent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);\r
+ mNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(), (int)System.currentTimeMillis(), showDetailsIntent, 0);\r
+ \r
+ mNotificationManager.notify(R.string.downloader_download_in_progress_ticker, mNotification);\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
- mNotificationMngr.notify(R.string.downloader_download_in_progress_ticker, mNotification);\r
+ mNotification.contentView.setProgressBar(R.id.status_progress, 100, percent, totalToTransfer < 0);\r
+ String text = String.format(getString(R.string.downloader_download_in_progress_content), percent, fileName);\r
+ mNotification.contentView.setTextViewText(R.id.status_text, text);\r
+ mNotificationManager.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
+ * 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
+ mNotificationManager.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(), (int)System.currentTimeMillis(), new Intent(), 0);\r
+ finalNotification.setLatestEventInfo(getApplicationContext(), getString(tickerId), String.format(getString(contentId), new File(download.getSavePath()).getName()), finalNotification.contentIntent);\r
+ mNotificationManager.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
*/\r
- private void sendFinalBroadcast(boolean downloadResult, String newFilePath) {\r
+ private void sendFinalBroadcast(DownloadFileOperation download, RemoteOperationResult downloadResult) {\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_FILE_PATH, newFilePath);\r
- }\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
+ end.putExtra(EXTRA_FILE_PATH, download.getSavePath());\r
sendBroadcast(end);\r
}\r
\r
projects / pub / Android / ownCloud.git / blobdiff