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