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             case R.id.action_send_file: {
 269                 sendFile();
 270                 return true;
 271             }
 272
 273             default:
 274                 return false;
 275         }
 276     }
 277
 278     private void sendFile(){
 279         Intent sharingIntent = new Intent(android.content.Intent.ACTION_SEND);
 280         // set MimeType
 281         sharingIntent.setType(getFile().getMimetype());
 282         sharingIntent.putExtra(Intent.EXTRA_STREAM, Uri.parse("file://"+getFile().getStoragePath()));
 283         startActivity(Intent.createChooser(sharingIntent, getResources().getString(R.string.send_file_title_intent)));
 284     }
 285
 286
 287     private void seeDetails() {
 288         ((FileFragment.ContainerActivity)getActivity()).showDetails(getFile());
 289     }
 290
 291
 292     @Override
 293     public void onResume() {
 294         super.onResume();
 295     }
 296
 297
 298     @Override
 299     public void onPause() {
 300         super.onPause();
 301     }
 302
 303
 304     @Override
 305     public void onDestroy() {
 306         super.onDestroy();
 307         if (mBitmap != null) {
 308             mBitmap.recycle();
 309         }
 310     }
 311
 312
 313     /**
 314      * Opens the previewed image with an external application.
 315      *
 316      * TODO - improve this; instead of prioritize the actions available for the MIME type in the server,
 317      * we should get a list of available apps for MIME tpye in the server and join it with the list of
 318      * available apps for the MIME type known from the file extension, to let the user choose
 319      */
 320     private void openFile() {
 321         OCFile file = getFile();
 322         String storagePath = file.getStoragePath();
 323         String encodedStoragePath = WebdavUtils.encodePath(storagePath);
 324         try {
 325             Intent i = new Intent(Intent.ACTION_VIEW);
 326             i.setDataAndType(Uri.parse("file://"+ encodedStoragePath), file.getMimetype());
 327             i.setFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION | Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
 328             startActivity(i);
 329
 330         } catch (Throwable t) {
 331             Log_OC.e(TAG, "Fail when trying to open with the mimeType provided from the ownCloud server: " + file.getMimetype());
 332             boolean toastIt = true;
 333             String mimeType = "";
 334             try {
 335                 Intent i = new Intent(Intent.ACTION_VIEW);
 336                 mimeType = MimeTypeMap.getSingleton().getMimeTypeFromExtension(storagePath.substring(storagePath.lastIndexOf('.') + 1));
 337                 if (mimeType == null || !mimeType.equals(file.getMimetype())) {
 338                     if (mimeType != null) {
 339                         i.setDataAndType(Uri.parse("file://"+ encodedStoragePath), mimeType);
 340                     } else {
 341                         // desperate try
 342                         i.setDataAndType(Uri.parse("file://"+ encodedStoragePath), "*-/*");
 343                     }
 344                     i.setFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION | Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
 345                     startActivity(i);
 346                     toastIt = false;
 347                 }
 348
 349             } catch (IndexOutOfBoundsException e) {
 350                 Log_OC.e(TAG, "Trying to find out MIME type of a file without extension: " + storagePath);
 351
 352             } catch (ActivityNotFoundException e) {
 353                 Log_OC.e(TAG, "No activity found to handle: " + storagePath + " with MIME type " + mimeType + " obtained from extension");
 354
 355             } catch (Throwable th) {
 356                 Log_OC.e(TAG, "Unexpected problem when opening: " + storagePath, th);
 357
 358             } finally {
 359                 if (toastIt) {
 360                     Toast.makeText(getActivity(), "There is no application to handle file " + file.getFileName(), Toast.LENGTH_SHORT).show();
 361                 }
 362             }
 363
 364         }
 365         finish();
 366     }
 367
 368
 369     /**
 370      * Starts a the removal of the previewed file.
 371      *
 372      * Shows a confirmation dialog. The action continues in {@link #onConfirmation(String)} , {@link #onNeutral(String)} or {@link #onCancel(String)},
 373      * depending upon the user selection in the dialog.
 374      */
 375     private void removeFile() {
 376         ConfirmationDialogFragment confDialog = ConfirmationDialogFragment.newInstance(
 377                 R.string.confirmation_remove_alert,
 378                 new String[]{getFile().getFileName()},
 379                 R.string.confirmation_remove_remote_and_local,
 380                 R.string.confirmation_remove_local,
 381                 R.string.common_cancel);
 382         confDialog.setOnConfirmationListener(this);
 383         confDialog.show(getFragmentManager(), ConfirmationDialogFragment.FTAG_CONFIRMATION);
 384     }
 385
 386
 387     /**
 388      * Performs the removal of the previewed file, both locally and in the server.
 389      */
 390     @Override
 391     public void onConfirmation(String callerTag) {
 392         if (mStorageManager.getFileById(getFile().getFileId()) != null) {   // check that the file is still there;
 393             mLastRemoteOperation = new RemoveFileOperation( getFile(),      // TODO we need to review the interface with RemoteOperations, and use OCFile IDs instead of OCFile objects as parameters
 394                                                             true,
 395                                                             mStorageManager);
 396             mLastRemoteOperation.execute(mAccount, getSherlockActivity(), this, mHandler, getSherlockActivity());
 397
 398             ((PreviewImageActivity) getActivity()).showLoadingDialog();
 399         }
 400     }
 401
 402
 403     /**
 404      * Removes the file from local storage
 405      */
 406     @Override
 407     public void onNeutral(String callerTag) {
 408         OCFile file = getFile();
 409         mStorageManager.removeFile(file, false, true);    // TODO perform in background task / new thread
 410         finish();
 411     }
 412
 413     /**
 414      * User cancelled the removal action.
 415      */
 416     @Override
 417     public void onCancel(String callerTag) {
 418         // nothing to do here
 419     }
 420
 421
 422     private class BitmapLoader extends AsyncTask<String, Void, Bitmap> {
 423
 424         /**
 425          * Weak reference to the target {@link ImageView} where the bitmap will be loaded into.
 426          *
 427          * Using a weak reference will avoid memory leaks if the target ImageView is retired from memory before the load finishes.
 428          */
 429         private final WeakReference<ImageView> mImageViewRef;
 430
 431         /**
 432          * Weak reference to the target {@link TextView} where error messages will be written.
 433          *
 434          * Using a weak reference will avoid memory leaks if the target ImageView is retired from memory before the load finishes.
 435          */
 436         private final WeakReference<TextView> mMessageViewRef;
 437
 438
 439         /**
 440          * Weak reference to the target {@link Progressbar} shown while the load is in progress.
 441          *
 442          * Using a weak reference will avoid memory leaks if the target ImageView is retired from memory before the load finishes.
 443          */
 444         private final WeakReference<ProgressBar> mProgressWheelRef;
 445
 446
 447         /**
 448          * Error message to show when a load fails
 449          */
 450         private int mErrorMessageId;
 451
 452
 453         /**
 454          * Constructor.
 455          *
 456          * @param imageView     Target {@link ImageView} where the bitmap will be loaded into.
 457          */
 458         public BitmapLoader(ImageView imageView, TextView messageView, ProgressBar progressWheel) {
 459             mImageViewRef = new WeakReference<ImageView>(imageView);
 460             mMessageViewRef = new WeakReference<TextView>(messageView);
 461             mProgressWheelRef = new WeakReference<ProgressBar>(progressWheel);
 462         }
 463
 464
 465         @SuppressWarnings("deprecation")
 466         @SuppressLint({ "NewApi", "NewApi", "NewApi" }) // to avoid Lint errors since Android SDK r20
 467                 @Override
 468         protected Bitmap doInBackground(String... params) {
 469             Bitmap result = null;
 470             if (params.length != 1) return result;
 471             String storagePath = params[0];
 472             try {
 473                 // set desired options that will affect the size of the bitmap
 474                 BitmapFactory.Options options = new Options();
 475                 options.inScaled = true;
 476                 options.inPurgeable = true;
 477                 if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.GINGERBREAD_MR1) {
 478                     options.inPreferQualityOverSpeed = false;
 479                 }
 480                 if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.HONEYCOMB) {
 481                     options.inMutable = false;
 482                 }
 483                 // make a false load of the bitmap - just to be able to read outWidth, outHeight and outMimeType
 484                 options.inJustDecodeBounds = true;
 485                 BitmapFactory.decodeFile(storagePath, options);
 486
 487                 int width = options.outWidth;
 488                 int height = options.outHeight;
 489                 int scale = 1;
 490
 491                 Display display = getActivity().getWindowManager().getDefaultDisplay();
 492                 Point size = new Point();
 493                 int screenWidth;
 494                 int screenHeight;
 495                 if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.HONEYCOMB_MR2) {
 496                     display.getSize(size);
 497                     screenWidth = size.x;
 498                     screenHeight = size.y;
 499                 } else {
 500                     screenWidth = display.getWidth();
 501                     screenHeight = display.getHeight();
 502                 }
 503
 504                 if (width > screenWidth) {
 505                     // second try to scale down the image , this time depending upon the screen size
 506                     scale = (int) Math.floor((float)width / screenWidth);
 507                 }
 508                 if (height > screenHeight) {
 509                     scale = Math.max(scale, (int) Math.floor((float)height / screenHeight));
 510                 }
 511                 options.inSampleSize = scale;
 512
 513                 // really load the bitmap
 514                 options.inJustDecodeBounds = false; // the next decodeFile call will be real
 515                 result = BitmapFactory.decodeFile(storagePath, options);
 516                 //Log_OC.d(TAG, "Image loaded - width: " + options.outWidth + ", loaded height: " + options.outHeight);
 517
 518                 if (result == null) {
 519                     mErrorMessageId = R.string.preview_image_error_unknown_format;
 520                     Log_OC.e(TAG, "File could not be loaded as a bitmap: " + storagePath);
 521                 }
 522
 523             } catch (OutOfMemoryError e) {
 524                 mErrorMessageId = R.string.preview_image_error_unknown_format;
 525                 Log_OC.e(TAG, "Out of memory occured for file " + storagePath, e);
 526
 527             } catch (NoSuchFieldError e) {
 528                 mErrorMessageId = R.string.common_error_unknown;
 529                 Log_OC.e(TAG, "Error from access to unexisting field despite protection; file " + storagePath, e);
 530
 531             } catch (Throwable t) {
 532                 mErrorMessageId = R.string.common_error_unknown;
 533                 Log_OC.e(TAG, "Unexpected error loading " + getFile().getStoragePath(), t);
 534
 535             }
 536             return result;
 537         }
 538
 539         @Override
 540         protected void onPostExecute(Bitmap result) {
 541             hideProgressWheel();
 542             if (result != null) {
 543                 showLoadedImage(result);
 544             } else {
 545                 showErrorMessage();
 546             }
 547         }
 548
 549         private void showLoadedImage(Bitmap result) {
 550             if (mImageViewRef != null) {
 551                 final ImageView imageView = mImageViewRef.get();
 552                 if (imageView != null) {
 553                     imageView.setImageBitmap(result);
 554                     imageView.setVisibility(View.VISIBLE);
 555                     mBitmap  = result;
 556                 } // else , silently finish, the fragment was destroyed
 557             }
 558             if (mMessageViewRef != null) {
 559                 final TextView messageView = mMessageViewRef.get();
 560                 if (messageView != null) {
 561                     messageView.setVisibility(View.GONE);
 562                 } // else , silently finish, the fragment was destroyed
 563             }
 564         }
 565
 566         private void showErrorMessage() {
 567             if (mImageViewRef != null) {
 568                 final ImageView imageView = mImageViewRef.get();
 569                 if (imageView != null) {
 570                     // shows the default error icon
 571                     imageView.setVisibility(View.VISIBLE);
 572                 } // else , silently finish, the fragment was destroyed
 573             }
 574             if (mMessageViewRef != null) {
 575                 final TextView messageView = mMessageViewRef.get();
 576                 if (messageView != null) {
 577                     messageView.setText(mErrorMessageId);
 578                     messageView.setVisibility(View.VISIBLE);
 579                 } // else , silently finish, the fragment was destroyed
 580             }
 581         }
 582
 583         private void hideProgressWheel() {
 584             if (mProgressWheelRef != null) {
 585                 final ProgressBar progressWheel = mProgressWheelRef.get();
 586                 if (progressWheel != null) {
 587                     progressWheel.setVisibility(View.GONE);
 588                 }
 589             }
 590         }
 591
 592     }
 593
 594     /**
 595      * Helper method to test if an {@link OCFile} can be passed to a {@link PreviewImageFragment} to be previewed.
 596      *
 597      * @param file      File to test if can be previewed.
 598      * @return          'True' if the file can be handled by the fragment.
 599      */
 600     public static boolean canBePreviewed(OCFile file) {
 601         return (file != null && file.isImage());
 602     }
 603
 604
 605     /**
 606      * {@inheritDoc}
 607      */
 608     @Override
 609     public void onRemoteOperationFinish(RemoteOperation operation, RemoteOperationResult result) {
 610         if (operation.equals(mLastRemoteOperation) && operation instanceof RemoveFileOperation) {
 611             onRemoveFileOperationFinish((RemoveFileOperation)operation, result);
 612         }
 613     }
 614
 615     private void onRemoveFileOperationFinish(RemoveFileOperation operation, RemoteOperationResult result) {
 616         ((PreviewImageActivity) getActivity()).dismissLoadingDialog();
 617
 618         if (result.isSuccess()) {
 619             Toast msg = Toast.makeText(getActivity().getApplicationContext(), R.string.remove_success_msg, Toast.LENGTH_LONG);
 620             msg.show();
 621             finish();
 622
 623         } else {
 624             Toast msg = Toast.makeText(getActivity(), R.string.remove_fail_msg, Toast.LENGTH_LONG);
 625             msg.show();
 626             if (result.isSslRecoverableException()) {
 627                 // TODO show the SSL warning dialog
 628             }
 629         }
 630     }
 631
 632     /**
 633      * Finishes the preview
 634      */
 635     private void finish() {
 636         Activity container = getActivity();
 637         container.finish();
 638     }
 639
 640
 641 }