src/com/owncloud/android/ui/adapter/FileListListAdapter.java

   1 /* ownCloud Android client application
   2  *   Copyright (C) 2011  Bartek Przybylski
   3  *   Copyright (C) 2012-2014 ownCloud Inc.
   4  *
   5  *   This program is free software: you can redistribute it and/or modify
   6  *   it under the terms of the GNU General Public License version 2,
   7  *   as published by the Free Software Foundation.
   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 package com.owncloud.android.ui.adapter;
  19
  20 import java.io.File;
  21 import java.lang.ref.WeakReference;
  22 import java.util.Vector;
  23
  24 import android.accounts.Account;
  25 import android.content.Context;
  26 import android.content.res.Resources;
  27 import android.graphics.Bitmap;
  28 import android.graphics.Bitmap.CompressFormat;
  29 import android.graphics.BitmapFactory;
  30 import android.graphics.drawable.BitmapDrawable;
  31 import android.graphics.drawable.Drawable;
  32 import android.media.ThumbnailUtils;
  33 import android.os.AsyncTask;
  34 import android.util.TypedValue;
  35 import android.view.LayoutInflater;
  36 import android.view.View;
  37 import android.view.ViewGroup;
  38 import android.widget.BaseAdapter;
  39 import android.widget.ImageView;
  40 import android.widget.ListAdapter;
  41 import android.widget.ListView;
  42 import android.widget.TextView;
  43
  44 import com.owncloud.android.R;
  45 import com.owncloud.android.authentication.AccountUtils;
  46 import com.owncloud.android.datamodel.FileDataStorageManager;
  47 import com.owncloud.android.datamodel.OCFile;
  48 import com.owncloud.android.files.services.FileDownloader.FileDownloaderBinder;
  49 import com.owncloud.android.files.services.FileUploader.FileUploaderBinder;
  50 import com.owncloud.android.ui.activity.ComponentsGetter;
  51 import com.owncloud.android.utils.BitmapUtils;
  52 import com.owncloud.android.utils.DisplayUtils;
  53 import com.owncloud.android.utils.Log_OC;
  54
  55
  56 /**
  57  * This Adapter populates a ListView with all files and folders in an ownCloud
  58  * instance.
  59  *
  60  * @author Bartek Przybylski
  61  * @author Tobias Kaminsky
  62  * @author David A. Velasco
  63  */
  64 public class FileListListAdapter extends BaseAdapter implements ListAdapter {
  65     private final static String PERMISSION_SHARED_WITH_ME = "S";
  66
  67     private static final String TAG = FileListListAdapter.class.getSimpleName();
  68
  69     private Context mContext;
  70     private OCFile mFile = null;
  71     private Vector<OCFile> mFiles = null;
  72     private boolean mJustFolders;
  73
  74     private FileDataStorageManager mStorageManager;
  75     private Account mAccount;
  76     private ComponentsGetter mTransferServiceGetter;
  77
  78     private final Object thumbnailDiskCacheLock = new Object();
  79     private DiskLruImageCache mThumbnailCache;
  80     private boolean mThumbnailCacheStarting = true;
  81     private static final int DISK_CACHE_SIZE = 1024 * 1024 * 10; // 10MB
  82     private static final CompressFormat mCompressFormat = CompressFormat.JPEG;
  83     private static final int mCompressQuality = 70;
  84     private Bitmap defaultImg;
  85
  86     public FileListListAdapter(
  87             boolean justFolders,
  88             Context context,
  89             ComponentsGetter transferServiceGetter
  90             ) {
  91
  92         mJustFolders = justFolders;
  93         mContext = context;
  94         mAccount = AccountUtils.getCurrentOwnCloudAccount(mContext);
  95         mTransferServiceGetter = transferServiceGetter;
  96         defaultImg = BitmapFactory.decodeResource(mContext.getResources(),
  97                     DisplayUtils.getResourceId("image/png", "default.png"));
  98
  99         // Initialise disk cache on background thread
 100         new InitDiskCacheTask().execute();
 101     }
 102
 103     class InitDiskCacheTask extends AsyncTask<File, Void, Void> {
 104         @Override
 105         protected Void doInBackground(File... params) {
 106             synchronized (thumbnailDiskCacheLock) {
 107                 try {
 108                     mThumbnailCache = new DiskLruImageCache(mContext, "thumbnailCache",
 109                                         DISK_CACHE_SIZE, mCompressFormat, mCompressQuality);
 110                 } catch (Exception e) {
 111                     Log_OC.d(TAG, "Thumbnail cache could not be opened ", e);
 112                     mThumbnailCache = null;
 113                 }
 114                 mThumbnailCacheStarting = false; // Finished initialization
 115                 thumbnailDiskCacheLock.notifyAll(); // Wake any waiting threads
 116             }
 117             return null;
 118         }
 119     }
 120
 121     static class AsyncDrawable extends BitmapDrawable {
 122         private final WeakReference<ThumbnailGenerationTask> bitmapWorkerTaskReference;
 123
 124         public AsyncDrawable(Resources res, Bitmap bitmap,
 125                 ThumbnailGenerationTask bitmapWorkerTask) {
 126             super(res, bitmap);
 127             bitmapWorkerTaskReference =
 128                 new WeakReference<ThumbnailGenerationTask>(bitmapWorkerTask);
 129         }
 130
 131         public ThumbnailGenerationTask getBitmapWorkerTask() {
 132             return bitmapWorkerTaskReference.get();
 133         }
 134     }
 135
 136     class ThumbnailGenerationTask extends AsyncTask<OCFile, Void, Bitmap> {
 137         private final WeakReference<ImageView> imageViewReference;
 138         private OCFile file;
 139
 140
 141         public ThumbnailGenerationTask(ImageView imageView) {
 142          // Use a WeakReference to ensure the ImageView can be garbage collected
 143             imageViewReference = new WeakReference<ImageView>(imageView);
 144         }
 145
 146         // Decode image in background.
 147         @Override
 148         protected Bitmap doInBackground(OCFile... params) {
 149             Bitmap thumbnail = null;
 150
 151             try {
 152                 file = params[0];
 153                 final String imageKey = String.valueOf(file.getRemoteId());
 154
 155                 // Check disk cache in background thread
 156                 thumbnail = getBitmapFromDiskCache(imageKey);
 157
 158                 // Not found in disk cache
 159                 if (thumbnail == null || file.needsUpdateThumbnail()) {
 160                     // Converts dp to pixel
 161                     Resources r = mContext.getResources();
 162                     int px = (int) Math.round(TypedValue.applyDimension(
 163                             TypedValue.COMPLEX_UNIT_DIP, 150, r.getDisplayMetrics()
 164                     ));
 165
 166                     if (file.isDown()){
 167                         Bitmap bitmap = BitmapUtils.decodeSampledBitmapFromFile(
 168                                 file.getStoragePath(), px, px);
 169
 170                         if (bitmap != null) {
 171                             thumbnail = ThumbnailUtils.extractThumbnail(bitmap, px, px);
 172
 173                             // Add thumbnail to cache
 174                             addBitmapToCache(imageKey, thumbnail);
 175
 176                             file.setNeedsUpdateThumbnail(false);
 177                             mStorageManager.saveFile(file);
 178                         }
 179
 180                     }
 181                 }
 182
 183             } catch (Throwable t) {
 184                 // the app should never break due to a problem with thumbnails
 185                 Log_OC.e(TAG, "Generation of thumbnail for " + file + " failed", t);
 186                 if (t instanceof OutOfMemoryError) {
 187                     System.gc();
 188                 }
 189             }
 190
 191             return thumbnail;
 192         }
 193
 194         protected void onPostExecute(Bitmap bitmap){
 195             if (isCancelled()) {
 196                 bitmap = null;
 197             }
 198
 199             if (imageViewReference != null && bitmap != null) {
 200                 final ImageView imageView = imageViewReference.get();
 201                 final ThumbnailGenerationTask bitmapWorkerTask =
 202                         getBitmapWorkerTask(imageView);
 203                 if (this == bitmapWorkerTask && imageView != null) {
 204                     imageView.setImageBitmap(bitmap);
 205                 }
 206             }
 207         }
 208     }
 209
 210     public void addBitmapToCache(String key, Bitmap bitmap) {
 211         synchronized (thumbnailDiskCacheLock) {
 212             if (mThumbnailCache != null) {
 213                 mThumbnailCache.put(key, bitmap);
 214             }
 215         }
 216     }
 217
 218     public Bitmap getBitmapFromDiskCache(String key) {
 219         synchronized (thumbnailDiskCacheLock) {
 220             // Wait while disk cache is started from background thread
 221             while (mThumbnailCacheStarting) {
 222                 try {
 223                     thumbnailDiskCacheLock.wait();
 224                 } catch (InterruptedException e) {}
 225             }
 226             if (mThumbnailCache != null) {
 227                 return (Bitmap) mThumbnailCache.getBitmap(key);
 228             }
 229         }
 230         return null;
 231     }
 232
 233     @Override
 234     public boolean areAllItemsEnabled() {
 235         return true;
 236     }
 237
 238     @Override
 239     public boolean isEnabled(int position) {
 240         return true;
 241     }
 242
 243     @Override
 244     public int getCount() {
 245         return mFiles != null ? mFiles.size() : 0;
 246     }
 247
 248     @Override
 249     public Object getItem(int position) {
 250         if (mFiles == null || mFiles.size() <= position)
 251             return null;
 252         return mFiles.get(position);
 253     }
 254
 255     @Override
 256     public long getItemId(int position) {
 257         if (mFiles == null || mFiles.size() <= position)
 258             return 0;
 259         return mFiles.get(position).getFileId();
 260     }
 261
 262     @Override
 263     public int getItemViewType(int position) {
 264         return 0;
 265     }
 266
 267     @Override
 268     public View getView(int position, View convertView, ViewGroup parent) {
 269         View view = convertView;
 270         if (view == null) {
 271             LayoutInflater inflator = (LayoutInflater) mContext
 272                     .getSystemService(Context.LAYOUT_INFLATER_SERVICE);
 273             view = inflator.inflate(R.layout.list_item, null);
 274         }
 275
 276         if (mFiles != null && mFiles.size() > position) {
 277             OCFile file = mFiles.get(position);
 278             TextView fileName = (TextView) view.findViewById(R.id.Filename);
 279             String name = file.getFileName();
 280
 281             fileName.setText(name);
 282             ImageView fileIcon = (ImageView) view.findViewById(R.id.imageView1);
 283             ImageView sharedIconV = (ImageView) view.findViewById(R.id.sharedIcon);
 284             ImageView sharedWithMeIconV = (ImageView) view.findViewById(R.id.sharedWithMeIcon);
 285             sharedWithMeIconV.setVisibility(View.GONE);
 286
 287             ImageView localStateView = (ImageView) view.findViewById(R.id.imageView2);
 288             localStateView.bringToFront();
 289             FileDownloaderBinder downloaderBinder =
 290                     mTransferServiceGetter.getFileDownloaderBinder();
 291             FileUploaderBinder uploaderBinder = mTransferServiceGetter.getFileUploaderBinder();
 292             if (downloaderBinder != null && downloaderBinder.isDownloading(mAccount, file)) {
 293                 localStateView.setImageResource(R.drawable.downloading_file_indicator);
 294                 localStateView.setVisibility(View.VISIBLE);
 295             } else if (uploaderBinder != null && uploaderBinder.isUploading(mAccount, file)) {
 296                 localStateView.setImageResource(R.drawable.uploading_file_indicator);
 297                 localStateView.setVisibility(View.VISIBLE);
 298             } else if (file.isDown()) {
 299                 localStateView.setImageResource(R.drawable.local_file_indicator);
 300                 localStateView.setVisibility(View.VISIBLE);
 301             } else {
 302                 localStateView.setVisibility(View.INVISIBLE);
 303             }
 304
 305             TextView fileSizeV = (TextView) view.findViewById(R.id.file_size);
 306             TextView lastModV = (TextView) view.findViewById(R.id.last_mod);
 307             ImageView checkBoxV = (ImageView) view.findViewById(R.id.custom_checkbox);
 308
 309             if (!file.isFolder()) {
 310                 fileSizeV.setVisibility(View.VISIBLE);
 311                 fileSizeV.setText(DisplayUtils.bytesToHumanReadable(file.getFileLength()));
 312                 lastModV.setVisibility(View.VISIBLE);
 313                 lastModV.setText(
 314                         DisplayUtils.unixTimeToHumanReadable(file.getModificationTimestamp())
 315                 );
 316                 // this if-else is needed even thoe fav icon is visible by default
 317                 // because android reuses views in listview
 318                 if (!file.keepInSync()) {
 319                     view.findViewById(R.id.imageView3).setVisibility(View.GONE);
 320                 } else {
 321                     view.findViewById(R.id.imageView3).setVisibility(View.VISIBLE);
 322                 }
 323
 324                 ListView parentList = (ListView)parent;
 325                 if (parentList.getChoiceMode() == ListView.CHOICE_MODE_NONE) {
 326                     checkBoxV.setVisibility(View.GONE);
 327                 } else {
 328                     if (parentList.isItemChecked(position)) {
 329                         checkBoxV.setImageResource(android.R.drawable.checkbox_on_background);
 330                     } else {
 331                         checkBoxV.setImageResource(android.R.drawable.checkbox_off_background);
 332                     }
 333                     checkBoxV.setVisibility(View.VISIBLE);
 334                 }
 335
 336                 // get Thumbnail if file is image
 337                 if (file.isImage()){
 338                      // Thumbnail in Cache?
 339                     Bitmap thumbnail = getBitmapFromDiskCache(String.valueOf(file.getRemoteId()));
 340                     if (thumbnail != null && !file.needsUpdateThumbnail()){
 341                         fileIcon.setImageBitmap(thumbnail);
 342                     } else {
 343                         // generate new Thumbnail
 344                         if (cancelPotentialWork(file, fileIcon)) {
 345                             final ThumbnailGenerationTask task =
 346                                     new ThumbnailGenerationTask(fileIcon);
 347                             final AsyncDrawable asyncDrawable =
 348                                     new AsyncDrawable(mContext.getResources(), defaultImg, task);
 349                             fileIcon.setImageDrawable(asyncDrawable);
 350                             task.execute(file);
 351                         }
 352                     }
 353                 } else {
 354                     fileIcon.setImageResource(
 355                             DisplayUtils.getResourceId(file.getMimetype(), file.getFileName())
 356                     );
 357                 }
 358
 359                 if (checkIfFileIsSharedWithMe(file)) {
 360                     sharedWithMeIconV.setVisibility(View.VISIBLE);
 361                 }
 362             }
 363             else {
 364                 fileSizeV.setVisibility(View.INVISIBLE);
 365                 //fileSizeV.setText(DisplayUtils.bytesToHumanReadable(file.getFileLength()));
 366                 lastModV.setVisibility(View.VISIBLE);
 367                 lastModV.setText(
 368                         DisplayUtils.unixTimeToHumanReadable(file.getModificationTimestamp())
 369                 );
 370                 checkBoxV.setVisibility(View.GONE);
 371                 view.findViewById(R.id.imageView3).setVisibility(View.GONE);
 372
 373                 if (checkIfFileIsSharedWithMe(file)) {
 374                     fileIcon.setImageResource(R.drawable.shared_with_me_folder);
 375                     sharedWithMeIconV.setVisibility(View.VISIBLE);
 376                 } else {
 377                     fileIcon.setImageResource(
 378                             DisplayUtils.getResourceId(file.getMimetype(), file.getFileName())
 379                     );
 380                 }
 381
 382                 // If folder is sharedByLink, icon folder must be changed to
 383                 // folder-public one
 384                 if (file.isShareByLink()) {
 385                     fileIcon.setImageResource(R.drawable.folder_public);
 386                 }
 387             }
 388
 389             if (file.isShareByLink()) {
 390                 sharedIconV.setVisibility(View.VISIBLE);
 391             } else {
 392                 sharedIconV.setVisibility(View.GONE);
 393             }
 394         }
 395
 396         return view;
 397     }
 398
 399     public static boolean cancelPotentialWork(OCFile file, ImageView imageView) {
 400         final ThumbnailGenerationTask bitmapWorkerTask = getBitmapWorkerTask(imageView);
 401
 402         if (bitmapWorkerTask != null) {
 403             final OCFile bitmapData = bitmapWorkerTask.file;
 404             // If bitmapData is not yet set or it differs from the new data
 405             if (bitmapData == null || bitmapData != file) {
 406                 // Cancel previous task
 407                 bitmapWorkerTask.cancel(true);
 408             } else {
 409                 // The same work is already in progress
 410                 return false;
 411             }
 412         }
 413         // No task associated with the ImageView, or an existing task was cancelled
 414         return true;
 415     }
 416
 417     private static ThumbnailGenerationTask getBitmapWorkerTask(ImageView imageView) {
 418         if (imageView != null) {
 419             final Drawable drawable = imageView.getDrawable();
 420             if (drawable instanceof AsyncDrawable) {
 421                 final AsyncDrawable asyncDrawable = (AsyncDrawable) drawable;
 422                 return asyncDrawable.getBitmapWorkerTask();
 423             }
 424          }
 425          return null;
 426      }
 427
 428     @Override
 429     public int getViewTypeCount() {
 430         return 1;
 431     }
 432
 433     @Override
 434     public boolean hasStableIds() {
 435         return true;
 436     }
 437
 438     @Override
 439     public boolean isEmpty() {
 440         return (mFiles == null || mFiles.isEmpty());
 441     }
 442
 443     /**
 444      * Change the adapted directory for a new one
 445      * @param directory                 New file to adapt. Can be NULL, meaning
 446      *                                  "no content to adapt".
 447      * @param updatedStorageManager     Optional updated storage manager; used to replace
 448      *                                  mStorageManager if is different (and not NULL)
 449      */
 450     public void swapDirectory(OCFile directory, FileDataStorageManager updatedStorageManager) {
 451         mFile = directory;
 452         if (updatedStorageManager != null && updatedStorageManager != mStorageManager) {
 453             mStorageManager = updatedStorageManager;
 454             mAccount = AccountUtils.getCurrentOwnCloudAccount(mContext);
 455         }
 456         if (mStorageManager != null) {
 457             mFiles = mStorageManager.getFolderContent(mFile);
 458             if (mJustFolders) {
 459                 mFiles = getFolders(mFiles);
 460             }
 461         } else {
 462             mFiles = null;
 463         }
 464         notifyDataSetChanged();
 465     }
 466
 467
 468     /**
 469      * Filter for getting only the folders
 470      * @param files
 471      * @return Vector<OCFile>
 472      */
 473     public Vector<OCFile> getFolders(Vector<OCFile> files) {
 474         Vector<OCFile> ret = new Vector<OCFile>();
 475         OCFile current = null;
 476         for (int i=0; i<files.size(); i++) {
 477             current = files.get(i);
 478             if (current.isFolder()) {
 479                 ret.add(current);
 480             }
 481         }
 482         return ret;
 483     }
 484
 485
 486     /**
 487      * Check if parent folder does not include 'S' permission and if file/folder
 488      * is shared with me
 489      *
 490      * @param file: OCFile
 491      * @return boolean: True if it is shared with me and false if it is not
 492      */
 493     private boolean checkIfFileIsSharedWithMe(OCFile file) {
 494         return (mFile.getPermissions() != null
 495                 && !mFile.getPermissions().contains(PERMISSION_SHARED_WITH_ME)
 496                 && file.getPermissions() != null
 497                 && file.getPermissions().contains(PERMISSION_SHARED_WITH_ME));
 498     }
 499 }