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

   1 /* ownCloud Android client application
   2  *   Copyright (C) 2012-2013 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 import java.util.ArrayList;
  21 import java.util.List;
  22
  23
  24 import android.accounts.Account;
  25 import android.annotation.SuppressLint;
  26 import android.app.Activity;
  27 import android.content.ActivityNotFoundException;
  28 import android.content.Intent;
  29 import android.graphics.Bitmap;
  30 import android.graphics.BitmapFactory;
  31 import android.graphics.BitmapFactory.Options;
  32 import android.graphics.Point;
  33 import android.net.Uri;
  34 import android.os.AsyncTask;
  35 import android.os.Bundle;
  36 import android.os.Handler;
  37 import android.support.v4.app.FragmentStatePagerAdapter;
  38 import android.view.Display;
  39 import android.view.LayoutInflater;
  40 import android.view.View;
  41 import android.view.View.OnTouchListener;
  42 import android.view.ViewGroup;
  43 import android.webkit.MimeTypeMap;
  44 import android.widget.ImageView;
  45 import android.widget.ProgressBar;
  46 import android.widget.TextView;
  47 import android.widget.Toast;
  48
  49 import com.actionbarsherlock.view.Menu;
  50 import com.actionbarsherlock.view.MenuInflater;
  51 import com.actionbarsherlock.view.MenuItem;
  52 import com.owncloud.android.R;
  53 import com.owncloud.android.datamodel.FileDataStorageManager;
  54 import com.owncloud.android.datamodel.OCFile;
  55 import com.owncloud.android.lib.network.webdav.WebdavUtils;
  56 import com.owncloud.android.lib.operations.common.OnRemoteOperationListener;
  57 import com.owncloud.android.lib.operations.common.RemoteOperation;
  58 import com.owncloud.android.lib.operations.common.RemoteOperationResult;
  59 import com.owncloud.android.operations.RemoveFileOperation;
  60 import com.owncloud.android.ui.fragment.ConfirmationDialogFragment;
  61 import com.owncloud.android.ui.fragment.FileFragment;
  62 import com.owncloud.android.utils.Log_OC;
  63
  64
  65 /**
  66  * This fragment shows a preview of a downloaded image.
  67  *
  68  * Trying to get an instance with NULL {@link OCFile} or ownCloud {@link Account} values will produce an {@link IllegalStateException}.
  69  *
  70  * If the {@link OCFile} passed is not downloaded, an {@link IllegalStateException} is generated on instantiation too.
  71  *
  72  * @author David A. Velasco
  73  */
  74 public class PreviewImageFragment extends FileFragment implements   OnRemoteOperationListener,
  75                                                                         ConfirmationDialogFragment.ConfirmationDialogFragmentListener {
  76     public static final String EXTRA_FILE = "FILE";
  77     public static final String EXTRA_ACCOUNT = "ACCOUNT";
  78
  79     private View mView;
  80     private Account mAccount;
  81     private FileDataStorageManager mStorageManager;
  82     private ImageView mImageView;
  83     private TextView mMessageView;
  84     private ProgressBar mProgressWheel;
  85
  86     public Bitmap mBitmap = null;
  87
  88     private Handler mHandler;
  89     private RemoteOperation mLastRemoteOperation;
  90
  91     private static final String TAG = PreviewImageFragment.class.getSimpleName();
  92
  93     private boolean mIgnoreFirstSavedState;
  94
  95
  96     /**
  97      * Creates a fragment to preview an image.
  98      *
  99      * When 'imageFile' or 'ocAccount' are null
 100      *
 101      * @param imageFile                 An {@link OCFile} to preview as an image in the fragment
 102      * @param ocAccount                 An ownCloud account; needed to start downloads
 103      * @param ignoreFirstSavedState     Flag to work around an unexpected behaviour of {@link FragmentStatePagerAdapter}; TODO better solution
 104      */
 105     public PreviewImageFragment(OCFile fileToDetail, Account ocAccount, boolean ignoreFirstSavedState) {
 106         super(fileToDetail);
 107         mAccount = ocAccount;
 108         mStorageManager = null; // we need a context to init this; the container activity is not available yet at this moment
 109         mIgnoreFirstSavedState = ignoreFirstSavedState;
 110     }
 111
 112
 113     /**
 114      *  Creates an empty fragment for image previews.
 115      *
 116      *  MUST BE KEPT: the system uses it when tries to reinstantiate a fragment automatically (for instance, when the device is turned a aside).
 117      *
 118      *  DO NOT CALL IT: an {@link OCFile} and {@link Account} must be provided for a successful construction
 119      */
 120     public PreviewImageFragment() {
 121         super();
 122         mAccount = null;
 123         mStorageManager = null;
 124         mIgnoreFirstSavedState = false;
 125     }
 126
 127
 128     /**
 129      * {@inheritDoc}
 130      */
 131     @Override
 132     public void onCreate(Bundle savedInstanceState) {
 133         super.onCreate(savedInstanceState);
 134         mHandler = new Handler();
 135         setHasOptionsMenu(true);
 136     }
 137
 138
 139     /**
 140      * {@inheritDoc}
 141      */
 142     @Override
 143     public View onCreateView(LayoutInflater inflater, ViewGroup container,
 144             Bundle savedInstanceState) {
 145         super.onCreateView(inflater, container, savedInstanceState);
 146         mView = inflater.inflate(R.layout.preview_image_fragment, container, false);
 147         mImageView = (ImageView)mView.findViewById(R.id.image);
 148         mImageView.setVisibility(View.GONE);
 149         mView.setOnTouchListener((OnTouchListener)getActivity());   // WATCH OUT THAT CAST
 150         mMessageView = (TextView)mView.findViewById(R.id.message);
 151         mMessageView.setVisibility(View.GONE);
 152         mProgressWheel = (ProgressBar)mView.findViewById(R.id.progressWheel);
 153         mProgressWheel.setVisibility(View.VISIBLE);
 154         return mView;
 155     }
 156
 157
 158     /**
 159      * {@inheritDoc}
 160      */
 161     @Override
 162     public void onAttach(Activity activity) {
 163         super.onAttach(activity);
 164         if (!(activity instanceof FileFragment.ContainerActivity))
 165             throw new ClassCastException(activity.toString() + " must implement " + FileFragment.ContainerActivity.class.getSimpleName());
 166     }
 167
 168
 169     /**
 170      * {@inheritDoc}
 171      */
 172     @Override
 173     public void onActivityCreated(Bundle savedInstanceState) {
 174         super.onActivityCreated(savedInstanceState);
 175         mStorageManager = new FileDataStorageManager(mAccount, getActivity().getApplicationContext().getContentResolver());
 176         if (savedInstanceState != null) {
 177             if (!mIgnoreFirstSavedState) {
 178                 setFile((OCFile)savedInstanceState.getParcelable(PreviewImageFragment.EXTRA_FILE));
 179                 mAccount = savedInstanceState.getParcelable(PreviewImageFragment.EXTRA_ACCOUNT);
 180             } else {
 181                 mIgnoreFirstSavedState = false;
 182             }
 183         }
 184         if (getFile() == null) {
 185             throw new IllegalStateException("Instanced with a NULL OCFile");
 186         }
 187         if (mAccount == null) {
 188             throw new IllegalStateException("Instanced with a NULL ownCloud Account");
 189         }
 190         if (!getFile().isDown()) {
 191             throw new IllegalStateException("There is no local file to preview");
 192         }
 193     }
 194
 195
 196     /**
 197      * {@inheritDoc}
 198      */
 199     @Override
 200     public void onSaveInstanceState(Bundle outState) {
 201         super.onSaveInstanceState(outState);
 202         outState.putParcelable(PreviewImageFragment.EXTRA_FILE, getFile());
 203         outState.putParcelable(PreviewImageFragment.EXTRA_ACCOUNT, mAccount);
 204     }
 205
 206
 207     @Override
 208     public void onStart() {
 209         super.onStart();
 210         if (getFile() != null) {
 211            BitmapLoader bl = new BitmapLoader(mImageView, mMessageView, mProgressWheel);
 212            bl.execute(new String[]{getFile().getStoragePath()});
 213         }
 214     }
 215
 216
 217     /**
 218      * {@inheritDoc}
 219      */
 220     @Override
 221     public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
 222         super.onCreateOptionsMenu(menu, inflater);
 223
 224         inflater.inflate(R.menu.file_actions_menu, menu);
 225         List<Integer> toHide = new ArrayList<Integer>();
 226
 227         MenuItem item = null;
 228         toHide.add(R.id.action_cancel_download);
 229         toHide.add(R.id.action_cancel_upload);
 230         toHide.add(R.id.action_download_file);
 231         toHide.add(R.id.action_rename_file);    // by now
 232
 233         // Options shareLink
 234         if (!getFile().isShareByLink()) {
 235             toHide.add(R.id.action_unshare_file);
 236         }
 237
 238         for (int i : toHide) {
 239             item = menu.findItem(i);
 240             if (item != null) {
 241                 item.setVisible(false);
 242                 item.setEnabled(false);
 243             }
 244         }
 245
 246     }
 247
 248
 249     /**
 250      * {@inheritDoc}
 251      */
 252     @Override
 253     public boolean onOptionsItemSelected(MenuItem item) {
 254         switch (item.getItemId()) {
 255             case R.id.action_open_file_with: {
 256                 openFile();
 257                 return true;
 258             }
 259             case R.id.action_remove_file: {
 260                 removeFile();
 261                 return true;
 262             }
 263             case R.id.action_see_details: {
 264                 seeDetails();
 265                 return true;
 266             }
 267
 268             default:
 269                 return false;
 270         }
 271     }
 272
 273
 274     /**
 275      * {@inheritDoc}
 276      */
 277     @Override
 278     public void onPrepareOptionsMenu(Menu menu) {
 279         super.onPrepareOptionsMenu(menu);
 280     }
 281
 282
 283     private void seeDetails() {
 284         ((FileFragment.ContainerActivity)getActivity()).showDetails(getFile());
 285     }
 286
 287
 288     @Override
 289     public void onResume() {
 290         super.onResume();
 291     }
 292
 293
 294     @Override
 295     public void onPause() {
 296         super.onPause();
 297     }
 298
 299
 300     @Override
 301     public void onDestroy() {
 302         super.onDestroy();
 303         if (mBitmap != null) {
 304             mBitmap.recycle();
 305         }
 306     }
 307
 308
 309     /**
 310      * Opens the previewed image with an external application.
 311      *
 312      * TODO - improve this; instead of prioritize the actions available for the MIME type in the server,
 313      * we should get a list of available apps for MIME tpye in the server and join it with the list of
 314      * available apps for the MIME type known from the file extension, to let the user choose
 315      */
 316     private void openFile() {
 317         OCFile file = getFile();
 318         String storagePath = file.getStoragePath();
 319         String encodedStoragePath = WebdavUtils.encodePath(storagePath);
 320         try {
 321             Intent i = new Intent(Intent.ACTION_VIEW);
 322             i.setDataAndType(Uri.parse("file://"+ encodedStoragePath), file.getMimetype());
 323             i.setFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION | Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
 324             startActivity(i);
 325
 326         } catch (Throwable t) {
 327             Log_OC.e(TAG, "Fail when trying to open with the mimeType provided from the ownCloud server: " + file.getMimetype());
 328             boolean toastIt = true;
 329             String mimeType = "";
 330             try {
 331                 Intent i = new Intent(Intent.ACTION_VIEW);
 332                 mimeType = MimeTypeMap.getSingleton().getMimeTypeFromExtension(storagePath.substring(storagePath.lastIndexOf('.') + 1));
 333                 if (mimeType == null || !mimeType.equals(file.getMimetype())) {
 334                     if (mimeType != null) {
 335                         i.setDataAndType(Uri.parse("file://"+ encodedStoragePath), mimeType);
 336                     } else {
 337                         // desperate try
 338                         i.setDataAndType(Uri.parse("file://"+ encodedStoragePath), "*-/*");
 339                     }
 340                     i.setFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION | Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
 341                     startActivity(i);
 342                     toastIt = false;
 343                 }
 344
 345             } catch (IndexOutOfBoundsException e) {
 346                 Log_OC.e(TAG, "Trying to find out MIME type of a file without extension: " + storagePath);
 347
 348             } catch (ActivityNotFoundException e) {
 349                 Log_OC.e(TAG, "No activity found to handle: " + storagePath + " with MIME type " + mimeType + " obtained from extension");
 350
 351             } catch (Throwable th) {
 352                 Log_OC.e(TAG, "Unexpected problem when opening: " + storagePath, th);
 353
 354             } finally {
 355                 if (toastIt) {
 356                     Toast.makeText(getActivity(), "There is no application to handle file " + file.getFileName(), Toast.LENGTH_SHORT).show();
 357                 }
 358             }
 359
 360         }
 361         finish();
 362     }
 363
 364
 365     /**
 366      * Starts a the removal of the previewed file.
 367      *
 368      * Shows a confirmation dialog. The action continues in {@link #onConfirmation(String)} , {@link #onNeutral(String)} or {@link #onCancel(String)},
 369      * depending upon the user selection in the dialog.
 370      */
 371     private void removeFile() {
 372         ConfirmationDialogFragment confDialog = ConfirmationDialogFragment.newInstance(
 373                 R.string.confirmation_remove_alert,
 374                 new String[]{getFile().getFileName()},
 375                 R.string.confirmation_remove_remote_and_local,
 376                 R.string.confirmation_remove_local,
 377                 R.string.common_cancel);
 378         confDialog.setOnConfirmationListener(this);
 379         confDialog.show(getFragmentManager(), ConfirmationDialogFragment.FTAG_CONFIRMATION);
 380     }
 381
 382
 383     /**
 384      * Performs the removal of the previewed file, both locally and in the server.
 385      */
 386     @Override
 387     public void onConfirmation(String callerTag) {
 388         if (mStorageManager.getFileById(getFile().getFileId()) != null) {   // check that the file is still there;
 389             mLastRemoteOperation = new RemoveFileOperation( getFile(),      // TODO we need to review the interface with RemoteOperations, and use OCFile IDs instead of OCFile objects as parameters
 390                                                             true,
 391                                                             mStorageManager);
 392             mLastRemoteOperation.execute(mAccount, getSherlockActivity(), this, mHandler, getSherlockActivity());
 393
 394             ((PreviewImageActivity) getActivity()).showLoadingDialog();
 395         }
 396     }
 397
 398
 399     /**
 400      * Removes the file from local storage
 401      */
 402     @Override
 403     public void onNeutral(String callerTag) {
 404         OCFile file = getFile();
 405         mStorageManager.removeFile(file, false, true);    // TODO perform in background task / new thread
 406         finish();
 407     }
 408
 409     /**
 410      * User cancelled the removal action.
 411      */
 412     @Override
 413     public void onCancel(String callerTag) {
 414         // nothing to do here
 415     }
 416
 417
 418     private class BitmapLoader extends AsyncTask<String, Void, Bitmap> {
 419
 420         /**
 421          * Weak reference to the target {@link ImageView} where the bitmap will be loaded into.
 422          *
 423          * Using a weak reference will avoid memory leaks if the target ImageView is retired from memory before the load finishes.
 424          */
 425         private final WeakReference<ImageView> mImageViewRef;
 426
 427         /**
 428          * Weak reference to the target {@link TextView} where error messages will be written.
 429          *
 430          * Using a weak reference will avoid memory leaks if the target ImageView is retired from memory before the load finishes.
 431          */
 432         private final WeakReference<TextView> mMessageViewRef;
 433
 434
 435         /**
 436          * Weak reference to the target {@link Progressbar} shown while the load is in progress.
 437          *
 438          * Using a weak reference will avoid memory leaks if the target ImageView is retired from memory before the load finishes.
 439          */
 440         private final WeakReference<ProgressBar> mProgressWheelRef;
 441
 442
 443         /**
 444          * Error message to show when a load fails
 445          */
 446         private int mErrorMessageId;
 447
 448
 449         /**
 450          * Constructor.
 451          *
 452          * @param imageView     Target {@link ImageView} where the bitmap will be loaded into.
 453          */
 454         public BitmapLoader(ImageView imageView, TextView messageView, ProgressBar progressWheel) {
 455             mImageViewRef = new WeakReference<ImageView>(imageView);
 456             mMessageViewRef = new WeakReference<TextView>(messageView);
 457             mProgressWheelRef = new WeakReference<ProgressBar>(progressWheel);
 458         }
 459
 460
 461         @SuppressWarnings("deprecation")
 462         @SuppressLint({ "NewApi", "NewApi", "NewApi" }) // to avoid Lint errors since Android SDK r20
 463                 @Override
 464         protected Bitmap doInBackground(String... params) {
 465             Bitmap result = null;
 466             if (params.length != 1) return result;
 467             String storagePath = params[0];
 468             try {
 469                 // set desired options that will affect the size of the bitmap
 470                 BitmapFactory.Options options = new Options();
 471                 options.inScaled = true;
 472                 options.inPurgeable = true;
 473                 if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.GINGERBREAD_MR1) {
 474                     options.inPreferQualityOverSpeed = false;
 475                 }
 476                 if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.HONEYCOMB) {
 477                     options.inMutable = false;
 478                 }
 479                 // make a false load of the bitmap - just to be able to read outWidth, outHeight and outMimeType
 480                 options.inJustDecodeBounds = true;
 481                 BitmapFactory.decodeFile(storagePath, options);
 482
 483                 int width = options.outWidth;
 484                 int height = options.outHeight;
 485                 int scale = 1;
 486
 487                 Display display = getActivity().getWindowManager().getDefaultDisplay();
 488                 Point size = new Point();
 489                 int screenWidth;
 490                 int screenHeight;
 491                 if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.HONEYCOMB_MR2) {
 492                     display.getSize(size);
 493                     screenWidth = size.x;
 494                     screenHeight = size.y;
 495                 } else {
 496                     screenWidth = display.getWidth();
 497                     screenHeight = display.getHeight();
 498                 }
 499
 500                 if (width > screenWidth) {
 501                     // second try to scale down the image , this time depending upon the screen size
 502                     scale = (int) Math.floor((float)width / screenWidth);
 503                 }
 504                 if (height > screenHeight) {
 505                     scale = Math.max(scale, (int) Math.floor((float)height / screenHeight));
 506                 }
 507                 options.inSampleSize = scale;
 508
 509                 // really load the bitmap
 510                 options.inJustDecodeBounds = false; // the next decodeFile call will be real
 511                 result = BitmapFactory.decodeFile(storagePath, options);
 512                 //Log_OC.d(TAG, "Image loaded - width: " + options.outWidth + ", loaded height: " + options.outHeight);
 513
 514                 if (result == null) {
 515                     mErrorMessageId = R.string.preview_image_error_unknown_format;
 516                     Log_OC.e(TAG, "File could not be loaded as a bitmap: " + storagePath);
 517                 }
 518
 519             } catch (OutOfMemoryError e) {
 520                 mErrorMessageId = R.string.preview_image_error_unknown_format;
 521                 Log_OC.e(TAG, "Out of memory occured for file " + storagePath, e);
 522
 523             } catch (NoSuchFieldError e) {
 524                 mErrorMessageId = R.string.common_error_unknown;
 525                 Log_OC.e(TAG, "Error from access to unexisting field despite protection; file " + storagePath, e);
 526
 527             } catch (Throwable t) {
 528                 mErrorMessageId = R.string.common_error_unknown;
 529                 Log_OC.e(TAG, "Unexpected error loading " + getFile().getStoragePath(), t);
 530
 531             }
 532             return result;
 533         }
 534
 535         @Override
 536         protected void onPostExecute(Bitmap result) {
 537             hideProgressWheel();
 538             if (result != null) {
 539                 showLoadedImage(result);
 540             } else {
 541                 showErrorMessage();
 542             }
 543         }
 544
 545         private void showLoadedImage(Bitmap result) {
 546             if (mImageViewRef != null) {
 547                 final ImageView imageView = mImageViewRef.get();
 548                 if (imageView != null) {
 549                     imageView.setImageBitmap(result);
 550                     imageView.setVisibility(View.VISIBLE);
 551                     mBitmap  = result;
 552                 } // else , silently finish, the fragment was destroyed
 553             }
 554             if (mMessageViewRef != null) {
 555                 final TextView messageView = mMessageViewRef.get();
 556                 if (messageView != null) {
 557                     messageView.setVisibility(View.GONE);
 558                 } // else , silently finish, the fragment was destroyed
 559             }
 560         }
 561
 562         private void showErrorMessage() {
 563             if (mImageViewRef != null) {
 564                 final ImageView imageView = mImageViewRef.get();
 565                 if (imageView != null) {
 566                     // shows the default error icon
 567                     imageView.setVisibility(View.VISIBLE);
 568                 } // else , silently finish, the fragment was destroyed
 569             }
 570             if (mMessageViewRef != null) {
 571                 final TextView messageView = mMessageViewRef.get();
 572                 if (messageView != null) {
 573                     messageView.setText(mErrorMessageId);
 574                     messageView.setVisibility(View.VISIBLE);
 575                 } // else , silently finish, the fragment was destroyed
 576             }
 577         }
 578
 579         private void hideProgressWheel() {
 580             if (mProgressWheelRef != null) {
 581                 final ProgressBar progressWheel = mProgressWheelRef.get();
 582                 if (progressWheel != null) {
 583                     progressWheel.setVisibility(View.GONE);
 584                 }
 585             }
 586         }
 587
 588     }
 589
 590     /**
 591      * Helper method to test if an {@link OCFile} can be passed to a {@link PreviewImageFragment} to be previewed.
 592      *
 593      * @param file      File to test if can be previewed.
 594      * @return          'True' if the file can be handled by the fragment.
 595      */
 596     public static boolean canBePreviewed(OCFile file) {
 597         return (file != null && file.isImage());
 598     }
 599
 600
 601     /**
 602      * {@inheritDoc}
 603      */
 604     @Override
 605     public void onRemoteOperationFinish(RemoteOperation operation, RemoteOperationResult result) {
 606         if (operation.equals(mLastRemoteOperation) && operation instanceof RemoveFileOperation) {
 607             onRemoveFileOperationFinish((RemoveFileOperation)operation, result);
 608         }
 609     }
 610
 611     private void onRemoveFileOperationFinish(RemoveFileOperation operation, RemoteOperationResult result) {
 612         ((PreviewImageActivity) getActivity()).dismissLoadingDialog();
 613
 614         if (result.isSuccess()) {
 615             Toast msg = Toast.makeText(getActivity().getApplicationContext(), R.string.remove_success_msg, Toast.LENGTH_LONG);
 616             msg.show();
 617             finish();
 618
 619         } else {
 620             Toast msg = Toast.makeText(getActivity(), R.string.remove_fail_msg, Toast.LENGTH_LONG);
 621             msg.show();
 622             if (result.isSslRecoverableException()) {
 623                 // TODO show the SSL warning dialog
 624             }
 625         }
 626     }
 627
 628     /**
 629      * Finishes the preview
 630      */
 631     private void finish() {
 632         Activity container = getActivity();
 633         container.finish();
 634     }
 635
 636
 637 }