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