src/com/owncloud/android/files/services/FileDownloader.java

   1 /* ownCloud Android client application
   2  *   Copyright (C) 2012 Bartek Przybylski
   3  *
   4  *   This program is free software: you can redistribute it and/or modify
   5  *   it under the terms of the GNU General Public License as published by
   6  *   the Free Software Foundation, either version 3 of the License, or
   7  *   (at your option) any later version.
   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.Iterator;
  24 import java.util.Vector;
  25 import java.util.concurrent.ConcurrentHashMap;
  26 import java.util.concurrent.ConcurrentMap;
  27
  28 import com.owncloud.android.datamodel.FileDataStorageManager;
  29 import com.owncloud.android.datamodel.OCFile;
  30 import eu.alefzero.webdav.OnDatatransferProgressListener;
  31
  32 import com.owncloud.android.network.OwnCloudClientUtils;
  33 import com.owncloud.android.operations.DownloadFileOperation;
  34 import com.owncloud.android.operations.RemoteOperationResult;
  35 import com.owncloud.android.ui.activity.FileDetailActivity;
  36 import com.owncloud.android.ui.fragment.FileDetailFragment;
  37
  38 import android.accounts.Account;
  39 import android.app.Notification;
  40 import android.app.NotificationManager;
  41 import android.app.PendingIntent;
  42 import android.app.Service;
  43 import android.content.Intent;
  44 import android.os.Binder;
  45 import android.os.Handler;
  46 import android.os.HandlerThread;
  47 import android.os.IBinder;
  48 import android.os.Looper;
  49 import android.os.Message;
  50 import android.os.Process;
  51 import android.util.Log;
  52 import android.widget.RemoteViews;
  53
  54 import com.owncloud.android.R;
  55 import eu.alefzero.webdav.WebdavClient;
  56
  57 public class FileDownloader extends Service implements OnDatatransferProgressListener {
  58
  59     public static final String EXTRA_ACCOUNT = "ACCOUNT";
  60     public static final String EXTRA_FILE = "FILE";
  61
  62     public static final String DOWNLOAD_ADDED_MESSAGE = "DOWNLOAD_ADDED";
  63     public static final String DOWNLOAD_FINISH_MESSAGE = "DOWNLOAD_FINISH";
  64     public static final String EXTRA_DOWNLOAD_RESULT = "RESULT";
  65     public static final String EXTRA_FILE_PATH = "FILE_PATH";
  66     public static final String EXTRA_REMOTE_PATH = "REMOTE_PATH";
  67     public static final String ACCOUNT_NAME = "ACCOUNT_NAME";
  68
  69     private static final String TAG = "FileDownloader";
  70
  71     private Looper mServiceLooper;
  72     private ServiceHandler mServiceHandler;
  73     private IBinder mBinder;
  74     private WebdavClient mDownloadClient = null;
  75     private Account mLastAccount = null;
  76     private FileDataStorageManager mStorageManager;
  77
  78     private ConcurrentMap<String, DownloadFileOperation> mPendingDownloads = new ConcurrentHashMap<String, DownloadFileOperation>();
  79     private DownloadFileOperation mCurrentDownload = null;
  80
  81     private NotificationManager mNotificationManager;
  82     private Notification mNotification;
  83     private int mLastPercent;
  84
  85
  86     /**
  87      * Builds a key for mPendingDownloads from the account and file to download
  88      *
  89      * @param account   Account where the file to download is stored
  90      * @param file      File to download
  91      */
  92     private String buildRemoteName(Account account, OCFile file) {
  93         return account.name + file.getRemotePath();
  94     }
  95
  96
  97     /**
  98      * Service initialization
  99      */
 100     @Override
 101     public void onCreate() {
 102         super.onCreate();
 103         mNotificationManager = (NotificationManager) getSystemService(NOTIFICATION_SERVICE);
 104         HandlerThread thread = new HandlerThread("FileDownloaderThread",
 105                 Process.THREAD_PRIORITY_BACKGROUND);
 106         thread.start();
 107         mServiceLooper = thread.getLooper();
 108         mServiceHandler = new ServiceHandler(mServiceLooper, this);
 109         mBinder = new FileDownloaderBinder();
 110     }
 111
 112
 113     /**
 114      * Entry point to add one or several files to the queue of downloads.
 115      *
 116      * New downloads are added calling to startService(), resulting in a call to this method. This ensures the service will keep on working
 117      * although the caller activity goes away.
 118      */
 119     @Override
 120     public int onStartCommand(Intent intent, int flags, int startId) {
 121         if (    !intent.hasExtra(EXTRA_ACCOUNT) ||
 122                 !intent.hasExtra(EXTRA_FILE)
 123                 /*!intent.hasExtra(EXTRA_FILE_PATH) ||
 124                 !intent.hasExtra(EXTRA_REMOTE_PATH)*/
 125            ) {
 126             Log.e(TAG, "Not enough information provided in intent");
 127             return START_NOT_STICKY;
 128         }
 129         Account account = intent.getParcelableExtra(EXTRA_ACCOUNT);
 130         OCFile file = intent.getParcelableExtra(EXTRA_FILE);
 131
 132         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)
 133         String downloadKey = buildRemoteName(account, file);
 134         try {
 135             DownloadFileOperation newDownload = new DownloadFileOperation(account, file);
 136             mPendingDownloads.putIfAbsent(downloadKey, newDownload);
 137             newDownload.addDatatransferProgressListener(this);
 138             requestedDownloads.add(downloadKey);
 139
 140         } catch (IllegalArgumentException e) {
 141             Log.e(TAG, "Not enough information provided in intent: " + e.getMessage());
 142             return START_NOT_STICKY;
 143         }
 144
 145         if (requestedDownloads.size() > 0) {
 146             Message msg = mServiceHandler.obtainMessage();
 147             msg.arg1 = startId;
 148             msg.obj = requestedDownloads;
 149             mServiceHandler.sendMessage(msg);
 150         }
 151
 152         return START_NOT_STICKY;
 153     }
 154
 155
 156     /**
 157      * Provides a binder object that clients can use to perform operations on the queue of downloads, excepting the addition of new files.
 158      *
 159      * Implemented to perform cancellation, pause and resume of existing downloads.
 160      */
 161     @Override
 162     public IBinder onBind(Intent arg0) {
 163         return mBinder;
 164     }
 165
 166
 167     /**
 168      *  Binder to let client components to perform operations on the queue of downloads.
 169      *
 170      *  It provides by itself the available operations.
 171      */
 172     public class FileDownloaderBinder extends Binder {
 173
 174         /**
 175          * Cancels a pending or current download of a remote file.
 176          *
 177          * @param account       Owncloud account where the remote file is stored.
 178          * @param file          A file in the queue of pending downloads
 179          */
 180         public void cancel(Account account, OCFile file) {
 181             DownloadFileOperation download = null;
 182             synchronized (mPendingDownloads) {
 183                 download = mPendingDownloads.remove(buildRemoteName(account, file));
 184             }
 185             if (download != null) {
 186                 download.cancel();
 187             }
 188         }
 189
 190
 191         /**
 192          * Returns True when the file described by 'file' in the ownCloud account 'account' is downloading or waiting to download
 193          *
 194          * @param account       Owncloud account where the remote file is stored.
 195          * @param file          A file that could be in the queue of downloads.
 196          */
 197         public boolean isDownloading(Account account, OCFile file) {
 198             synchronized (mPendingDownloads) {
 199                 return (mPendingDownloads.containsKey(buildRemoteName(account, file)));
 200             }
 201         }
 202     }
 203
 204
 205     /**
 206      * Download worker. Performs the pending downloads in the order they were requested.
 207      *
 208      * Created with the Looper of a new thread, started in {@link FileUploader#onCreate()}.
 209      */
 210     private static class ServiceHandler extends Handler {
 211         // don't make it a final class, and don't remove the static ; lint will warn about a possible memory leak
 212         FileDownloader mService;
 213         public ServiceHandler(Looper looper, FileDownloader service) {
 214             super(looper);
 215             if (service == null)
 216                 throw new IllegalArgumentException("Received invalid NULL in parameter 'service'");
 217             mService = service;
 218         }
 219
 220         @Override
 221         public void handleMessage(Message msg) {
 222             @SuppressWarnings("unchecked")
 223             AbstractList<String> requestedDownloads = (AbstractList<String>) msg.obj;
 224             if (msg.obj != null) {
 225                 Iterator<String> it = requestedDownloads.iterator();
 226                 while (it.hasNext()) {
 227                     mService.downloadFile(it.next());
 228                 }
 229             }
 230             mService.stopSelf(msg.arg1);
 231         }
 232     }
 233
 234
 235
 236     /**
 237      * Core download method: requests a file to download and stores it.
 238      *
 239      * @param downloadKey   Key to access the download to perform, contained in mPendingDownloads
 240      */
 241     private void downloadFile(String downloadKey) {
 242
 243         synchronized(mPendingDownloads) {
 244             mCurrentDownload = mPendingDownloads.get(downloadKey);
 245         }
 246
 247         if (mCurrentDownload != null) {
 248
 249             notifyDownloadStart(mCurrentDownload);
 250
 251             /// prepare client object to send the request to the ownCloud server
 252             if (mDownloadClient == null || !mLastAccount.equals(mCurrentDownload.getAccount())) {
 253                 mLastAccount = mCurrentDownload.getAccount();
 254                 mStorageManager = new FileDataStorageManager(mLastAccount, getContentResolver());
 255                 mDownloadClient = OwnCloudClientUtils.createOwnCloudClient(mLastAccount, getApplicationContext());
 256             }
 257
 258             /// perform the download
 259             RemoteOperationResult downloadResult = null;
 260             try {
 261                 downloadResult = mCurrentDownload.execute(mDownloadClient);
 262                 if (downloadResult.isSuccess()) {
 263                     saveDownloadedFile();
 264                 }
 265
 266             } finally {
 267                 synchronized(mPendingDownloads) {
 268                     mPendingDownloads.remove(downloadKey);
 269                 }
 270             }
 271
 272
 273             /// notify result
 274             notifyDownloadResult(mCurrentDownload, downloadResult);
 275
 276             sendFinalBroadcast(mCurrentDownload, downloadResult);
 277         }
 278     }
 279
 280
 281     /**
 282      * Updates the OC File after a successful download.
 283      */
 284     private void saveDownloadedFile() {
 285         OCFile file = mCurrentDownload.getFile();
 286         long syncDate = System.currentTimeMillis();
 287         file.setLastSyncDateForProperties(syncDate);
 288         file.setLastSyncDateForData(syncDate);
 289         file.setModificationTimestamp(mCurrentDownload.getModificationTimestamp());
 290         // file.setEtag(mCurrentDownload.getEtag());    // TODO Etag, where available
 291         file.setMimetype(mCurrentDownload.getMimeType());
 292         file.setStoragePath(mCurrentDownload.getSavePath());
 293         file.setFileLength((new File(mCurrentDownload.getSavePath()).length()));
 294         mStorageManager.saveFile(file);
 295     }
 296
 297
 298     /**
 299      * Creates a status notification to show the download progress
 300      *
 301      * @param download  Download operation starting.
 302      */
 303     private void notifyDownloadStart(DownloadFileOperation download) {
 304         /// create status notification with a progress bar
 305         mLastPercent = 0;
 306         mNotification = new Notification(R.drawable.icon, getString(R.string.downloader_download_in_progress_ticker), System.currentTimeMillis());
 307         mNotification.flags |= Notification.FLAG_ONGOING_EVENT;
 308         mNotification.contentView = new RemoteViews(getApplicationContext().getPackageName(), R.layout.progressbar_layout);
 309         mNotification.contentView.setProgressBar(R.id.status_progress, 100, 0, download.getSize() < 0);
 310         mNotification.contentView.setTextViewText(R.id.status_text, String.format(getString(R.string.downloader_download_in_progress_content), 0, new File(download.getSavePath()).getName()));
 311         mNotification.contentView.setImageViewResource(R.id.status_icon, R.drawable.icon);
 312
 313         /// includes a pending intent in the notification showing the details view of the file
 314         Intent showDetailsIntent = new Intent(this, FileDetailActivity.class);
 315         showDetailsIntent.putExtra(FileDetailFragment.EXTRA_FILE, download.getFile());
 316         showDetailsIntent.putExtra(FileDetailFragment.EXTRA_ACCOUNT, download.getAccount());
 317         showDetailsIntent.setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
 318         mNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(), (int)System.currentTimeMillis(), showDetailsIntent, 0);
 319
 320         mNotificationManager.notify(R.string.downloader_download_in_progress_ticker, mNotification);
 321     }
 322
 323
 324     /**
 325      * Callback method to update the progress bar in the status notification.
 326      */
 327     @Override
 328     public void onTransferProgress(long progressRate, long totalTransferredSoFar, long totalToTransfer, String fileName) {
 329         int percent = (int)(100.0*((double)totalTransferredSoFar)/((double)totalToTransfer));
 330         if (percent != mLastPercent) {
 331           mNotification.contentView.setProgressBar(R.id.status_progress, 100, percent, totalToTransfer < 0);
 332           String text = String.format(getString(R.string.downloader_download_in_progress_content), percent, fileName);
 333           mNotification.contentView.setTextViewText(R.id.status_text, text);
 334           mNotificationManager.notify(R.string.downloader_download_in_progress_ticker, mNotification);
 335         }
 336         mLastPercent = percent;
 337     }
 338
 339
 340     /**
 341      * Callback method to update the progress bar in the status notification (old version)
 342      */
 343     @Override
 344     public void onTransferProgress(long progressRate) {
 345         // NOTHING TO DO HERE ANYMORE
 346     }
 347
 348
 349     /**
 350      * Updates the status notification with the result of a download operation.
 351      *
 352      * @param downloadResult    Result of the download operation.
 353      * @param download          Finished download operation
 354      */
 355     private void notifyDownloadResult(DownloadFileOperation download, RemoteOperationResult downloadResult) {
 356         mNotificationManager.cancel(R.string.downloader_download_in_progress_ticker);
 357         if (!downloadResult.isCancelled()) {
 358             int tickerId = (downloadResult.isSuccess()) ? R.string.downloader_download_succeeded_ticker : R.string.downloader_download_failed_ticker;
 359             int contentId = (downloadResult.isSuccess()) ? R.string.downloader_download_succeeded_content : R.string.downloader_download_failed_content;
 360             Notification finalNotification = new Notification(R.drawable.icon, getString(tickerId), System.currentTimeMillis());
 361             finalNotification.flags |= Notification.FLAG_AUTO_CANCEL;
 362             // TODO put something smart in the contentIntent below
 363             finalNotification.contentIntent = PendingIntent.getActivity(getApplicationContext(), (int)System.currentTimeMillis(), new Intent(), 0);
 364             finalNotification.setLatestEventInfo(getApplicationContext(), getString(tickerId), String.format(getString(contentId), new File(download.getSavePath()).getName()), finalNotification.contentIntent);
 365             mNotificationManager.notify(tickerId, finalNotification);
 366         }
 367     }
 368
 369
 370     /**
 371      * Sends a broadcast in order to the interested activities can update their view
 372      *
 373      * @param download          Finished download operation
 374      * @param downloadResult    Result of the download operation
 375      */
 376     private void sendFinalBroadcast(DownloadFileOperation download, RemoteOperationResult downloadResult) {
 377         Intent end = new Intent(DOWNLOAD_FINISH_MESSAGE);
 378         end.putExtra(EXTRA_DOWNLOAD_RESULT, downloadResult.isSuccess());
 379         end.putExtra(ACCOUNT_NAME, download.getAccount().name);
 380         end.putExtra(EXTRA_REMOTE_PATH, download.getRemotePath());
 381         end.putExtra(EXTRA_FILE_PATH, download.getSavePath());
 382         sendBroadcast(end);
 383     }
 384
 385 }