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

   1 /* ownCloud Android client application
   2  *   Copyright (C) 2012-2014 ownCloud Inc.
   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 version 2,
   6  *   as published by the Free Software Foundation.
   7  *
   8  *   This program is distributed in the hope that it will be useful,
   9  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  *   GNU General Public License for more details.
  12  *
  13  *   You should have received a copy of the GNU General Public License
  14  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  *
  16  */
  17 package com.owncloud.android.ui.preview;
  18
  19 import java.lang.ref.WeakReference;
  20
  21
  22 import android.accounts.Account;
  23 import android.annotation.SuppressLint;
  24 import android.app.Activity;
  25 import android.graphics.Bitmap;
  26 import android.graphics.BitmapFactory;
  27 import android.graphics.BitmapFactory.Options;
  28 import android.graphics.Point;
  29 import android.os.AsyncTask;
  30 import android.os.Bundle;
  31 import android.support.v4.app.FragmentStatePagerAdapter;
  32 import android.view.Display;
  33 import android.view.LayoutInflater;
  34 import android.view.View;
  35 import android.view.View.OnTouchListener;
  36 import android.view.ViewGroup;
  37 import android.widget.ImageView;
  38 import android.widget.ProgressBar;
  39 import android.widget.TextView;
  40
  41 import com.actionbarsherlock.view.Menu;
  42 import com.actionbarsherlock.view.MenuInflater;
  43 import com.actionbarsherlock.view.MenuItem;
  44 import com.owncloud.android.R;
  45 import com.owncloud.android.datamodel.OCFile;
  46 import com.owncloud.android.files.FileMenuFilter;
  47 import com.owncloud.android.ui.dialog.ConfirmationDialogFragment;
  48 import com.owncloud.android.ui.dialog.RemoveFileDialogFragment;
  49 import com.owncloud.android.ui.fragment.FileFragment;
  50 import com.owncloud.android.utils.Log_OC;
  51
  52
  53 /**
  54  * This fragment shows a preview of a downloaded image.
  55  *
  56  * Trying to get an instance with NULL {@link OCFile} or ownCloud {@link Account} values will produce an {@link IllegalStateException}.
  57  *
  58  * If the {@link OCFile} passed is not downloaded, an {@link IllegalStateException} is generated on instantiation too.
  59  *
  60  * @author David A. Velasco
  61  */
  62 public class PreviewImageFragment extends FileFragment {
  63     public static final String EXTRA_FILE = "FILE";
  64     public static final String EXTRA_ACCOUNT = "ACCOUNT";
  65
  66     private View mView;
  67     private Account mAccount;
  68     private ImageView mImageView;
  69     private TextView mMessageView;
  70     private ProgressBar mProgressWheel;
  71
  72     public Bitmap mBitmap = null;
  73
  74     private static final String TAG = PreviewImageFragment.class.getSimpleName();
  75
  76     private boolean mIgnoreFirstSavedState;
  77
  78
  79     /**
  80      * Creates a fragment to preview an image.
  81      *
  82      * When 'imageFile' or 'ocAccount' are null
  83      *
  84      * @param imageFile                 An {@link OCFile} to preview as an image in the fragment
  85      * @param ocAccount                 An ownCloud account; needed to start downloads
  86      * @param ignoreFirstSavedState     Flag to work around an unexpected behaviour of {@link FragmentStatePagerAdapter}; TODO better solution
  87      */
  88     public PreviewImageFragment(OCFile fileToDetail, Account ocAccount, boolean ignoreFirstSavedState) {
  89         super(fileToDetail);
  90         mAccount = ocAccount;
  91         mIgnoreFirstSavedState = ignoreFirstSavedState;
  92     }
  93
  94
  95     /**
  96      *  Creates an empty fragment for image previews.
  97      *
  98      *  MUST BE KEPT: the system uses it when tries to reinstantiate a fragment automatically (for instance, when the device is turned a aside).
  99      *
 100      *  DO NOT CALL IT: an {@link OCFile} and {@link Account} must be provided for a successful construction
 101      */
 102     public PreviewImageFragment() {
 103         super();
 104         mAccount = null;
 105         mIgnoreFirstSavedState = false;
 106     }
 107
 108
 109     /**
 110      * {@inheritDoc}
 111      */
 112     @Override
 113     public void onCreate(Bundle savedInstanceState) {
 114         super.onCreate(savedInstanceState);
 115         setHasOptionsMenu(true);
 116     }
 117
 118
 119     /**
 120      * {@inheritDoc}
 121      */
 122     @Override
 123     public View onCreateView(LayoutInflater inflater, ViewGroup container,
 124             Bundle savedInstanceState) {
 125         super.onCreateView(inflater, container, savedInstanceState);
 126         mView = inflater.inflate(R.layout.preview_image_fragment, container, false);
 127         mImageView = (ImageView)mView.findViewById(R.id.image);
 128         mImageView.setVisibility(View.GONE);
 129         mView.setOnTouchListener((OnTouchListener)getActivity());
 130         mMessageView = (TextView)mView.findViewById(R.id.message);
 131         mMessageView.setVisibility(View.GONE);
 132         mProgressWheel = (ProgressBar)mView.findViewById(R.id.progressWheel);
 133         mProgressWheel.setVisibility(View.VISIBLE);
 134         return mView;
 135     }
 136
 137
 138     /**
 139      * {@inheritDoc}
 140      */
 141     @Override
 142     public void onAttach(Activity activity) {
 143         super.onAttach(activity);
 144         if (!(activity instanceof OnTouchListener)) {
 145             throw new ClassCastException(activity.toString() +
 146                     " must implement " + OnTouchListener.class.getSimpleName());
 147         }
 148     }
 149
 150
 151     /**
 152      * {@inheritDoc}
 153      */
 154     @Override
 155     public void onActivityCreated(Bundle savedInstanceState) {
 156         super.onActivityCreated(savedInstanceState);
 157         if (savedInstanceState != null) {
 158             if (!mIgnoreFirstSavedState) {
 159                 OCFile file = (OCFile)savedInstanceState.getParcelable(PreviewImageFragment.EXTRA_FILE);
 160                 setFile(file);
 161                 mAccount = savedInstanceState.getParcelable(PreviewImageFragment.EXTRA_ACCOUNT);
 162             } else {
 163                 mIgnoreFirstSavedState = false;
 164             }
 165         }
 166         if (getFile() == null) {
 167             throw new IllegalStateException("Instanced with a NULL OCFile");
 168         }
 169         if (mAccount == null) {
 170             throw new IllegalStateException("Instanced with a NULL ownCloud Account");
 171         }
 172         if (!getFile().isDown()) {
 173             throw new IllegalStateException("There is no local file to preview");
 174         }
 175     }
 176
 177
 178     /**
 179      * {@inheritDoc}
 180      */
 181     @Override
 182     public void onSaveInstanceState(Bundle outState) {
 183         super.onSaveInstanceState(outState);
 184         outState.putParcelable(PreviewImageFragment.EXTRA_FILE, getFile());
 185         outState.putParcelable(PreviewImageFragment.EXTRA_ACCOUNT, mAccount);
 186     }
 187
 188
 189     @Override
 190     public void onStart() {
 191         super.onStart();
 192         if (getFile() != null) {
 193            BitmapLoader bl = new BitmapLoader(mImageView, mMessageView, mProgressWheel);
 194            bl.execute(new String[]{getFile().getStoragePath()});
 195         }
 196     }
 197
 198
 199     /**
 200      * {@inheritDoc}
 201      */
 202     @Override
 203     public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
 204         super.onCreateOptionsMenu(menu, inflater);
 205         inflater.inflate(R.menu.file_actions_menu, menu);
 206     }
 207
 208     /**
 209      * {@inheritDoc}
 210      */
 211     @Override
 212     public void onPrepareOptionsMenu(Menu menu) {
 213         super.onPrepareOptionsMenu(menu);
 214
 215         if (mContainerActivity.getStorageManager() != null) {
 216             FileMenuFilter mf = new FileMenuFilter(
 217                 getFile(),
 218                 mContainerActivity.getStorageManager().getAccount(),
 219                 mContainerActivity,
 220                 getSherlockActivity()
 221             );
 222             mf.filter(menu);
 223         }
 224
 225         // additional restriction for this fragment
 226         // TODO allow renaming in PreviewImageFragment
 227         MenuItem item = menu.findItem(R.id.action_rename_file);
 228         if (item != null) {
 229             item.setVisible(false);
 230             item.setEnabled(false);
 231         }
 232     }
 233
 234
 235
 236     /**
 237      * {@inheritDoc}
 238      */
 239     @Override
 240     public boolean onOptionsItemSelected(MenuItem item) {
 241         switch (item.getItemId()) {
 242             case R.id.action_share_file: {
 243                 mContainerActivity.getFileOperationsHelper().shareFileWithLink(getFile());
 244                 return true;
 245             }
 246             case R.id.action_unshare_file: {
 247                 mContainerActivity.getFileOperationsHelper().unshareFileWithLink(getFile());
 248                 return true;
 249             }
 250             case R.id.action_open_file_with: {
 251                 openFile();
 252                 return true;
 253             }
 254             case R.id.action_remove_file: {
 255                 RemoveFileDialogFragment dialog = RemoveFileDialogFragment.newInstance(getFile());
 256                 dialog.show(getFragmentManager(), ConfirmationDialogFragment.FTAG_CONFIRMATION);
 257                 return true;
 258             }
 259             case R.id.action_see_details: {
 260                 seeDetails();
 261                 return true;
 262             }
 263             case R.id.action_send_file: {
 264                 mContainerActivity.getFileOperationsHelper().sendDownloadedFile(getFile());
 265                 return true;
 266             }
 267             case R.id.action_sync_file: {
 268                 mContainerActivity.getFileOperationsHelper().syncFile(getFile());
 269                 return true;
 270             }
 271
 272             default:
 273                 return false;
 274         }
 275     }
 276
 277
 278     private void seeDetails() {
 279         mContainerActivity.showDetails(getFile());
 280     }
 281
 282
 283     @Override
 284     public void onResume() {
 285         super.onResume();
 286     }
 287
 288
 289     @Override
 290     public void onPause() {
 291         super.onPause();
 292     }
 293
 294
 295     @Override
 296     public void onDestroy() {
 297         super.onDestroy();
 298         if (mBitmap != null) {
 299             mBitmap.recycle();
 300         }
 301     }
 302
 303
 304     /**
 305      * Opens the previewed image with an external application.
 306      */
 307     private void openFile() {
 308         mContainerActivity.getFileOperationsHelper().openFile(getFile());
 309         finish();
 310     }
 311
 312
 313     private class BitmapLoader extends AsyncTask<String, Void, Bitmap> {
 314
 315         /**
 316          * Weak reference to the target {@link ImageView} where the bitmap will be loaded into.
 317          *
 318          * Using a weak reference will avoid memory leaks if the target ImageView is retired from memory before the load finishes.
 319          */
 320         private final WeakReference<ImageView> mImageViewRef;
 321
 322         /**
 323          * Weak reference to the target {@link TextView} where error messages will be written.
 324          *
 325          * Using a weak reference will avoid memory leaks if the target ImageView is retired from memory before the load finishes.
 326          */
 327         private final WeakReference<TextView> mMessageViewRef;
 328
 329
 330         /**
 331          * Weak reference to the target {@link Progressbar} shown while the load is in progress.
 332          *
 333          * Using a weak reference will avoid memory leaks if the target ImageView is retired from memory before the load finishes.
 334          */
 335         private final WeakReference<ProgressBar> mProgressWheelRef;
 336
 337
 338         /**
 339          * Error message to show when a load fails
 340          */
 341         private int mErrorMessageId;
 342
 343
 344         /**
 345          * Constructor.
 346          *
 347          * @param imageView     Target {@link ImageView} where the bitmap will be loaded into.
 348          */
 349         public BitmapLoader(ImageView imageView, TextView messageView, ProgressBar progressWheel) {
 350             mImageViewRef = new WeakReference<ImageView>(imageView);
 351             mMessageViewRef = new WeakReference<TextView>(messageView);
 352             mProgressWheelRef = new WeakReference<ProgressBar>(progressWheel);
 353         }
 354
 355
 356         @SuppressWarnings("deprecation")
 357         @SuppressLint({ "NewApi", "NewApi", "NewApi" }) // to avoid Lint errors since Android SDK r20
 358                 @Override
 359         protected Bitmap doInBackground(String... params) {
 360             Bitmap result = null;
 361             if (params.length != 1) return result;
 362             String storagePath = params[0];
 363             try {
 364                 // set desired options that will affect the size of the bitmap
 365                 BitmapFactory.Options options = new Options();
 366                 options.inScaled = true;
 367                 options.inPurgeable = true;
 368                 if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.GINGERBREAD_MR1) {
 369                     options.inPreferQualityOverSpeed = false;
 370                 }
 371                 if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.HONEYCOMB) {
 372                     options.inMutable = false;
 373                 }
 374                 // make a false load of the bitmap - just to be able to read outWidth, outHeight and outMimeType
 375                 options.inJustDecodeBounds = true;
 376                 BitmapFactory.decodeFile(storagePath, options);
 377
 378                 int width = options.outWidth;
 379                 int height = options.outHeight;
 380                 int scale = 1;
 381
 382                 Display display = getActivity().getWindowManager().getDefaultDisplay();
 383                 Point size = new Point();
 384                 int screenWidth;
 385                 int screenHeight;
 386                 if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.HONEYCOMB_MR2) {
 387                     display.getSize(size);
 388                     screenWidth = size.x;
 389                     screenHeight = size.y;
 390                 } else {
 391                     screenWidth = display.getWidth();
 392                     screenHeight = display.getHeight();
 393                 }
 394
 395                 if (width > screenWidth) {
 396                     // second try to scale down the image , this time depending upon the screen size
 397                     scale = (int) Math.floor((float)width / screenWidth);
 398                 }
 399                 if (height > screenHeight) {
 400                     scale = Math.max(scale, (int) Math.floor((float)height / screenHeight));
 401                 }
 402                 options.inSampleSize = scale;
 403
 404                 // really load the bitmap
 405                 options.inJustDecodeBounds = false; // the next decodeFile call will be real
 406                 result = BitmapFactory.decodeFile(storagePath, options);
 407                 //Log_OC.d(TAG, "Image loaded - width: " + options.outWidth + ", loaded height: " + options.outHeight);
 408
 409                 if (result == null) {
 410                     mErrorMessageId = R.string.preview_image_error_unknown_format;
 411                     Log_OC.e(TAG, "File could not be loaded as a bitmap: " + storagePath);
 412                 }
 413
 414             } catch (OutOfMemoryError e) {
 415                 mErrorMessageId = R.string.preview_image_error_unknown_format;
 416                 Log_OC.e(TAG, "Out of memory occured for file " + storagePath, e);
 417
 418             } catch (NoSuchFieldError e) {
 419                 mErrorMessageId = R.string.common_error_unknown;
 420                 Log_OC.e(TAG, "Error from access to unexisting field despite protection; file " + storagePath, e);
 421
 422             } catch (Throwable t) {
 423                 mErrorMessageId = R.string.common_error_unknown;
 424                 Log_OC.e(TAG, "Unexpected error loading " + getFile().getStoragePath(), t);
 425
 426             }
 427             return result;
 428         }
 429
 430         @Override
 431         protected void onPostExecute(Bitmap result) {
 432             hideProgressWheel();
 433             if (result != null) {
 434                 showLoadedImage(result);
 435             } else {
 436                 showErrorMessage();
 437             }
 438         }
 439
 440         private void showLoadedImage(Bitmap result) {
 441             if (mImageViewRef != null) {
 442                 final ImageView imageView = mImageViewRef.get();
 443                 if (imageView != null) {
 444                     imageView.setImageBitmap(result);
 445                     imageView.setVisibility(View.VISIBLE);
 446                     mBitmap  = result;
 447                 } // else , silently finish, the fragment was destroyed
 448             }
 449             if (mMessageViewRef != null) {
 450                 final TextView messageView = mMessageViewRef.get();
 451                 if (messageView != null) {
 452                     messageView.setVisibility(View.GONE);
 453                 } // else , silently finish, the fragment was destroyed
 454             }
 455         }
 456
 457         private void showErrorMessage() {
 458             if (mImageViewRef != null) {
 459                 final ImageView imageView = mImageViewRef.get();
 460                 if (imageView != null) {
 461                     // shows the default error icon
 462                     imageView.setVisibility(View.VISIBLE);
 463                 } // else , silently finish, the fragment was destroyed
 464             }
 465             if (mMessageViewRef != null) {
 466                 final TextView messageView = mMessageViewRef.get();
 467                 if (messageView != null) {
 468                     messageView.setText(mErrorMessageId);
 469                     messageView.setVisibility(View.VISIBLE);
 470                 } // else , silently finish, the fragment was destroyed
 471             }
 472         }
 473
 474         private void hideProgressWheel() {
 475             if (mProgressWheelRef != null) {
 476                 final ProgressBar progressWheel = mProgressWheelRef.get();
 477                 if (progressWheel != null) {
 478                     progressWheel.setVisibility(View.GONE);
 479                 }
 480             }
 481         }
 482
 483     }
 484
 485     /**
 486      * Helper method to test if an {@link OCFile} can be passed to a {@link PreviewImageFragment} to be previewed.
 487      *
 488      * @param file      File to test if can be previewed.
 489      * @return          'True' if the file can be handled by the fragment.
 490      */
 491     public static boolean canBePreviewed(OCFile file) {
 492         return (file != null && file.isImage());
 493     }
 494
 495
 496     /**
 497      * Finishes the preview
 498      */
 499     private void finish() {
 500         Activity container = getActivity();
 501         container.finish();
 502     }
 503
 504
 505 }