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.accounts.AccountManager;
  33 import android.content.Context;
  34 import android.content.res.Resources;
  35 import android.graphics.Bitmap;
  36 import android.graphics.Bitmap.CompressFormat;
  37 import android.graphics.BitmapFactory;
  38 import android.graphics.Canvas;
  39 import android.graphics.Point;
  40 import android.graphics.drawable.BitmapDrawable;
  41 import android.graphics.drawable.ColorDrawable;
  42 import android.graphics.drawable.Drawable;
  43 import android.media.ThumbnailUtils;
  44 import android.net.Uri;
  45 import android.os.AsyncTask;
  46 import android.view.Display;
  47 import android.view.View;
  48 import android.view.WindowManager;
  49 import android.widget.ImageView;
  50 import android.widget.ProgressBar;
  51
  52 import com.owncloud.android.MainApp;
  53 import com.owncloud.android.R;
  54 import com.owncloud.android.authentication.AccountUtils;
  55 import com.owncloud.android.lib.common.OwnCloudAccount;
  56 import com.owncloud.android.lib.common.OwnCloudClient;
  57 import com.owncloud.android.lib.common.OwnCloudClientManagerFactory;
  58 import com.owncloud.android.lib.common.utils.Log_OC;
  59 import com.owncloud.android.lib.resources.status.OwnCloudVersion;
  60 import com.owncloud.android.ui.adapter.DiskLruImageCache;
  61 import com.owncloud.android.utils.BitmapUtils;
  62 import com.owncloud.android.utils.DisplayUtils;
  63
  64 /**
  65  * Manager for concurrent access to thumbnails cache.
  66  */
  67 public class ThumbnailsCacheManager {
  68
  69     private static final String TAG = ThumbnailsCacheManager.class.getSimpleName();
  70
  71     private static final String CACHE_FOLDER = "thumbnailCache";
  72
  73     private static final Object mThumbnailsDiskCacheLock = new Object();
  74     private static DiskLruImageCache mThumbnailCache = null;
  75     private static boolean mThumbnailCacheStarting = true;
  76
  77     private static final int DISK_CACHE_SIZE = 1024 * 1024 * 10; // 10MB
  78     private static final CompressFormat mCompressFormat = CompressFormat.JPEG;
  79     private static final int mCompressQuality = 70;
  80     private static OwnCloudClient mClient = null;
  81
  82     public static Bitmap mDefaultImg =
  83             BitmapFactory.decodeResource(
  84                     MainApp.getAppContext().getResources(),
  85                     R.drawable.file_image
  86             );
  87
  88
  89     public static class InitDiskCacheTask extends AsyncTask<File, Void, Void> {
  90
  91         @Override
  92         protected Void doInBackground(File... params) {
  93             synchronized (mThumbnailsDiskCacheLock) {
  94                 mThumbnailCacheStarting = true;
  95
  96                 if (mThumbnailCache == null) {
  97                     try {
  98                         // Check if media is mounted or storage is built-in, if so,
  99                         // try and use external cache dir; otherwise use internal cache dir
 100                         final String cachePath =
 101                                 MainApp.getAppContext().getExternalCacheDir().getPath() +
 102                                 File.separator + CACHE_FOLDER;
 103                         Log_OC.d(TAG, "create dir: " + cachePath);
 104                         final File diskCacheDir = new File(cachePath);
 105                         mThumbnailCache = new DiskLruImageCache(
 106                                 diskCacheDir,
 107                                 DISK_CACHE_SIZE,
 108                                 mCompressFormat,
 109                                 mCompressQuality
 110                         );
 111                     } catch (Exception e) {
 112                         Log_OC.d(TAG, "Thumbnail cache could not be opened ", e);
 113                         mThumbnailCache = null;
 114                     }
 115                 }
 116                 mThumbnailCacheStarting = false; // Finished initialization
 117                 mThumbnailsDiskCacheLock.notifyAll(); // Wake any waiting threads
 118             }
 119             return null;
 120         }
 121     }
 122
 123
 124     public static void addBitmapToCache(String key, Bitmap bitmap) {
 125         synchronized (mThumbnailsDiskCacheLock) {
 126             if (mThumbnailCache != null) {
 127                 mThumbnailCache.put(key, bitmap);
 128             }
 129         }
 130     }
 131
 132
 133     public static Bitmap getBitmapFromDiskCache(String key) {
 134         synchronized (mThumbnailsDiskCacheLock) {
 135             // Wait while disk cache is started from background thread
 136             while (mThumbnailCacheStarting) {
 137                 try {
 138                     mThumbnailsDiskCacheLock.wait();
 139                 } catch (InterruptedException e) {
 140                     Log_OC.e(TAG, "Wait in mThumbnailsDiskCacheLock was interrupted", e);
 141                 }
 142             }
 143             if (mThumbnailCache != null) {
 144                 return mThumbnailCache.getBitmap(key);
 145             }
 146         }
 147         return null;
 148     }
 149
 150     public static class ThumbnailGenerationTask extends AsyncTask<Object, Void, Bitmap> {
 151         private final WeakReference<ImageView> mImageViewReference;
 152         private WeakReference<ProgressBar> mProgressWheelRef;
 153         private static Account mAccount;
 154         private Object mFile;
 155         private Boolean mIsThumbnail;
 156         private FileDataStorageManager mStorageManager;
 157
 158         public ThumbnailGenerationTask(ImageView imageView, FileDataStorageManager storageManager,
 159                                        Account account) {
 160             // Use a WeakReference to ensure the ImageView can be garbage collected
 161             mImageViewReference = new WeakReference<ImageView>(imageView);
 162             if (storageManager == null)
 163                 throw new IllegalArgumentException("storageManager must not be NULL");
 164             mStorageManager = storageManager;
 165             mAccount = account;
 166         }
 167
 168         public ThumbnailGenerationTask(ImageView imageView, FileDataStorageManager storageManager,
 169                                        Account account, ProgressBar progressWheel) {
 170         this(imageView, storageManager, account);
 171         mProgressWheelRef = new WeakReference<ProgressBar>(progressWheel);
 172         }
 173
 174         public ThumbnailGenerationTask(ImageView imageView) {
 175             // Use a WeakReference to ensure the ImageView can be garbage collected
 176             mImageViewReference = new WeakReference<ImageView>(imageView);
 177         }
 178
 179         @Override
 180         protected Bitmap doInBackground(Object... params) {
 181             Bitmap thumbnail = null;
 182
 183             try {
 184                 if (mAccount != null) {
 185                     OwnCloudAccount ocAccount = new OwnCloudAccount(mAccount,
 186                             MainApp.getAppContext());
 187                     mClient = OwnCloudClientManagerFactory.getDefaultSingleton().
 188                             getClientFor(ocAccount, MainApp.getAppContext());
 189                 }
 190
 191                 mFile = params[0];
 192                 mIsThumbnail = (Boolean) params[1];
 193
 194
 195                 if (mFile instanceof OCFile) {
 196                     thumbnail = doOCFileInBackground(mIsThumbnail);
 197                 }  else if (mFile instanceof File) {
 198                     thumbnail = doFileInBackground(mIsThumbnail);
 199                 } else {
 200                     // do nothing
 201                 }
 202
 203                 }catch(Throwable t){
 204                     // the app should never break due to a problem with thumbnails
 205                     Log_OC.e(TAG, "Generation of thumbnail for " + mFile + " failed", t);
 206                     if (t instanceof OutOfMemoryError) {
 207                         System.gc();
 208                     }
 209                 }
 210
 211             return thumbnail;
 212         }
 213
 214         protected void onPostExecute(Bitmap bitmap){
 215             if (bitmap != null) {
 216                 final ImageView imageView = mImageViewReference.get();
 217                 final ThumbnailGenerationTask bitmapWorkerTask = getBitmapWorkerTask(imageView);
 218                 if (this == bitmapWorkerTask) {
 219                     String tagId = "";
 220                     if (mFile instanceof OCFile){
 221                         tagId = String.valueOf(((OCFile)mFile).getFileId());
 222                     } else if (mFile instanceof File){
 223                         tagId = String.valueOf(mFile.hashCode());
 224                     }
 225                     if (String.valueOf(imageView.getTag()).equals(tagId)) {
 226                         if (mProgressWheelRef != null) {
 227                             final ProgressBar progressWheel = mProgressWheelRef.get();
 228                             if (progressWheel != null) {
 229                                 progressWheel.setVisibility(View.GONE);
 230                             }
 231                         }
 232                         imageView.setImageBitmap(bitmap);
 233                         imageView.setVisibility(View.VISIBLE);
 234                     }
 235                 }
 236             }
 237         }
 238
 239         /**
 240          * Add thumbnail to cache
 241          * @param imageKey: thumb key
 242          * @param bitmap:   image for extracting thumbnail
 243          * @param path:     image path
 244          * @param pxW:       thumbnail width
 245          * @param pxH:       thumbnail height
 246          * @return Bitmap
 247          */
 248         private Bitmap addThumbnailToCache(String imageKey, Bitmap bitmap, String path, int pxW, int pxH){
 249
 250             Bitmap thumbnail = ThumbnailUtils.extractThumbnail(bitmap, pxW, pxH);
 251
 252             // Rotate image, obeying exif tag
 253             thumbnail = BitmapUtils.rotateImage(thumbnail,path);
 254
 255             // Add thumbnail to cache
 256             addBitmapToCache(imageKey, thumbnail);
 257
 258             return thumbnail;
 259         }
 260
 261         /**
 262          * Converts size of file icon from dp to pixel
 263          * @return int
 264          */
 265         private int getThumbnailDimension(){
 266             // Converts dp to pixel
 267             Resources r = MainApp.getAppContext().getResources();
 268             return Math.round(r.getDimension(R.dimen.file_icon_size_grid));
 269         }
 270
 271         private Point getScreenDimension(){
 272             WindowManager wm = (WindowManager) MainApp.getAppContext().getSystemService(Context.WINDOW_SERVICE);
 273             Display display = wm.getDefaultDisplay();
 274             Point test = new Point();
 275             display.getSize(test);
 276             return test;
 277         }
 278
 279         private Bitmap doOCFileInBackground(Boolean isThumbnail) {
 280             Bitmap thumbnail = null;
 281             OCFile file = (OCFile)mFile;
 282
 283             // distinguish between thumbnail and resized image
 284             String temp = String.valueOf(file.getRemoteId());
 285             if (isThumbnail){
 286                 temp = "t" + temp;
 287             } else {
 288                 temp = "r" + temp;
 289             }
 290
 291             final String imageKey = temp;
 292
 293             // Check disk cache in background thread
 294             thumbnail = getBitmapFromDiskCache(imageKey);
 295
 296             // Not found in disk cache
 297             if (thumbnail == null || file.needsUpdateThumbnail()) {
 298                 int pxW = 0;
 299                 int pxH = 0;
 300                 if (mIsThumbnail) {
 301                     pxW = pxH = getThumbnailDimension();
 302                 } else {
 303                     Point p = getScreenDimension();
 304                     pxW = p.x;
 305                     pxH = p.y;
 306                 }
 307
 308                 if (file.isDown()) {
 309                     Bitmap tempBitmap = BitmapUtils.decodeSampledBitmapFromFile(
 310                             file.getStoragePath(), pxW, pxH);
 311                     Bitmap bitmap = ThumbnailUtils.extractThumbnail(tempBitmap, pxW, pxH);
 312
 313                     if (bitmap != null) {
 314                         // Handle PNG
 315                         if (file.getMimetype().equalsIgnoreCase("image/png")) {
 316                             bitmap = handlePNG(bitmap, pxW);
 317                         }
 318
 319                         thumbnail = addThumbnailToCache(imageKey, bitmap,
 320                                                         file.getStoragePath(), pxW, pxH);
 321
 322                         file.setNeedsUpdateThumbnail(false);
 323                         mStorageManager.saveFile(file);
 324                     }
 325
 326                 } else {
 327                     // Download thumbnail from server
 328                     OwnCloudVersion serverOCVersion = AccountUtils.getServerVersion(mAccount);
 329                     if (mClient != null && serverOCVersion != null) {
 330                         if (serverOCVersion.supportsRemoteThumbnails()) {
 331                             try {
 332                                 if (mIsThumbnail) {
 333                                     String uri = mClient.getBaseUri() + "" +
 334                                             "/index.php/apps/files/api/v1/thumbnail/" +
 335                                             pxW + "/" + pxH + Uri.encode(file.getRemotePath(), "/");
 336                                     Log_OC.d("Thumbnail", "Download URI: " + uri);
 337                                     GetMethod get = new GetMethod(uri);
 338                                     int status = mClient.executeMethod(get);
 339                                     if (status == HttpStatus.SC_OK) {
 340                                         InputStream inputStream = get.getResponseBodyAsStream();
 341                                         Bitmap bitmap = BitmapFactory.decodeStream(inputStream);
 342                                         thumbnail = ThumbnailUtils.extractThumbnail(bitmap, pxW, pxH);
 343                                     } else {
 344                                         Log_OC.d(TAG, "Status: " + status);
 345                                     }
 346                                 } else {
 347                                     String gallery = "";
 348                                     if (serverOCVersion.supportsNativeGallery()){
 349                                         gallery = "gallery";
 350                                     } else {
 351                                         gallery = "galleryplus";
 352                                     }
 353
 354                                     String uri = mClient.getBaseUri() +
 355                                             "/index.php/apps/" + gallery + "/api/preview/" + Integer.parseInt(file.getRemoteId().substring(0,8)) +
 356                                             "/" + pxW + "/" + pxH;
 357                                     Log_OC.d("Thumbnail", "FileName: " + file.getFileName() + " Download URI: " + uri);
 358                                     GetMethod get = new GetMethod(uri);
 359                                     int status = mClient.executeMethod(get);
 360                                     if (status == HttpStatus.SC_OK) {
 361                                         InputStream inputStream = get.getResponseBodyAsStream();
 362                                         Bitmap bitmap = BitmapFactory.decodeStream(inputStream);
 363                                         // Download via gallery app
 364                                         thumbnail = bitmap;
 365                                     }
 366                                 }
 367
 368                                 // Handle PNG
 369                                 if (thumbnail != null && file.getMimetype().equalsIgnoreCase("image/png")) {
 370                                     thumbnail = handlePNG(thumbnail, pxW);
 371                                 }
 372
 373                                 // Add thumbnail to cache
 374                                 if (thumbnail != null) {
 375                                     addBitmapToCache(imageKey, thumbnail);
 376                                 }
 377                             } catch (Exception e) {
 378                                 e.printStackTrace();
 379                             }
 380                         } else {
 381                             Log_OC.d(TAG, "Server too old");
 382                         }
 383                     }
 384                 }
 385             }
 386
 387             return thumbnail;
 388
 389         }
 390
 391         private Bitmap handlePNG(Bitmap bitmap, int px){
 392             Bitmap resultBitmap = Bitmap.createBitmap(px,
 393                     px,
 394                     Bitmap.Config.ARGB_8888);
 395             Canvas c = new Canvas(resultBitmap);
 396
 397             c.drawColor(MainApp.getAppContext().getResources().
 398                     getColor(R.color.background_color));
 399             c.drawBitmap(bitmap, 0, 0, null);
 400
 401             return resultBitmap;
 402         }
 403
 404         private Bitmap doFileInBackground(Boolean mIsThumbnail) {
 405             Bitmap thumbnail = null;
 406             File file = (File)mFile;
 407
 408             final String imageKey = String.valueOf(file.hashCode());
 409
 410             // Check disk cache in background thread
 411             thumbnail = getBitmapFromDiskCache(imageKey);
 412
 413             // Not found in disk cache
 414             if (thumbnail == null) {
 415                 int pxW = 0;
 416                 int pxH = 0;
 417                 if (mIsThumbnail) {
 418                     pxW = pxH = getThumbnailDimension();
 419                 } else {
 420                     Point p = getScreenDimension();
 421                     pxW = p.x;
 422                     pxH = p.y;
 423                 }
 424
 425                 Bitmap bitmap = BitmapUtils.decodeSampledBitmapFromFile(
 426                         file.getAbsolutePath(), pxW, pxH);
 427
 428                 if (bitmap != null) {
 429                     thumbnail = addThumbnailToCache(imageKey, bitmap, file.getPath(), pxW, pxH);
 430                 }
 431             }
 432             return thumbnail;
 433         }
 434
 435     }
 436
 437     public static boolean cancelPotentialWork(Object file, ImageView imageView) {
 438         final ThumbnailGenerationTask bitmapWorkerTask = getBitmapWorkerTask(imageView);
 439
 440         if (bitmapWorkerTask != null) {
 441             final Object bitmapData = bitmapWorkerTask.mFile;
 442             // If bitmapData is not yet set or it differs from the new data
 443             if (bitmapData == null || bitmapData != file) {
 444                 // Cancel previous task
 445                 bitmapWorkerTask.cancel(true);
 446                 Log_OC.v(TAG, "Cancelled generation of thumbnail for a reused imageView");
 447             } else {
 448                 // The same work is already in progress
 449                 return false;
 450             }
 451         }
 452         // No task associated with the ImageView, or an existing task was cancelled
 453         return true;
 454     }
 455
 456     public static ThumbnailGenerationTask getBitmapWorkerTask(ImageView imageView) {
 457         if (imageView != null) {
 458             final Drawable drawable = imageView.getDrawable();
 459             if (drawable instanceof AsyncDrawable) {
 460                 final AsyncDrawable asyncDrawable = (AsyncDrawable) drawable;
 461                 return asyncDrawable.getBitmapWorkerTask();
 462             }
 463         }
 464         return null;
 465     }
 466
 467     public static class AsyncDrawable extends BitmapDrawable {
 468         private final WeakReference<ThumbnailGenerationTask> bitmapWorkerTaskReference;
 469
 470         public AsyncDrawable(
 471                 Resources res, Bitmap bitmap, ThumbnailGenerationTask bitmapWorkerTask
 472         ) {
 473
 474             super(res, bitmap);
 475             bitmapWorkerTaskReference =
 476                     new WeakReference<ThumbnailGenerationTask>(bitmapWorkerTask);
 477         }
 478
 479         public ThumbnailGenerationTask getBitmapWorkerTask() {
 480             return bitmapWorkerTaskReference.get();
 481         }
 482     }
 483 }