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