src/com/owncloud/android/datamodel/ThumbnailsCacheManager.java

   1 /**
   2  *   ownCloud Android client application
   3  *
   4  *   @author Tobias Kaminsky
   5  *   @author David A. Velasco
   6  *   Copyright (C) 2015 ownCloud Inc.
   7  *
   8  *   This program is free software: you can redistribute it and/or modify
   9  *   it under the terms of the GNU General Public License version 2,
  10  *   as published by the Free Software Foundation.
  11  *
  12  *   This program is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 package com.owncloud.android.datamodel;
  23
  24 import java.io.File;
  25 import java.io.InputStream;
  26 import java.lang.ref.WeakReference;
  27
  28 import org.apache.commons.httpclient.HttpStatus;
  29 import org.apache.commons.httpclient.methods.GetMethod;
  30
  31 import android.accounts.Account;
  32 import android.content.res.Resources;
  33 import android.graphics.Bitmap;
  34 import android.graphics.Bitmap.CompressFormat;
  35 import android.graphics.BitmapFactory;
  36 import android.graphics.Canvas;
  37 import android.graphics.drawable.BitmapDrawable;
  38 import android.graphics.drawable.ColorDrawable;
  39 import android.graphics.drawable.Drawable;
  40 import android.media.ThumbnailUtils;
  41 import android.net.Uri;
  42 import android.os.AsyncTask;
  43 import android.widget.ImageView;
  44
  45 import com.owncloud.android.MainApp;
  46 import com.owncloud.android.R;
  47 import com.owncloud.android.authentication.AccountUtils;
  48 import com.owncloud.android.lib.common.OwnCloudAccount;
  49 import com.owncloud.android.lib.common.OwnCloudClient;
  50 import com.owncloud.android.lib.common.OwnCloudClientManagerFactory;
  51 import com.owncloud.android.lib.common.utils.Log_OC;
  52 import com.owncloud.android.lib.resources.status.OwnCloudVersion;
  53 import com.owncloud.android.ui.adapter.DiskLruImageCache;
  54 import com.owncloud.android.utils.BitmapUtils;
  55 import com.owncloud.android.utils.DisplayUtils;
  56
  57 /**
  58  * Manager for concurrent access to thumbnails cache.
  59  */
  60 public class ThumbnailsCacheManager {
  61
  62     private static final String TAG = ThumbnailsCacheManager.class.getSimpleName();
  63
  64     private static final String CACHE_FOLDER = "thumbnailCache";
  65
  66     private static final Object mThumbnailsDiskCacheLock = new Object();
  67     private static DiskLruImageCache mThumbnailCache = null;
  68     private static boolean mThumbnailCacheStarting = true;
  69
  70     private static final int DISK_CACHE_SIZE = 1024 * 1024 * 10; // 10MB
  71     private static final CompressFormat mCompressFormat = CompressFormat.JPEG;
  72     private static final int mCompressQuality = 70;
  73     private static OwnCloudClient mClient = null;
  74
  75     public static Bitmap mDefaultImg =
  76             BitmapFactory.decodeResource(
  77                     MainApp.getAppContext().getResources(),
  78                     R.drawable.file_image
  79             );
  80
  81
  82     public static class InitDiskCacheTask extends AsyncTask<File, Void, Void> {
  83
  84         @Override
  85         protected Void doInBackground(File... params) {
  86             synchronized (mThumbnailsDiskCacheLock) {
  87                 mThumbnailCacheStarting = true;
  88
  89                 if (mThumbnailCache == null) {
  90                     try {
  91                         // Check if media is mounted or storage is built-in, if so,
  92                         // try and use external cache dir; otherwise use internal cache dir
  93                         final String cachePath =
  94                                 MainApp.getAppContext().getExternalCacheDir().getPath() +
  95                                 File.separator + CACHE_FOLDER;
  96                         Log_OC.d(TAG, "create dir: " + cachePath);
  97                         final File diskCacheDir = new File(cachePath);
  98                         mThumbnailCache = new DiskLruImageCache(
  99                                 diskCacheDir,
 100                                 DISK_CACHE_SIZE,
 101                                 mCompressFormat,
 102                                 mCompressQuality
 103                         );
 104                     } catch (Exception e) {
 105                         Log_OC.d(TAG, "Thumbnail cache could not be opened ", e);
 106                         mThumbnailCache = null;
 107                     }
 108                 }
 109                 mThumbnailCacheStarting = false; // Finished initialization
 110                 mThumbnailsDiskCacheLock.notifyAll(); // Wake any waiting threads
 111             }
 112             return null;
 113         }
 114     }
 115
 116
 117     public static void addBitmapToCache(String key, Bitmap bitmap) {
 118         synchronized (mThumbnailsDiskCacheLock) {
 119             if (mThumbnailCache != null) {
 120                 mThumbnailCache.put(key, bitmap);
 121             }
 122         }
 123     }
 124
 125
 126     public static Bitmap getBitmapFromDiskCache(String key) {
 127         synchronized (mThumbnailsDiskCacheLock) {
 128             // Wait while disk cache is started from background thread
 129             while (mThumbnailCacheStarting) {
 130                 try {
 131                     mThumbnailsDiskCacheLock.wait();
 132                 } catch (InterruptedException e) {
 133                     Log_OC.e(TAG, "Wait in mThumbnailsDiskCacheLock was interrupted", e);
 134                 }
 135             }
 136             if (mThumbnailCache != null) {
 137                 return mThumbnailCache.getBitmap(key);
 138             }
 139         }
 140         return null;
 141     }
 142
 143     /**
 144      * Sets max size of cache
 145      * @param maxSize in MB
 146      * @return
 147      */
 148     public static boolean setMaxSize(long maxSize){
 149         if (mThumbnailCache != null){
 150             mThumbnailCache.setMaxSize(maxSize * 1024 * 1024);
 151             return true;
 152         } else {
 153             return false;
 154         }
 155     }
 156
 157     public static long getMaxSize(){
 158         if (mThumbnailCache != null) {
 159             return mThumbnailCache.getMaxSize();
 160         } else {
 161             return -1l;
 162         }
 163     }
 164
 165     public static class ThumbnailGenerationTask extends AsyncTask<Object, Void, Bitmap> {
 166         private final WeakReference<ImageView> mImageViewReference;
 167         private static Account mAccount;
 168         private Object mFile;
 169         private FileDataStorageManager mStorageManager;
 170
 171
 172         public ThumbnailGenerationTask(ImageView imageView, FileDataStorageManager storageManager,
 173                                        Account account) {
 174             // Use a WeakReference to ensure the ImageView can be garbage collected
 175             mImageViewReference = new WeakReference<ImageView>(imageView);
 176             if (storageManager == null)
 177                 throw new IllegalArgumentException("storageManager must not be NULL");
 178             mStorageManager = storageManager;
 179             mAccount = account;
 180         }
 181
 182         public ThumbnailGenerationTask(ImageView imageView) {
 183             // Use a WeakReference to ensure the ImageView can be garbage collected
 184             mImageViewReference = new WeakReference<ImageView>(imageView);
 185         }
 186
 187         @Override
 188         protected Bitmap doInBackground(Object... params) {
 189             Bitmap thumbnail = null;
 190
 191             try {
 192                 if (mAccount != null) {
 193                     OwnCloudAccount ocAccount = new OwnCloudAccount(mAccount,
 194                             MainApp.getAppContext());
 195                     mClient = OwnCloudClientManagerFactory.getDefaultSingleton().
 196                             getClientFor(ocAccount, MainApp.getAppContext());
 197                 }
 198
 199                 mFile = params[0];
 200
 201                 if (mFile instanceof OCFile) {
 202                     thumbnail = doOCFileInBackground();
 203                 }  else if (mFile instanceof File) {
 204                     thumbnail = doFileInBackground();
 205                 //} else {  do nothing
 206                 }
 207
 208                 }catch(Throwable t){
 209                     // the app should never break due to a problem with thumbnails
 210                     Log_OC.e(TAG, "Generation of thumbnail for " + mFile + " failed", t);
 211                     if (t instanceof OutOfMemoryError) {
 212                         System.gc();
 213                     }
 214                 }
 215
 216             return thumbnail;
 217         }
 218
 219         protected void onPostExecute(Bitmap bitmap){
 220             if (bitmap != null) {
 221                 final ImageView imageView = mImageViewReference.get();
 222                 final ThumbnailGenerationTask bitmapWorkerTask = getBitmapWorkerTask(imageView);
 223                 if (this == bitmapWorkerTask) {
 224                     String tagId = "";
 225                     if (mFile instanceof OCFile){
 226                         tagId = String.valueOf(((OCFile)mFile).getFileId());
 227                     } else if (mFile instanceof File){
 228                         tagId = String.valueOf(mFile.hashCode());
 229                     }
 230                     if (String.valueOf(imageView.getTag()).equals(tagId)) {
 231                         imageView.setImageBitmap(bitmap);
 232                     }
 233                 }
 234             }
 235         }
 236
 237         /**
 238          * Add thumbnail to cache
 239          * @param imageKey: thumb key
 240          * @param bitmap:   image for extracting thumbnail
 241          * @param path:     image path
 242          * @param px:       thumbnail dp
 243          * @return Bitmap
 244          */
 245         private Bitmap addThumbnailToCache(String imageKey, Bitmap bitmap, String path, int px){
 246
 247             Bitmap thumbnail = ThumbnailUtils.extractThumbnail(bitmap, px, px);
 248
 249             // Rotate image, obeying exif tag
 250             thumbnail = BitmapUtils.rotateImage(thumbnail,path);
 251
 252             // Add thumbnail to cache
 253             addBitmapToCache(imageKey, thumbnail);
 254
 255             return thumbnail;
 256         }
 257
 258         /**
 259          * Converts size of file icon from dp to pixel
 260          * @return int
 261          */
 262         private int getThumbnailDimension(){
 263             // Converts dp to pixel
 264             Resources r = MainApp.getAppContext().getResources();
 265             return Math.round(r.getDimension(R.dimen.file_icon_size_grid));
 266         }
 267
 268         private Bitmap doOCFileInBackground() {
 269             OCFile file = (OCFile)mFile;
 270
 271             final String imageKey = String.valueOf(file.getRemoteId());
 272
 273             // Check disk cache in background thread
 274             Bitmap thumbnail = getBitmapFromDiskCache(imageKey);
 275
 276             // Not found in disk cache
 277             if (thumbnail == null || file.needsUpdateThumbnail()) {
 278
 279                 int px = getThumbnailDimension();
 280
 281                 if (file.isDown()) {
 282                     Bitmap temp = BitmapUtils.decodeSampledBitmapFromFile(
 283                             file.getStoragePath(), px, px);
 284                     Bitmap bitmap = ThumbnailUtils.extractThumbnail(temp, px, px);
 285
 286                     if (bitmap != null) {
 287                         // Handle PNG
 288                         if (file.getMimetype().equalsIgnoreCase("image/png")) {
 289                             bitmap = handlePNG(bitmap, px);
 290                         }
 291
 292                         thumbnail = addThumbnailToCache(imageKey, bitmap, file.getStoragePath(), px);
 293
 294                         file.setNeedsUpdateThumbnail(false);
 295                         mStorageManager.saveFile(file);
 296                     }
 297
 298                 } else {
 299                     // Download thumbnail from server
 300                     OwnCloudVersion serverOCVersion = AccountUtils.getServerVersion(mAccount);
 301                     if (mClient != null && serverOCVersion != null) {
 302                         if (serverOCVersion.supportsRemoteThumbnails()) {
 303                             try {
 304                                 String uri = mClient.getBaseUri() + "" +
 305                                         "/index.php/apps/files/api/v1/thumbnail/" +
 306                                         px + "/" + px + Uri.encode(file.getRemotePath(), "/");
 307                                 Log_OC.d("Thumbnail", "URI: " + uri);
 308                                 GetMethod get = new GetMethod(uri);
 309                                 int status = mClient.executeMethod(get);
 310                                 if (status == HttpStatus.SC_OK) {
 311                                     InputStream inputStream = get.getResponseBodyAsStream();
 312                                     Bitmap bitmap = BitmapFactory.decodeStream(inputStream);
 313                                     thumbnail = ThumbnailUtils.extractThumbnail(bitmap, px, px);
 314
 315                                     // Handle PNG
 316                                     if (file.getMimetype().equalsIgnoreCase("image/png")) {
 317                                         thumbnail = handlePNG(thumbnail, px);
 318                                     }
 319
 320                                     // Add thumbnail to cache
 321                                     if (thumbnail != null) {
 322                                         addBitmapToCache(imageKey, thumbnail);
 323                                     }
 324                                 }
 325                             } catch (Exception e) {
 326                                 e.printStackTrace();
 327                             }
 328                         } else {
 329                             Log_OC.d(TAG, "Server too old");
 330                         }
 331                     }
 332                 }
 333             }
 334
 335             return thumbnail;
 336
 337         }
 338
 339         private Bitmap handlePNG(Bitmap bitmap, int px){
 340             Bitmap resultBitmap = Bitmap.createBitmap(px,
 341                     px,
 342                     Bitmap.Config.ARGB_8888);
 343             Canvas c = new Canvas(resultBitmap);
 344
 345             c.drawColor(MainApp.getAppContext().getResources().
 346                     getColor(R.color.background_color));
 347             c.drawBitmap(bitmap, 0, 0, null);
 348
 349             return resultBitmap;
 350         }
 351
 352         private Bitmap doFileInBackground() {
 353             File file = (File)mFile;
 354
 355             final String imageKey = String.valueOf(file.hashCode());
 356
 357             // Check disk cache in background thread
 358             Bitmap thumbnail = getBitmapFromDiskCache(imageKey);
 359
 360             // Not found in disk cache
 361             if (thumbnail == null) {
 362
 363                 int px = getThumbnailDimension();
 364
 365                 Bitmap bitmap = BitmapUtils.decodeSampledBitmapFromFile(
 366                         file.getAbsolutePath(), px, px);
 367
 368                 if (bitmap != null) {
 369                     thumbnail = addThumbnailToCache(imageKey, bitmap, file.getPath(), px);
 370                 }
 371             }
 372             return thumbnail;
 373         }
 374
 375     }
 376
 377     public static boolean cancelPotentialWork(Object file, ImageView imageView) {
 378         final ThumbnailGenerationTask bitmapWorkerTask = getBitmapWorkerTask(imageView);
 379
 380         if (bitmapWorkerTask != null) {
 381             final Object bitmapData = bitmapWorkerTask.mFile;
 382             // If bitmapData is not yet set or it differs from the new data
 383             if (bitmapData == null || bitmapData != file) {
 384                 // Cancel previous task
 385                 bitmapWorkerTask.cancel(true);
 386                 Log_OC.v(TAG, "Cancelled generation of thumbnail for a reused imageView");
 387             } else {
 388                 // The same work is already in progress
 389                 return false;
 390             }
 391         }
 392         // No task associated with the ImageView, or an existing task was cancelled
 393         return true;
 394     }
 395
 396     public static ThumbnailGenerationTask getBitmapWorkerTask(ImageView imageView) {
 397         if (imageView != null) {
 398             final Drawable drawable = imageView.getDrawable();
 399             if (drawable instanceof AsyncDrawable) {
 400                 final AsyncDrawable asyncDrawable = (AsyncDrawable) drawable;
 401                 return asyncDrawable.getBitmapWorkerTask();
 402             }
 403         }
 404         return null;
 405     }
 406
 407     public static class AsyncDrawable extends BitmapDrawable {
 408         private final WeakReference<ThumbnailGenerationTask> bitmapWorkerTaskReference;
 409
 410         public AsyncDrawable(
 411                 Resources res, Bitmap bitmap, ThumbnailGenerationTask bitmapWorkerTask
 412         ) {
 413
 414             super(res, bitmap);
 415             bitmapWorkerTaskReference =
 416                     new WeakReference<ThumbnailGenerationTask>(bitmapWorkerTask);
 417         }
 418
 419         public ThumbnailGenerationTask getBitmapWorkerTask() {
 420             return bitmapWorkerTaskReference.get();
 421         }
 422     }
 423 }