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