src/com/owncloud/android/ui/preview/PreviewImageFragment.java

   1 /**
   2  *   ownCloud Android client application
   3  *
   4  *   @author David A. Velasco
   5  *   Copyright (C) 2015 ownCloud Inc.
   6  *
   7  *   This program is free software: you can redistribute it and/or modify
   8  *   it under the terms of the GNU General Public License version 2,
   9  *   as published by the Free Software Foundation.
  10  *
  11  *   This program is distributed in the hope that it will be useful,
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *   GNU General Public License for more details.
  15  *
  16  *   You should have received a copy of the GNU General Public License
  17  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  *
  19  */
  20 package com.owncloud.android.ui.preview;
  21
  22 import java.lang.ref.WeakReference;
  23
  24 import android.accounts.Account;
  25 import android.annotation.SuppressLint;
  26 import android.app.Activity;
  27 import android.graphics.Bitmap;
  28 import android.graphics.Point;
  29 import android.graphics.drawable.Drawable;
  30 import android.os.AsyncTask;
  31 import android.os.Bundle;
  32 import android.support.v4.app.FragmentStatePagerAdapter;
  33 import android.view.LayoutInflater;
  34 import android.view.Menu;
  35 import android.view.MenuInflater;
  36 import android.view.MenuItem;
  37 import android.view.View;
  38 import android.view.View.OnClickListener;
  39 import android.view.ViewGroup;
  40 import android.widget.ImageView;
  41 import android.widget.ProgressBar;
  42 import android.widget.TextView;
  43
  44 import com.owncloud.android.MainApp;
  45 import com.owncloud.android.R;
  46 import com.owncloud.android.datamodel.OCFile;
  47 import com.owncloud.android.datamodel.ThumbnailsCacheManager;
  48 import com.owncloud.android.files.FileMenuFilter;
  49 import com.owncloud.android.lib.common.utils.Log_OC;
  50 import com.owncloud.android.ui.dialog.ConfirmationDialogFragment;
  51 import com.owncloud.android.ui.dialog.RemoveFileDialogFragment;
  52 import com.owncloud.android.ui.fragment.FileFragment;
  53 import com.owncloud.android.utils.BitmapUtils;
  54 import com.owncloud.android.utils.DisplayUtils;
  55
  56 import third_parties.michaelOrtiz.TouchImageViewCustom;
  57
  58
  59 /**
  60  * This fragment shows a preview of a downloaded image.
  61  *
  62  * Trying to get an instance with a NULL {@link OCFile} will produce an
  63  * {@link IllegalStateException}.
  64  *
  65  * If the {@link OCFile} passed is not downloaded, an {@link IllegalStateException} is generated on
  66  * instantiation too.
  67  */
  68 public class PreviewImageFragment extends FileFragment {
  69
  70     public static final String EXTRA_FILE = "FILE";
  71
  72     private static final String ARG_FILE = "FILE";
  73     private static final String ARG_IGNORE_FIRST = "IGNORE_FIRST";
  74     private static final String ARG_SHOW_RESIZED_IMAGE = "SHOW_RESIZED_IMAGE";
  75
  76     private TouchImageViewCustom mImageView;
  77     private TextView mMessageView;
  78     private ProgressBar mProgressWheel;
  79
  80     private Boolean mShowResizedImage = false;
  81
  82     public Bitmap mBitmap = null;
  83
  84     private static final String TAG = PreviewImageFragment.class.getSimpleName();
  85
  86     private boolean mIgnoreFirstSavedState;
  87
  88     private LoadBitmapTask mLoadBitmapTask = null;
  89
  90
  91     /**
  92      * Public factory method to create a new fragment that previews an image.
  93      *
  94      * Android strongly recommends keep the empty constructor of fragments as the only public
  95      * constructor, and
  96      * use {@link #setArguments(Bundle)} to set the needed arguments.
  97      *
  98      * This method hides to client objects the need of doing the construction in two steps.
  99      *
 100      * @param imageFile                 An {@link OCFile} to preview as an image in the fragment
 101      * @param ignoreFirstSavedState     Flag to work around an unexpected behaviour of
 102      *                                  {@link FragmentStatePagerAdapter}
 103      *                                  ; TODO better solution
 104      */
 105     public static PreviewImageFragment newInstance(OCFile imageFile, boolean ignoreFirstSavedState,
 106             boolean showResizedImage){
 107         PreviewImageFragment frag = new PreviewImageFragment();
 108         frag.mShowResizedImage = showResizedImage;
 109         Bundle args = new Bundle();
 110         args.putParcelable(ARG_FILE, imageFile);
 111         args.putBoolean(ARG_IGNORE_FIRST, ignoreFirstSavedState);
 112         args.putBoolean(ARG_SHOW_RESIZED_IMAGE, showResizedImage);
 113         frag.setArguments(args);
 114         return frag;
 115     }
 116
 117
 118
 119     /**
 120      *  Creates an empty fragment for image previews.
 121      *
 122      *  MUST BE KEPT: the system uses it when tries to reinstantiate a fragment automatically
 123      *  (for instance, when the device is turned a aside).
 124      *
 125      *  DO NOT CALL IT: an {@link OCFile} and {@link Account} must be provided for a successful
 126      *  construction
 127      */
 128     public PreviewImageFragment() {
 129         mIgnoreFirstSavedState = false;
 130     }
 131
 132
 133     /**
 134      * {@inheritDoc}
 135      */
 136     @Override
 137     public void onCreate(Bundle savedInstanceState) {
 138         super.onCreate(savedInstanceState);
 139         Bundle args = getArguments();
 140         setFile((OCFile)args.getParcelable(ARG_FILE));
 141             // TODO better in super, but needs to check ALL the class extending FileFragment;
 142             // not right now
 143
 144         mIgnoreFirstSavedState = args.getBoolean(ARG_IGNORE_FIRST);
 145         mShowResizedImage = args.getBoolean(ARG_SHOW_RESIZED_IMAGE);
 146         setHasOptionsMenu(true);
 147     }
 148
 149
 150     /**
 151      * {@inheritDoc}
 152      */
 153     @Override
 154     public View onCreateView(LayoutInflater inflater, ViewGroup container,
 155                              Bundle savedInstanceState) {
 156         super.onCreateView(inflater, container, savedInstanceState);
 157         View view = inflater.inflate(R.layout.preview_image_fragment, container, false);
 158         mImageView = (TouchImageViewCustom) view.findViewById(R.id.image);
 159         mImageView.setVisibility(View.GONE);
 160         mImageView.setOnClickListener(new OnClickListener() {
 161             @Override
 162             public void onClick(View v) {
 163                 ((PreviewImageActivity) getActivity()).toggleFullScreen();
 164             }
 165
 166         });
 167         mMessageView = (TextView)view.findViewById(R.id.message);
 168         mMessageView.setVisibility(View.GONE);
 169         mProgressWheel = (ProgressBar)view.findViewById(R.id.progressWheel);
 170         mProgressWheel.setVisibility(View.VISIBLE);
 171         return view;
 172     }
 173
 174     /**
 175      * {@inheritDoc}
 176      */
 177     @Override
 178     public void onActivityCreated(Bundle savedInstanceState) {
 179         super.onActivityCreated(savedInstanceState);
 180         if (savedInstanceState != null) {
 181             if (!mIgnoreFirstSavedState) {
 182                 OCFile file = savedInstanceState.getParcelable(PreviewImageFragment.EXTRA_FILE);
 183                 setFile(file);
 184             } else {
 185                 mIgnoreFirstSavedState = false;
 186             }
 187         }
 188         if (getFile() == null) {
 189             throw new IllegalStateException("Instanced with a NULL OCFile");
 190         }
 191     }
 192
 193
 194     /**
 195      * {@inheritDoc}
 196      */
 197     @Override
 198     public void onSaveInstanceState(Bundle outState) {
 199         super.onSaveInstanceState(outState);
 200         outState.putParcelable(PreviewImageFragment.EXTRA_FILE, getFile());
 201     }
 202
 203
 204     @Override
 205     public void onStart() {
 206         super.onStart();
 207         if (getFile() != null) {
 208             mImageView.setTag(getFile().getFileId());
 209
 210             if (mShowResizedImage){
 211                 Bitmap resizedImage = ThumbnailsCacheManager.getBitmapFromDiskCache(
 212                         String.valueOf("r" + getFile().getRemoteId()));
 213
 214                 if (resizedImage != null && !getFile().needsUpdateThumbnail()){
 215                     mProgressWheel.setVisibility(View.GONE);
 216                     mImageView.setImageBitmap(resizedImage);
 217                     mImageView.setVisibility(View.VISIBLE);
 218                     mBitmap  = resizedImage;
 219                 } else {
 220                     // show thumbnail while loading resized image
 221                     Bitmap thumbnail = ThumbnailsCacheManager.getBitmapFromDiskCache(
 222                             String.valueOf("t" + getFile().getRemoteId()));
 223
 224                     if (thumbnail != null){
 225                         mImageView.setImageBitmap(thumbnail);
 226                         mProgressWheel.setVisibility(View.VISIBLE);
 227                         mImageView.setVisibility(View.VISIBLE);
 228                         mBitmap = thumbnail;
 229                     } else {
 230                         thumbnail = ThumbnailsCacheManager.mDefaultImg;
 231                     }
 232
 233                     // generate new resized image
 234                     if (ThumbnailsCacheManager.cancelPotentialWork(getFile(), mImageView) &&
 235                         mContainerActivity.getStorageManager() != null) {
 236                         final ThumbnailsCacheManager.ThumbnailGenerationTask task =
 237                                 new ThumbnailsCacheManager.ThumbnailGenerationTask(
 238                                         mImageView, mContainerActivity.getStorageManager(),
 239                                         mContainerActivity.getStorageManager().getAccount(),
 240                                         mProgressWheel);
 241                         if (resizedImage == null) {
 242                             resizedImage = thumbnail;
 243                         }
 244                         final ThumbnailsCacheManager.AsyncDrawable asyncDrawable =
 245                                 new ThumbnailsCacheManager.AsyncDrawable(
 246                                         MainApp.getAppContext().getResources(),
 247                                         resizedImage,
 248                                         task
 249                                 );
 250                         mImageView.setImageDrawable(asyncDrawable);
 251                         task.execute(getFile(), false);
 252                     }
 253             }
 254             } else {
 255                 mLoadBitmapTask = new LoadBitmapTask(mImageView, mMessageView, mProgressWheel);
 256                 mLoadBitmapTask.execute(getFile());
 257             }
 258         }
 259     }
 260
 261
 262     @Override
 263     public void onStop() {
 264         Log_OC.d(TAG, "onStop starts");
 265         if (mLoadBitmapTask != null) {
 266             mLoadBitmapTask.cancel(true);
 267             mLoadBitmapTask = null;
 268         }
 269         super.onStop();
 270     }
 271
 272     /**
 273      * {@inheritDoc}
 274      */
 275     @Override
 276     public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
 277         super.onCreateOptionsMenu(menu, inflater);
 278         inflater.inflate(R.menu.file_actions_menu, menu);
 279
 280 //        MenuItem item = menu.findItem(R.id.action_set_as_wallpaper);
 281 //        item.setVisible(getFile().isDown());
 282     }
 283
 284     /**
 285      * {@inheritDoc}
 286      */
 287     @Override
 288     public void onPrepareOptionsMenu(Menu menu) {
 289         super.onPrepareOptionsMenu(menu);
 290
 291         if (mContainerActivity.getStorageManager() != null) {
 292             // Update the file
 293             setFile(mContainerActivity.getStorageManager().getFileById(getFile().getFileId()));
 294
 295             FileMenuFilter mf = new FileMenuFilter(
 296                 getFile(),
 297                 mContainerActivity.getStorageManager().getAccount(),
 298                 mContainerActivity,
 299                 getActivity()
 300             );
 301             mf.filter(menu);
 302         }
 303
 304         // additional restriction for this fragment
 305         // TODO allow renaming in PreviewImageFragment
 306         MenuItem item = menu.findItem(R.id.action_rename_file);
 307         if (item != null) {
 308             item.setVisible(false);
 309             item.setEnabled(false);
 310         }
 311
 312         // additional restriction for this fragment
 313         // TODO allow refresh file in PreviewImageFragment
 314         item = menu.findItem(R.id.action_sync_file);
 315         if (item != null) {
 316             item.setVisible(false);
 317             item.setEnabled(false);
 318         }
 319
 320         // additional restriction for this fragment
 321         item = menu.findItem(R.id.action_move);
 322         if (item != null) {
 323             item.setVisible(false);
 324             item.setEnabled(false);
 325         }
 326
 327         // additional restriction for this fragment
 328         item = menu.findItem(R.id.action_copy);
 329         if (item != null) {
 330             item.setVisible(false);
 331             item.setEnabled(false);
 332         }
 333
 334     }
 335
 336
 337     /**
 338      * {@inheritDoc}
 339      */
 340     @Override
 341     public boolean onOptionsItemSelected(MenuItem item) {
 342         switch (item.getItemId()) {
 343             case R.id.action_share_file: {
 344                 mContainerActivity.getFileOperationsHelper().shareFileWithLink(getFile());
 345                 return true;
 346             }
 347             case R.id.action_share_with_users: {
 348                 mContainerActivity.getFileOperationsHelper().showShareFile(getFile());
 349                 return true;
 350             }
 351             case R.id.action_unshare_file: {
 352                 mContainerActivity.getFileOperationsHelper().unshareFileWithLink(getFile());
 353                 return true;
 354             }
 355             case R.id.action_open_file_with: {
 356                 openFile();
 357                 return true;
 358             }
 359             case R.id.action_remove_file: {
 360                 RemoveFileDialogFragment dialog = RemoveFileDialogFragment.newInstance(getFile());
 361                 dialog.show(getFragmentManager(), ConfirmationDialogFragment.FTAG_CONFIRMATION);
 362                 return true;
 363             }
 364             case R.id.action_see_details: {
 365                 seeDetails();
 366                 return true;
 367             }
 368             case R.id.action_send_file: {
 369                 if (getFile().isImage() && !getFile().isDown()){
 370                     mContainerActivity.getFileOperationsHelper().sendCachedImage(getFile());
 371                     return true;
 372                 } else {
 373                     mContainerActivity.getFileOperationsHelper().sendDownloadedFile(getFile());
 374                     return true;
 375                 }
 376             }
 377             case R.id.action_download_file:
 378             case R.id.action_sync_file: {
 379                 mContainerActivity.getFileOperationsHelper().syncFile(getFile());
 380                 return true;
 381             }
 382             case R.id.action_favorite_file:{
 383                 mContainerActivity.getFileOperationsHelper().toggleFavorite(getFile(), true);
 384                 return true;
 385             }
 386             case R.id.action_unfavorite_file:{
 387                 mContainerActivity.getFileOperationsHelper().toggleFavorite(getFile(), false);
 388                 return true;
 389             }
 390             case R.id.action_set_as_wallpaper:{
 391                 mContainerActivity.getFileOperationsHelper().setPictureAs(getFile());
 392                 return true;
 393             }
 394             default:
 395                 return false;
 396         }
 397     }
 398
 399
 400     private void seeDetails() {
 401         mContainerActivity.showDetails(getFile());
 402     }
 403
 404     @Override
 405     public void onResume() {
 406         super.onResume();
 407     }
 408
 409
 410     @Override
 411     public void onPause() {
 412         super.onPause();
 413     }
 414
 415     @Override
 416     public void onDestroy() {
 417         if (mBitmap != null) {
 418             mBitmap.recycle();
 419             System.gc();
 420                 // putting this in onStop() is just the same; the fragment is always destroyed by
 421                 // {@link FragmentStatePagerAdapter} when the fragment in swiped further than the
 422                 // valid offscreen distance, and onStop() is never called before than that
 423         }
 424         super.onDestroy();
 425     }
 426
 427
 428     /**
 429      * Opens the previewed image with an external application.
 430      */
 431     private void openFile() {
 432         mContainerActivity.getFileOperationsHelper().openFile(getFile());
 433         finish();
 434     }
 435
 436
 437     private class LoadBitmapTask extends AsyncTask<OCFile, Void, LoadImage> {
 438
 439         /**
 440          * Weak reference to the target {@link ImageView} where the bitmap will be loaded into.
 441          *
 442          * Using a weak reference will avoid memory leaks if the target ImageView is retired from
 443          * memory before the load finishes.
 444          */
 445         private final WeakReference<ImageViewCustom> mImageViewRef;
 446
 447         /**
 448          * Weak reference to the target {@link TextView} where error messages will be written.
 449          *
 450          * Using a weak reference will avoid memory leaks if the target ImageView is retired from
 451          * memory before the load finishes.
 452          */
 453         private final WeakReference<TextView> mMessageViewRef;
 454
 455
 456         /**
 457          * Weak reference to the target {@link ProgressBar} shown while the load is in progress.
 458          *
 459          * Using a weak reference will avoid memory leaks if the target ImageView is retired from
 460          * memory before the load finishes.
 461          */
 462         private final WeakReference<ProgressBar> mProgressWheelRef;
 463
 464
 465         /**
 466          * Error message to show when a load fails
 467          */
 468         private int mErrorMessageId;
 469
 470
 471         /**
 472          * Constructor.
 473          *
 474          * @param imageView Target {@link ImageView} where the bitmap will be loaded into.
 475          */
 476         public LoadBitmapTask(ImageViewCustom imageView, TextView messageView,
 477                               ProgressBar progressWheel) {
 478             mImageViewRef = new WeakReference<ImageViewCustom>(imageView);
 479             mMessageViewRef = new WeakReference<TextView>(messageView);
 480             mProgressWheelRef = new WeakReference<ProgressBar>(progressWheel);
 481         }
 482
 483         @Override
 484         protected LoadImage doInBackground(OCFile... params) {
 485             Bitmap result = null;
 486             if (params.length != 1) return null;
 487             OCFile ocFile = params[0];
 488             String storagePath = ocFile.getStoragePath();
 489             try {
 490
 491                 int maxDownScale = 3;   // could be a parameter passed to doInBackground(...)
 492                 Point screenSize = DisplayUtils.getScreenSize(getActivity());
 493                 int minWidth = screenSize.x;
 494                 int minHeight = screenSize.y;
 495                 for (int i = 0; i < maxDownScale && result == null; i++) {
 496                     if (isCancelled()) return null;
 497                     try {
 498                         result = BitmapUtils.decodeSampledBitmapFromFile(storagePath, minWidth,
 499                                 minHeight);
 500
 501                         if (isCancelled()) return new LoadImage(result, ocFile);
 502
 503                         if (result == null) {
 504                             mErrorMessageId = R.string.preview_image_error_unknown_format;
 505                             Log_OC.e(TAG, "File could not be loaded as a bitmap: " + storagePath);
 506                             break;
 507                         } else {
 508                             // Rotate image, obeying exif tag.
 509                             result = BitmapUtils.rotateImage(result, storagePath);
 510                         }
 511
 512                     } catch (OutOfMemoryError e) {
 513                         mErrorMessageId = R.string.common_error_out_memory;
 514                         if (i < maxDownScale - 1) {
 515                             Log_OC.w(TAG, "Out of memory rendering file " + storagePath +
 516                                     " ; scaling down");
 517                             minWidth = minWidth / 2;
 518                             minHeight = minHeight / 2;
 519
 520                         } else {
 521                             Log_OC.w(TAG, "Out of memory rendering file " + storagePath +
 522                                     " ; failing");
 523                         }
 524                         if (result != null) {
 525                             result.recycle();
 526                         }
 527                         result = null;
 528                     }
 529                 }
 530
 531             } catch (NoSuchFieldError e) {
 532                 mErrorMessageId = R.string.common_error_unknown;
 533                 Log_OC.e(TAG, "Error from access to unexisting field despite protection; file "
 534                         + storagePath, e);
 535
 536             } catch (Throwable t) {
 537                 mErrorMessageId = R.string.common_error_unknown;
 538                 Log_OC.e(TAG, "Unexpected error loading " + getFile().getStoragePath(), t);
 539
 540             }
 541
 542             return new LoadImage(result, ocFile);
 543         }
 544
 545         @Override
 546         protected void onCancelled(LoadImage result) {
 547             if (result != null && result.bitmap != null) {
 548                 result.bitmap.recycle();
 549             }
 550         }
 551
 552         @Override
 553         protected void onPostExecute(LoadImage result) {
 554             hideProgressWheel();
 555             if (result.bitmap != null) {
 556                 showLoadedImage(result);
 557             }
 558             else {
 559                 showErrorMessage();
 560             }
 561             if (result.bitmap != null && mBitmap != result.bitmap)  {
 562                 // unused bitmap, release it! (just in case)
 563                 result.bitmap.recycle();
 564             }
 565         }
 566
 567         @SuppressLint("InlinedApi")
 568         private void showLoadedImage(LoadImage result) {
 569             final ImageViewCustom imageView = mImageViewRef.get();
 570             Bitmap bitmap = result.bitmap;
 571             if (imageView != null) {
 572                 Log_OC.d(TAG, "Showing image with resolution " + bitmap.getWidth() + "x" +
 573                         bitmap.getHeight());
 574
 575                 if (result.ocFile.getMimetype().equalsIgnoreCase("image/png")){
 576                     Drawable backrepeat = getResources().getDrawable(R.drawable.backrepeat);
 577                     imageView.setBackground(backrepeat);
 578                 }
 579
 580                 if (result.ocFile.getMimetype().equalsIgnoreCase("image/gif")){
 581                     imageView.setGifImage(result.ocFile);
 582                 } else {
 583                     imageView.setImageBitmap(bitmap);
 584                 }
 585
 586                 imageView.setVisibility(View.VISIBLE);
 587                 mBitmap  = bitmap;  // needs to be kept for recycling when not useful
 588             }
 589
 590             final TextView messageView = mMessageViewRef.get();
 591             if (messageView != null) {
 592                 messageView.setVisibility(View.GONE);
 593             } // else , silently finish, the fragment was destroyed
 594         }
 595
 596         private void showErrorMessage() {
 597             final ImageView imageView = mImageViewRef.get();
 598             if (imageView != null) {
 599                 // shows the default error icon
 600                 imageView.setVisibility(View.VISIBLE);
 601             } // else , silently finish, the fragment was destroyed
 602
 603             final TextView messageView = mMessageViewRef.get();
 604             if (messageView != null) {
 605                 messageView.setText(mErrorMessageId);
 606                 messageView.setVisibility(View.VISIBLE);
 607             } // else , silently finish, the fragment was destroyed
 608         }
 609
 610         private void hideProgressWheel() {
 611             final ProgressBar progressWheel = mProgressWheelRef.get();
 612             if (progressWheel != null) {
 613                 progressWheel.setVisibility(View.GONE);
 614             }
 615         }
 616
 617     }
 618
 619     /**
 620      * Helper method to test if an {@link OCFile} can be passed to a {@link PreviewImageFragment}
 621      * to be previewed.
 622      *
 623      * @param file      File to test if can be previewed.
 624      * @return          'True' if the file can be handled by the fragment.
 625      */
 626     public static boolean canBePreviewed(OCFile file) {
 627         return (file != null && file.isImage());
 628     }
 629
 630
 631     /**
 632      * Finishes the preview
 633      */
 634     private void finish() {
 635         Activity container = getActivity();
 636         container.finish();
 637     }
 638
 639     public TouchImageViewCustom getImageView() {
 640         return mImageView;
 641     }
 642
 643     private class LoadImage {
 644         private Bitmap bitmap;
 645         private OCFile ocFile;
 646
 647         public LoadImage(Bitmap bitmap, OCFile ocFile){
 648             this.bitmap = bitmap;
 649             this.ocFile = ocFile;
 650         }
 651
 652     }
 653
 654 }