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

   1 /* ownCloud Android client application
   2  *   Copyright (C) 2011  Bartek Przybylski
   3  *   Copyright (C) 2012-2013 ownCloud Inc.
   4  *
   5  *   This program is free software: you can redistribute it and/or modify
   6  *   it under the terms of the GNU General Public License version 2,
   7  *   as published by the Free Software Foundation.
   8  *
   9  *   This program is distributed in the hope that it will be useful,
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *   GNU General Public License for more details.
  13  *
  14  *   You should have received a copy of the GNU General Public License
  15  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  *
  17  */
  18 package com.owncloud.android.ui.fragment;
  19
  20 import java.lang.ref.WeakReference;
  21
  22 import android.accounts.Account;
  23 import android.content.Intent;
  24 import android.os.Bundle;
  25 import android.view.LayoutInflater;
  26 import android.view.View;
  27 import android.view.View.OnClickListener;
  28 import android.view.ViewGroup;
  29 import android.widget.CheckBox;
  30 import android.widget.ImageView;
  31 import android.widget.ProgressBar;
  32 import android.widget.TextView;
  33
  34 import com.actionbarsherlock.view.Menu;
  35 import com.actionbarsherlock.view.MenuInflater;
  36 import com.actionbarsherlock.view.MenuItem;
  37 import com.owncloud.android.R;
  38 import com.owncloud.android.datamodel.FileDataStorageManager;
  39 import com.owncloud.android.datamodel.OCFile;
  40 import com.owncloud.android.files.FileMenuFilter;
  41 import com.owncloud.android.files.services.FileDownloader.FileDownloaderBinder;
  42 import com.owncloud.android.files.services.FileUploader.FileUploaderBinder;
  43 import com.owncloud.android.lib.common.network.OnDatatransferProgressListener;
  44 import com.owncloud.android.lib.common.utils.Log_OC;
  45 import com.owncloud.android.services.observer.FileObserverService;
  46 import com.owncloud.android.ui.activity.FileActivity;
  47 import com.owncloud.android.ui.activity.FileDisplayActivity;
  48 import com.owncloud.android.ui.dialog.RemoveFileDialogFragment;
  49 import com.owncloud.android.ui.dialog.RenameFileDialogFragment;
  50 import com.owncloud.android.utils.DisplayUtils;
  51
  52
  53 /**
  54  * This Fragment is used to display the details about a file.
  55  *
  56  * @author Bartek Przybylski
  57  * @author David A. Velasco
  58  */
  59 public class FileDetailFragment extends FileFragment implements OnClickListener {
  60
  61     private int mLayout;
  62     private View mView;
  63     private Account mAccount;
  64
  65     public ProgressListener mProgressListener;
  66
  67     private static final String TAG = FileDetailFragment.class.getSimpleName();
  68     public static final String FTAG_CONFIRMATION = "REMOVE_CONFIRMATION_FRAGMENT";
  69     public static final String FTAG_RENAME_FILE = "RENAME_FILE_FRAGMENT";
  70
  71
  72     /**
  73      * Creates an empty details fragment.
  74      *
  75      * It's necessary to keep a public constructor without parameters; the system uses it when tries to reinstantiate a fragment automatically.
  76      */
  77     public FileDetailFragment() {
  78         super();
  79         mAccount = null;
  80         mLayout = R.layout.file_details_empty;
  81         mProgressListener = null;
  82     }
  83
  84     /**
  85      * Creates a details fragment.
  86      *
  87      * When 'fileToDetail' or 'ocAccount' are null, creates a dummy layout (to use when a file wasn't tapped before).
  88      *
  89      * @param fileToDetail      An {@link OCFile} to show in the fragment
  90      * @param ocAccount         An ownCloud account; needed to start downloads
  91      */
  92     public FileDetailFragment(OCFile fileToDetail, Account ocAccount) {
  93         super(fileToDetail);
  94         mAccount = ocAccount;
  95         mLayout = R.layout.file_details_empty;
  96         mProgressListener = null;
  97     }
  98
  99
 100     @Override
 101     public void onActivityCreated(Bundle savedInstanceState) {
 102         super.onCreate(savedInstanceState);
 103         setHasOptionsMenu(true);
 104     }
 105
 106
 107     @Override
 108     public View onCreateView(LayoutInflater inflater, ViewGroup container,
 109             Bundle savedInstanceState) {
 110
 111         if (savedInstanceState != null) {
 112             setFile((OCFile)savedInstanceState.getParcelable(FileActivity.EXTRA_FILE));
 113             mAccount = savedInstanceState.getParcelable(FileActivity.EXTRA_ACCOUNT);
 114         }
 115
 116         if(getFile() != null && mAccount != null) {
 117             mLayout = R.layout.file_details_fragment;
 118         }
 119
 120         View view = null;
 121         view = inflater.inflate(mLayout, null);
 122         mView = view;
 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 view;
 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                 getSherlockActivity()
 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             if(ocVersionSupportsTimeCreated()){
 340                 setTimeCreated(file.getCreationTimestamp());
 341             }
 342
 343             setTimeModified(file.getModificationTimestamp());
 344
 345             CheckBox cb = (CheckBox)getView().findViewById(R.id.fdKeepInSync);
 346             cb.setChecked(file.keepInSync());
 347
 348             // configure UI for depending upon local state of the file
 349             FileUploaderBinder uploaderBinder = mContainerActivity.getFileUploaderBinder();
 350             if (transferring || file.isDownloading() || uploaderBinder.isUploading(mAccount, file)) {
 351                 setButtonsForTransferring();
 352
 353             } else if (file.isDown()) {
 354
 355                 setButtonsForDown();
 356
 357             } else {
 358                 // TODO load default preview image; when the local file is removed, the preview remains there
 359                 setButtonsForRemote();
 360             }
 361         }
 362         getView().invalidate();
 363     }
 364
 365     /**
 366      * Checks if the fragment is ready to show details of a OCFile
 367      *
 368      * @return  'True' when the fragment is ready to show details of a file
 369      */
 370     private boolean readyToShow() {
 371         return (getFile() != null && mAccount != null && mLayout == R.layout.file_details_fragment);
 372     }
 373
 374
 375     /**
 376      * Updates the filename in view
 377      * @param filename to set
 378      */
 379     private void setFilename(String filename) {
 380         TextView tv = (TextView) getView().findViewById(R.id.fdFilename);
 381         if (tv != null)
 382             tv.setText(filename);
 383     }
 384
 385     /**
 386      * Updates the MIME type in view
 387      * @param mimetype to set
 388      * @param filename
 389      */
 390     private void setFiletype(String mimetype, String filename) {
 391         TextView tv = (TextView) getView().findViewById(R.id.fdType);
 392         if (tv != null) {
 393             String printableMimetype = DisplayUtils.convertMIMEtoPrettyPrint(mimetype);;
 394             tv.setText(printableMimetype);
 395         }
 396         ImageView iv = (ImageView) getView().findViewById(R.id.fdIcon);
 397         if (iv != null) {
 398             iv.setImageResource(DisplayUtils.getFileTypeIconId(mimetype, filename));
 399         }
 400     }
 401
 402     /**
 403      * Updates the file size in view
 404      * @param filesize in bytes to set
 405      */
 406     private void setFilesize(long filesize) {
 407         TextView tv = (TextView) getView().findViewById(R.id.fdSize);
 408         if (tv != null)
 409             tv.setText(DisplayUtils.bytesToHumanReadable(filesize));
 410     }
 411
 412     /**
 413      * Updates the time that the file was created in view
 414      * @param milliseconds Unix time to set
 415      */
 416     private void setTimeCreated(long milliseconds){
 417         TextView tv = (TextView) getView().findViewById(R.id.fdCreated);
 418         TextView tvLabel = (TextView) getView().findViewById(R.id.fdCreatedLabel);
 419         if(tv != null){
 420             tv.setText(DisplayUtils.unixTimeToHumanReadable(milliseconds));
 421             tv.setVisibility(View.VISIBLE);
 422             tvLabel.setVisibility(View.VISIBLE);
 423         }
 424     }
 425
 426     /**
 427      * Updates the time that the file was last modified
 428      * @param milliseconds Unix time to set
 429      */
 430     private void setTimeModified(long milliseconds){
 431         TextView tv = (TextView) getView().findViewById(R.id.fdModified);
 432         if(tv != null){
 433             tv.setText(DisplayUtils.unixTimeToHumanReadable(milliseconds));
 434         }
 435     }
 436
 437     /**
 438      * Enables or disables buttons for a file being downloaded
 439      */
 440     private void setButtonsForTransferring() {
 441         if (!isEmpty()) {
 442             // let's protect the user from himself ;)
 443             getView().findViewById(R.id.fdKeepInSync).setEnabled(false);
 444
 445             // show the progress bar for the transfer
 446             getView().findViewById(R.id.fdProgressBlock).setVisibility(View.VISIBLE);
 447             TextView progressText = (TextView)getView().findViewById(R.id.fdProgressText);
 448             progressText.setVisibility(View.VISIBLE);
 449             FileUploaderBinder uploaderBinder = mContainerActivity.getFileUploaderBinder();
 450             if (getFile().isDownloading()) {
 451                 progressText.setText(R.string.downloader_download_in_progress_ticker);
 452             } else if (uploaderBinder != null && uploaderBinder.isUploading(mAccount, getFile())) {
 453                 progressText.setText(R.string.uploader_upload_in_progress_ticker);
 454             }
 455         }
 456     }
 457
 458     /**
 459      * Enables or disables buttons for a file locally available
 460      */
 461     private void setButtonsForDown() {
 462         if (!isEmpty()) {
 463             getView().findViewById(R.id.fdKeepInSync).setEnabled(true);
 464
 465             // hides the progress bar
 466             getView().findViewById(R.id.fdProgressBlock).setVisibility(View.GONE);
 467             TextView progressText = (TextView)getView().findViewById(R.id.fdProgressText);
 468             progressText.setVisibility(View.GONE);
 469         }
 470     }
 471
 472     /**
 473      * Enables or disables buttons for a file not locally available
 474      */
 475     private void setButtonsForRemote() {
 476         if (!isEmpty()) {
 477             getView().findViewById(R.id.fdKeepInSync).setEnabled(true);
 478
 479             // hides the progress bar
 480             getView().findViewById(R.id.fdProgressBlock).setVisibility(View.GONE);
 481             TextView progressText = (TextView)getView().findViewById(R.id.fdProgressText);
 482             progressText.setVisibility(View.GONE);
 483         }
 484     }
 485
 486
 487     /**
 488      * In ownCloud 3.X.X and 4.X.X there is a bug that SabreDAV does not return
 489      * the time that the file was created. There is a chance that this will
 490      * be fixed in future versions. Use this method to check if this version of
 491      * ownCloud has this fix.
 492      * @return True, if ownCloud the ownCloud version is supporting creation time
 493      */
 494     private boolean ocVersionSupportsTimeCreated(){
 495         /*if(mAccount != null){
 496             AccountManager accManager = (AccountManager) getActivity().getSystemService(Context.ACCOUNT_SERVICE);
 497             OwnCloudVersion ocVersion = new OwnCloudVersion(accManager
 498                     .getUserData(mAccount, AccountAuthenticator.KEY_OC_VERSION));
 499             if(ocVersion.compareTo(new OwnCloudVersion(0x030000)) < 0) {
 500                 return true;
 501             }
 502         }*/
 503         return false;
 504     }
 505
 506
 507     public void listenForTransferProgress() {
 508         if (mProgressListener != null) {
 509             if (mContainerActivity.getFileDownloaderBinder() != null) {
 510                 mContainerActivity.getFileDownloaderBinder().addDatatransferProgressListener(mProgressListener, mAccount, getFile());
 511             }
 512             if (mContainerActivity.getFileUploaderBinder() != null) {
 513                 mContainerActivity.getFileUploaderBinder().addDatatransferProgressListener(mProgressListener, mAccount, getFile());
 514             }
 515         }
 516     }
 517
 518
 519     public void leaveTransferProgress() {
 520         if (mProgressListener != null) {
 521             if (mContainerActivity.getFileDownloaderBinder() != null) {
 522                 mContainerActivity.getFileDownloaderBinder().removeDatatransferProgressListener(mProgressListener, mAccount, getFile());
 523             }
 524             if (mContainerActivity.getFileUploaderBinder() != null) {
 525                 mContainerActivity.getFileUploaderBinder().removeDatatransferProgressListener(mProgressListener, mAccount, getFile());
 526             }
 527         }
 528     }
 529
 530
 531
 532     /**
 533      * Helper class responsible for updating the progress bar shown for file uploading or downloading
 534      *
 535      * @author David A. Velasco
 536      */
 537     private class ProgressListener implements OnDatatransferProgressListener {
 538         int mLastPercent = 0;
 539         WeakReference<ProgressBar> mProgressBar = null;
 540
 541         ProgressListener(ProgressBar progressBar) {
 542             mProgressBar = new WeakReference<ProgressBar>(progressBar);
 543         }
 544
 545         @Override
 546         public void onTransferProgress(long progressRate, long totalTransferredSoFar, long totalToTransfer, String filename) {
 547             int percent = (int)(100.0*((double)totalTransferredSoFar)/((double)totalToTransfer));
 548             if (percent != mLastPercent) {
 549                 ProgressBar pb = mProgressBar.get();
 550                 if (pb != null) {
 551                     pb.setProgress(percent);
 552                     pb.postInvalidate();
 553                 }
 554             }
 555             mLastPercent = percent;
 556         }
 557
 558     };
 559
 560 }