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