src/com/owncloud/android/ui/fragment/FileDetailFragment.java

   1 /**
   2  *   ownCloud Android client application
   3  *
   4  *   @author Bartek Przybylski
   5  *   @author David A. Velasco
   6  *   Copyright (C) 2011  Bartek Przybylski
   7  *   Copyright (C) 2015 ownCloud Inc.
   8  *
   9  *   This program is free software: you can redistribute it and/or modify
  10  *   it under the terms of the GNU General Public License version 2,
  11  *   as published by the Free Software Foundation.
  12  *
  13  *   This program is distributed in the hope that it will be useful,
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *   GNU General Public License for more details.
  17  *
  18  *   You should have received a copy of the GNU General Public License
  19  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  *
  21  */
  22 package com.owncloud.android.ui.fragment;
  23
  24 import java.lang.ref.WeakReference;
  25
  26 import android.accounts.Account;
  27 import android.content.Intent;
  28 import android.os.Bundle;
  29 import android.view.LayoutInflater;
  30 import android.view.Menu;
  31 import android.view.MenuInflater;
  32 import android.view.MenuItem;
  33 import android.view.View;
  34 import android.view.View.OnClickListener;
  35 import android.view.ViewGroup;
  36 import android.widget.CheckBox;
  37 import android.widget.ImageView;
  38 import android.widget.ProgressBar;
  39 import android.widget.TextView;
  40
  41 import com.owncloud.android.R;
  42 import com.owncloud.android.datamodel.FileDataStorageManager;
  43 import com.owncloud.android.datamodel.OCFile;
  44 import com.owncloud.android.files.FileMenuFilter;
  45 import com.owncloud.android.files.services.FileDownloader.FileDownloaderBinder;
  46 import com.owncloud.android.files.services.FileUploader.FileUploaderBinder;
  47 import com.owncloud.android.lib.common.network.OnDatatransferProgressListener;
  48 import com.owncloud.android.lib.common.utils.Log_OC;
  49 import com.owncloud.android.services.observer.FileObserverService;
  50 import com.owncloud.android.ui.activity.FileActivity;
  51 import com.owncloud.android.ui.activity.FileDisplayActivity;
  52 import com.owncloud.android.ui.dialog.RemoveFileDialogFragment;
  53 import com.owncloud.android.ui.dialog.RenameFileDialogFragment;
  54 import com.owncloud.android.utils.DisplayUtils;
  55
  56
  57 /**
  58  * This Fragment is used to display the details about a file.
  59  */
  60 public class FileDetailFragment extends FileFragment implements OnClickListener {
  61
  62     private int mLayout;
  63     private View mView;
  64     private Account mAccount;
  65
  66     public ProgressListener mProgressListener;
  67
  68     private static final String TAG = FileDetailFragment.class.getSimpleName();
  69     public static final String FTAG_CONFIRMATION = "REMOVE_CONFIRMATION_FRAGMENT";
  70     public static final String FTAG_RENAME_FILE = "RENAME_FILE_FRAGMENT";
  71
  72
  73     /**
  74      * Creates an empty details fragment.
  75      *
  76      * It's necessary to keep a public constructor without parameters; the system uses it when tries
  77      * to reinstantiate a fragment automatically.
  78      */
  79     public FileDetailFragment() {
  80         super();
  81         mAccount = null;
  82         mLayout = R.layout.file_details_empty;
  83         mProgressListener = null;
  84     }
  85
  86     /**
  87      * Creates a details fragment.
  88      *
  89      * When 'fileToDetail' or 'ocAccount' are null, creates a dummy layout (to use when a file wasn't tapped before).
  90      *
  91      * @param fileToDetail      An {@link OCFile} to show in the fragment
  92      * @param ocAccount         An ownCloud account; needed to start downloads
  93      */
  94     public FileDetailFragment(OCFile fileToDetail, Account ocAccount) {
  95         super(fileToDetail);
  96         mAccount = ocAccount;
  97         mLayout = R.layout.file_details_empty;
  98         mProgressListener = null;
  99     }
 100
 101
 102     @Override
 103     public void onActivityCreated(Bundle savedInstanceState) {
 104         super.onCreate(savedInstanceState);
 105         setHasOptionsMenu(true);
 106     }
 107
 108
 109     @Override
 110     public View onCreateView(LayoutInflater inflater, ViewGroup container,
 111             Bundle savedInstanceState) {
 112
 113         if (savedInstanceState != null) {
 114             setFile((OCFile)savedInstanceState.getParcelable(FileActivity.EXTRA_FILE));
 115             mAccount = savedInstanceState.getParcelable(FileActivity.EXTRA_ACCOUNT);
 116         }
 117
 118         if(getFile() != null && mAccount != null) {
 119             mLayout = R.layout.file_details_fragment;
 120         }
 121
 122         mView = inflater.inflate(mLayout, null);
 123
 124         if (mLayout == R.layout.file_details_fragment) {
 125             mView.findViewById(R.id.fdKeepInSync).setOnClickListener(this);
 126             ProgressBar progressBar = (ProgressBar)mView.findViewById(R.id.fdProgressBar);
 127             mProgressListener = new ProgressListener(progressBar);
 128             mView.findViewById(R.id.fdCancelBtn).setOnClickListener(this);
 129         }
 130
 131         updateFileDetails(false, false);
 132         return mView;
 133     }
 134
 135     @Override
 136     public void onSaveInstanceState(Bundle outState) {
 137         super.onSaveInstanceState(outState);
 138         outState.putParcelable(FileActivity.EXTRA_FILE, getFile());
 139         outState.putParcelable(FileActivity.EXTRA_ACCOUNT, mAccount);
 140     }
 141
 142     @Override
 143     public void onStart() {
 144         super.onStart();
 145         listenForTransferProgress();
 146     }
 147
 148     @Override
 149     public void onStop() {
 150         leaveTransferProgress();
 151         super.onStop();
 152     }
 153
 154
 155     @Override
 156     public View getView() {
 157         return super.getView() == null ? mView : super.getView();
 158     }
 159
 160
 161     /**
 162      * {@inheritDoc}
 163      */
 164     @Override
 165     public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) {
 166         super.onCreateOptionsMenu(menu, inflater);
 167         inflater.inflate(R.menu.file_actions_menu, menu);
 168    }
 169
 170
 171     /**
 172      * {@inheritDoc}
 173      */
 174     @Override
 175     public void onPrepareOptionsMenu (Menu menu) {
 176         super.onPrepareOptionsMenu(menu);
 177
 178         if (mContainerActivity.getStorageManager() != null) {
 179             FileMenuFilter mf = new FileMenuFilter(
 180                 getFile(),
 181                 mContainerActivity.getStorageManager().getAccount(),
 182                 mContainerActivity,
 183                 getActivity()
 184             );
 185             mf.filter(menu);
 186         }
 187
 188         // additional restriction for this fragment
 189         MenuItem item = menu.findItem(R.id.action_see_details);
 190         if (item != null) {
 191             item.setVisible(false);
 192             item.setEnabled(false);
 193         }
 194
 195         // additional restriction for this fragment
 196         item = menu.findItem(R.id.action_move);
 197         if (item != null) {
 198             item.setVisible(false);
 199             item.setEnabled(false);
 200         }
 201     }
 202
 203
 204     /**
 205      * {@inheritDoc}
 206      */
 207     @Override
 208     public boolean onOptionsItemSelected(MenuItem item) {
 209         switch (item.getItemId()) {
 210             case R.id.action_share_file: {
 211                 mContainerActivity.getFileOperationsHelper().shareFileWithLink(getFile());
 212                 return true;
 213             }
 214             case R.id.action_unshare_file: {
 215                 mContainerActivity.getFileOperationsHelper().unshareFileWithLink(getFile());
 216                 return true;
 217             }
 218             case R.id.action_open_file_with: {
 219                 mContainerActivity.getFileOperationsHelper().openFile(getFile());
 220                 return true;
 221             }
 222             case R.id.action_remove_file: {
 223                 RemoveFileDialogFragment dialog = RemoveFileDialogFragment.newInstance(getFile());
 224                 dialog.show(getFragmentManager(), FTAG_CONFIRMATION);
 225                 return true;
 226             }
 227             case R.id.action_rename_file: {
 228                 RenameFileDialogFragment dialog = RenameFileDialogFragment.newInstance(getFile());
 229                 dialog.show(getFragmentManager(), FTAG_RENAME_FILE);
 230                 return true;
 231             }
 232             case R.id.action_cancel_download:
 233             case R.id.action_cancel_upload: {
 234                 ((FileDisplayActivity)mContainerActivity).cancelTransference(getFile());
 235                 return true;
 236             }
 237             case R.id.action_download_file:
 238             case R.id.action_sync_file: {
 239                 mContainerActivity.getFileOperationsHelper().syncFile(getFile());
 240                 return true;
 241             }
 242             case R.id.action_send_file: {
 243                 // Obtain the file
 244                 if (!getFile().isDown()) {  // Download the file
 245                     Log_OC.d(TAG, getFile().getRemotePath() + " : File must be downloaded");
 246                     ((FileDisplayActivity)mContainerActivity).startDownloadForSending(getFile());
 247
 248                 } else {
 249                     mContainerActivity.getFileOperationsHelper().sendDownloadedFile(getFile());
 250                 }
 251                 return true;
 252             }
 253             default:
 254                 return false;
 255         }
 256     }
 257
 258     @Override
 259     public void onClick(View v) {
 260         switch (v.getId()) {
 261             case R.id.fdKeepInSync: {
 262                 toggleKeepInSync();
 263                 break;
 264             }
 265             case R.id.fdCancelBtn: {
 266                 ((FileDisplayActivity)mContainerActivity).cancelTransference(getFile());
 267                 break;
 268             }
 269             default:
 270                 Log_OC.e(TAG, "Incorrect view clicked!");
 271         }
 272     }
 273
 274
 275     private void toggleKeepInSync() {
 276         CheckBox cb = (CheckBox) getView().findViewById(R.id.fdKeepInSync);
 277         OCFile file = getFile();
 278         file.setKeepInSync(cb.isChecked());
 279         mContainerActivity.getStorageManager().saveFile(file);
 280
 281         /// register the OCFile instance in the observer service to monitor local updates
 282         Intent observedFileIntent = FileObserverService.makeObservedFileIntent(
 283                 getActivity(),
 284                 file,
 285                 mAccount,
 286                 cb.isChecked());
 287         getActivity().startService(observedFileIntent);
 288
 289         /// immediate content synchronization
 290         if (file.keepInSync()) {
 291             mContainerActivity.getFileOperationsHelper().syncFile(getFile());
 292         }
 293     }
 294
 295     /**
 296      * Check if the fragment was created with an empty layout. An empty fragment can't show file details, must be replaced.
 297      *
 298      * @return  True when the fragment was created with the empty layout.
 299      */
 300     public boolean isEmpty() {
 301         return (mLayout == R.layout.file_details_empty || getFile() == null || mAccount == null);
 302     }
 303
 304
 305     /**
 306      * Use this method to signal this Activity that it shall update its view.
 307      *
 308      * @param file : An {@link OCFile}
 309      */
 310     public void updateFileDetails(OCFile file, Account ocAccount) {
 311         setFile(file);
 312         mAccount = ocAccount;
 313         updateFileDetails(false, false);
 314     }
 315
 316     /**
 317      * Updates the view with all relevant details about that file.
 318      *
 319      * TODO Remove parameter when the transferring state of files is kept in database.
 320      *
 321      * @param transferring      Flag signaling if the file should be considered as downloading or uploading,
 322      *                          although {@link FileDownloaderBinder#isDownloading(Account, OCFile)}  and
 323      *                          {@link FileUploaderBinder#isUploading(Account, OCFile)} return false.
 324      *
 325      * @param refresh           If 'true', try to refresh the whole file from the database
 326      */
 327     public void updateFileDetails(boolean transferring, boolean refresh) {
 328         if (readyToShow()) {
 329             FileDataStorageManager storageManager = mContainerActivity.getStorageManager();
 330             if (refresh && storageManager != null) {
 331                 setFile(storageManager.getFileByPath(getFile().getRemotePath()));
 332             }
 333             OCFile file = getFile();
 334
 335             // set file details
 336             setFilename(file.getFileName());
 337             setFiletype(file.getMimetype(), file.getFileName());
 338             setFilesize(file.getFileLength());
 339
 340             setTimeModified(file.getModificationTimestamp());
 341
 342             CheckBox cb = (CheckBox)getView().findViewById(R.id.fdKeepInSync);
 343             cb.setChecked(file.keepInSync());
 344
 345             // configure UI for depending upon local state of the file
 346             FileDownloaderBinder downloaderBinder = mContainerActivity.getFileDownloaderBinder();
 347             FileUploaderBinder uploaderBinder = mContainerActivity.getFileUploaderBinder();
 348             if (transferring ||
 349                     (downloaderBinder != null && downloaderBinder.isDownloading(mAccount, file)) ||
 350                     (uploaderBinder != null && uploaderBinder.isUploading(mAccount, file))
 351                     ) {
 352                 setButtonsForTransferring();
 353
 354             } else if (file.isDown()) {
 355
 356                 setButtonsForDown();
 357
 358             } else {
 359                 // TODO load default preview image; when the local file is removed, the preview
 360                 // remains there
 361                 setButtonsForRemote();
 362             }
 363         }
 364         getView().invalidate();
 365     }
 366
 367     /**
 368      * Checks if the fragment is ready to show details of a OCFile
 369      *
 370      * @return  'True' when the fragment is ready to show details of a file
 371      */
 372     private boolean readyToShow() {
 373         return (getFile() != null && mAccount != null && mLayout == R.layout.file_details_fragment);
 374     }
 375
 376
 377     /**
 378      * Updates the filename in view
 379      * @param filename to set
 380      */
 381     private void setFilename(String filename) {
 382         TextView tv = (TextView) getView().findViewById(R.id.fdFilename);
 383         if (tv != null)
 384             tv.setText(filename);
 385     }
 386
 387     /**
 388      * Updates the MIME type in view
 389      * @param mimetype      MIME type to set
 390      * @param filename      Name of the file, to deduce the icon to use in case the MIME type is not precise enough
 391      */
 392     private void setFiletype(String mimetype, String filename) {
 393         TextView tv = (TextView) getView().findViewById(R.id.fdType);
 394         if (tv != null) {
 395             String printableMimetype = DisplayUtils.convertMIMEtoPrettyPrint(mimetype);;
 396             tv.setText(printableMimetype);
 397         }
 398         ImageView iv = (ImageView) getView().findViewById(R.id.fdIcon);
 399         if (iv != null) {
 400             iv.setImageResource(DisplayUtils.getFileTypeIconId(mimetype, filename));
 401         }
 402     }
 403
 404     /**
 405      * Updates the file size in view
 406      * @param filesize in bytes to set
 407      */
 408     private void setFilesize(long filesize) {
 409         TextView tv = (TextView) getView().findViewById(R.id.fdSize);
 410         if (tv != null)
 411             tv.setText(DisplayUtils.bytesToHumanReadable(filesize));
 412     }
 413
 414     /**
 415      * Updates the time that the file was last modified
 416      * @param milliseconds Unix time to set
 417      */
 418     private void setTimeModified(long milliseconds){
 419         TextView tv = (TextView) getView().findViewById(R.id.fdModified);
 420         if(tv != null){
 421             tv.setText(DisplayUtils.unixTimeToHumanReadable(milliseconds));
 422         }
 423     }
 424
 425     /**
 426      * Enables or disables buttons for a file being downloaded
 427      */
 428     private void setButtonsForTransferring() {
 429         if (!isEmpty()) {
 430             // let's protect the user from himself ;)
 431             getView().findViewById(R.id.fdKeepInSync).setEnabled(false);
 432
 433             // show the progress bar for the transfer
 434             getView().findViewById(R.id.fdProgressBlock).setVisibility(View.VISIBLE);
 435             TextView progressText = (TextView)getView().findViewById(R.id.fdProgressText);
 436             progressText.setVisibility(View.VISIBLE);
 437             FileDownloaderBinder downloaderBinder = mContainerActivity.getFileDownloaderBinder();
 438             FileUploaderBinder uploaderBinder = mContainerActivity.getFileUploaderBinder();
 439             //if (getFile().isDownloading()) {
 440             if (downloaderBinder != null && downloaderBinder.isDownloading(mAccount, getFile())) {
 441                 progressText.setText(R.string.downloader_download_in_progress_ticker);
 442             } else if (uploaderBinder != null && uploaderBinder.isUploading(mAccount, getFile())) {
 443                 progressText.setText(R.string.uploader_upload_in_progress_ticker);
 444             }
 445         }
 446     }
 447
 448     /**
 449      * Enables or disables buttons for a file locally available
 450      */
 451     private void setButtonsForDown() {
 452         if (!isEmpty()) {
 453             getView().findViewById(R.id.fdKeepInSync).setEnabled(true);
 454
 455             // hides the progress bar
 456             getView().findViewById(R.id.fdProgressBlock).setVisibility(View.GONE);
 457             TextView progressText = (TextView)getView().findViewById(R.id.fdProgressText);
 458             progressText.setVisibility(View.GONE);
 459         }
 460     }
 461
 462     /**
 463      * Enables or disables buttons for a file not locally available
 464      */
 465     private void setButtonsForRemote() {
 466         if (!isEmpty()) {
 467             getView().findViewById(R.id.fdKeepInSync).setEnabled(true);
 468
 469             // hides the progress bar
 470             getView().findViewById(R.id.fdProgressBlock).setVisibility(View.GONE);
 471             TextView progressText = (TextView)getView().findViewById(R.id.fdProgressText);
 472             progressText.setVisibility(View.GONE);
 473         }
 474     }
 475
 476
 477     public void listenForTransferProgress() {
 478         if (mProgressListener != null) {
 479             if (mContainerActivity.getFileDownloaderBinder() != null) {
 480                 mContainerActivity.getFileDownloaderBinder().
 481                         addDatatransferProgressListener(mProgressListener, mAccount, getFile());
 482             }
 483             if (mContainerActivity.getFileUploaderBinder() != null) {
 484                 mContainerActivity.getFileUploaderBinder().
 485                         addDatatransferProgressListener(mProgressListener, mAccount, getFile());
 486             }
 487         }
 488     }
 489
 490
 491     public void leaveTransferProgress() {
 492         if (mProgressListener != null) {
 493             if (mContainerActivity.getFileDownloaderBinder() != null) {
 494                 mContainerActivity.getFileDownloaderBinder().
 495                         removeDatatransferProgressListener(mProgressListener, mAccount, getFile());
 496             }
 497             if (mContainerActivity.getFileUploaderBinder() != null) {
 498                 mContainerActivity.getFileUploaderBinder().
 499                         removeDatatransferProgressListener(mProgressListener, mAccount, getFile());
 500             }
 501         }
 502     }
 503
 504
 505
 506     /**
 507      * Helper class responsible for updating the progress bar shown for file uploading or
 508      * downloading
 509      */
 510     private class ProgressListener implements OnDatatransferProgressListener {
 511         int mLastPercent = 0;
 512         WeakReference<ProgressBar> mProgressBar = null;
 513
 514         ProgressListener(ProgressBar progressBar) {
 515             mProgressBar = new WeakReference<ProgressBar>(progressBar);
 516         }
 517
 518         @Override
 519         public void onTransferProgress(long progressRate, long totalTransferredSoFar,
 520                                        long totalToTransfer, String filename) {
 521             int percent = (int)(100.0*((double)totalTransferredSoFar)/((double)totalToTransfer));
 522             if (percent != mLastPercent) {
 523                 ProgressBar pb = mProgressBar.get();
 524                 if (pb != null) {
 525                     pb.setProgress(percent);
 526                     pb.postInvalidate();
 527                 }
 528             }
 529             mLastPercent = percent;
 530         }
 531
 532     }
 533
 534 }