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.FileObserverService;
  42 import com.owncloud.android.files.services.FileDownloader.FileDownloaderBinder;
  43 import com.owncloud.android.files.services.FileUploader.FileUploaderBinder;
  44 import com.owncloud.android.lib.common.network.OnDatatransferProgressListener;
  45 import com.owncloud.android.ui.activity.FileActivity;
  46 import com.owncloud.android.ui.activity.FileDisplayActivity;
  47 import com.owncloud.android.ui.dialog.RemoveFileDialogFragment;
  48 import com.owncloud.android.ui.dialog.RenameFileDialogFragment;
  49 import com.owncloud.android.utils.DisplayUtils;
  50 import com.owncloud.android.utils.Log_OC;
  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
 196
 197     /**
 198      * {@inheritDoc}
 199      */
 200     @Override
 201     public boolean onOptionsItemSelected(MenuItem item) {
 202         switch (item.getItemId()) {
 203             case R.id.action_share_file: {
 204                 mContainerActivity.getFileOperationsHelper().shareFileWithLink(getFile());
 205                 return true;
 206             }
 207             case R.id.action_unshare_file: {
 208                 mContainerActivity.getFileOperationsHelper().unshareFileWithLink(getFile());
 209                 return true;
 210             }
 211             case R.id.action_open_file_with: {
 212                 mContainerActivity.getFileOperationsHelper().openFile(getFile());
 213                 return true;
 214             }
 215             case R.id.action_remove_file: {
 216                 RemoveFileDialogFragment dialog = RemoveFileDialogFragment.newInstance(getFile());
 217                 dialog.show(getFragmentManager(), FTAG_CONFIRMATION);
 218                 return true;
 219             }
 220             case R.id.action_rename_file: {
 221                 RenameFileDialogFragment dialog = RenameFileDialogFragment.newInstance(getFile());
 222                 dialog.show(getFragmentManager(), FTAG_RENAME_FILE);
 223                 return true;
 224             }
 225             case R.id.action_cancel_download:
 226             case R.id.action_cancel_upload: {
 227                 ((FileDisplayActivity)mContainerActivity).cancelTransference(getFile());
 228                 return true;
 229             }
 230             case R.id.action_download_file:
 231             case R.id.action_sync_file: {
 232                 mContainerActivity.getFileOperationsHelper().syncFile(getFile());
 233                 return true;
 234             }
 235             case R.id.action_send_file: {
 236                 // Obtain the file
 237                 if (!getFile().isDown()) {  // Download the file
 238                     Log_OC.d(TAG, getFile().getRemotePath() + " : File must be downloaded");
 239                     ((FileDisplayActivity)mContainerActivity).startDownloadForSending(getFile());
 240
 241                 } else {
 242                     mContainerActivity.getFileOperationsHelper().sendDownloadedFile(getFile());
 243                 }
 244                 return true;
 245             }
 246             default:
 247                 return false;
 248         }
 249     }
 250
 251     @Override
 252     public void onClick(View v) {
 253         switch (v.getId()) {
 254             case R.id.fdKeepInSync: {
 255                 toggleKeepInSync();
 256                 break;
 257             }
 258             case R.id.fdCancelBtn: {
 259                 ((FileDisplayActivity)mContainerActivity).cancelTransference(getFile());
 260                 break;
 261             }
 262             default:
 263                 Log_OC.e(TAG, "Incorrect view clicked!");
 264         }
 265     }
 266
 267
 268     private void toggleKeepInSync() {
 269         CheckBox cb = (CheckBox) getView().findViewById(R.id.fdKeepInSync);
 270         OCFile file = getFile();
 271         file.setKeepInSync(cb.isChecked());
 272         mContainerActivity.getStorageManager().saveFile(file);
 273
 274         /// register the OCFile instance in the observer service to monitor local updates;
 275         /// if necessary, the file is download
 276         Intent intent = new Intent(getActivity().getApplicationContext(),
 277                                    FileObserverService.class);
 278         intent.putExtra(FileObserverService.KEY_FILE_CMD,
 279                    (cb.isChecked()?
 280                            FileObserverService.CMD_ADD_OBSERVED_FILE:
 281                            FileObserverService.CMD_DEL_OBSERVED_FILE));
 282         intent.putExtra(FileObserverService.KEY_CMD_ARG_FILE, file);
 283         intent.putExtra(FileObserverService.KEY_CMD_ARG_ACCOUNT, mAccount);
 284         getActivity().startService(intent);
 285
 286         if (file.keepInSync()) {
 287             mContainerActivity.getFileOperationsHelper().syncFile(getFile());
 288         }
 289     }
 290
 291     /**
 292      * Check if the fragment was created with an empty layout. An empty fragment can't show file details, must be replaced.
 293      *
 294      * @return  True when the fragment was created with the empty layout.
 295      */
 296     public boolean isEmpty() {
 297         return (mLayout == R.layout.file_details_empty || getFile() == null || mAccount == null);
 298     }
 299
 300
 301     /**
 302      * Use this method to signal this Activity that it shall update its view.
 303      *
 304      * @param file : An {@link OCFile}
 305      */
 306     public void updateFileDetails(OCFile file, Account ocAccount) {
 307         setFile(file);
 308         mAccount = ocAccount;
 309         updateFileDetails(false, false);
 310     }
 311
 312     /**
 313      * Updates the view with all relevant details about that file.
 314      *
 315      * TODO Remove parameter when the transferring state of files is kept in database.
 316      *
 317      * @param transferring      Flag signaling if the file should be considered as downloading or uploading,
 318      *                          although {@link FileDownloaderBinder#isDownloading(Account, OCFile)}  and
 319      *                          {@link FileUploaderBinder#isUploading(Account, OCFile)} return false.
 320      *
 321      * @param refresh           If 'true', try to refresh the whole file from the database
 322      */
 323     public void updateFileDetails(boolean transferring, boolean refresh) {
 324         if (readyToShow()) {
 325             FileDataStorageManager storageManager = mContainerActivity.getStorageManager();
 326             if (refresh && storageManager != null) {
 327                 setFile(storageManager.getFileByPath(getFile().getRemotePath()));
 328             }
 329             OCFile file = getFile();
 330
 331             // set file details
 332             setFilename(file.getFileName());
 333             setFiletype(file.getMimetype(), file.getFileName());
 334             setFilesize(file.getFileLength());
 335             if(ocVersionSupportsTimeCreated()){
 336                 setTimeCreated(file.getCreationTimestamp());
 337             }
 338
 339             setTimeModified(file.getModificationTimestamp());
 340
 341             CheckBox cb = (CheckBox)getView().findViewById(R.id.fdKeepInSync);
 342             cb.setChecked(file.keepInSync());
 343
 344             // configure UI for depending upon local state of the file
 345             FileDownloaderBinder downloaderBinder = mContainerActivity.getFileDownloaderBinder();
 346             FileUploaderBinder uploaderBinder = mContainerActivity.getFileUploaderBinder();
 347             if (transferring || (downloaderBinder != null && downloaderBinder.isDownloading(mAccount, file)) || (uploaderBinder != null && uploaderBinder.isUploading(mAccount, file))) {
 348                 setButtonsForTransferring();
 349
 350             } else if (file.isDown()) {
 351
 352                 setButtonsForDown();
 353
 354             } else {
 355                 // TODO load default preview image; when the local file is removed, the preview remains there
 356                 setButtonsForRemote();
 357             }
 358         }
 359         getView().invalidate();
 360     }
 361
 362     /**
 363      * Checks if the fragment is ready to show details of a OCFile
 364      *
 365      * @return  'True' when the fragment is ready to show details of a file
 366      */
 367     private boolean readyToShow() {
 368         return (getFile() != null && mAccount != null && mLayout == R.layout.file_details_fragment);
 369     }
 370
 371
 372     /**
 373      * Updates the filename in view
 374      * @param filename to set
 375      */
 376     private void setFilename(String filename) {
 377         TextView tv = (TextView) getView().findViewById(R.id.fdFilename);
 378         if (tv != null)
 379             tv.setText(filename);
 380     }
 381
 382     /**
 383      * Updates the MIME type in view
 384      * @param mimetype to set
 385      */
 386     private void setFiletype(String mimetype, String filename) {
 387         TextView tv = (TextView) getView().findViewById(R.id.fdType);
 388         if (tv != null) {
 389             String printableMimetype = DisplayUtils.convertMIMEtoPrettyPrint(mimetype);;
 390             tv.setText(printableMimetype);
 391         }
 392         ImageView iv = (ImageView) getView().findViewById(R.id.fdIcon);
 393         if (iv != null) {
 394             iv.setImageResource(DisplayUtils.getResourceId(mimetype, filename));
 395         }
 396     }
 397
 398     /**
 399      * Updates the file size in view
 400      * @param filesize in bytes to set
 401      */
 402     private void setFilesize(long filesize) {
 403         TextView tv = (TextView) getView().findViewById(R.id.fdSize);
 404         if (tv != null)
 405             tv.setText(DisplayUtils.bytesToHumanReadable(filesize));
 406     }
 407
 408     /**
 409      * Updates the time that the file was created in view
 410      * @param milliseconds Unix time to set
 411      */
 412     private void setTimeCreated(long milliseconds){
 413         TextView tv = (TextView) getView().findViewById(R.id.fdCreated);
 414         TextView tvLabel = (TextView) getView().findViewById(R.id.fdCreatedLabel);
 415         if(tv != null){
 416             tv.setText(DisplayUtils.unixTimeToHumanReadable(milliseconds));
 417             tv.setVisibility(View.VISIBLE);
 418             tvLabel.setVisibility(View.VISIBLE);
 419         }
 420     }
 421
 422     /**
 423      * Updates the time that the file was last modified
 424      * @param milliseconds Unix time to set
 425      */
 426     private void setTimeModified(long milliseconds){
 427         TextView tv = (TextView) getView().findViewById(R.id.fdModified);
 428         if(tv != null){
 429             tv.setText(DisplayUtils.unixTimeToHumanReadable(milliseconds));
 430         }
 431     }
 432
 433     /**
 434      * Enables or disables buttons for a file being downloaded
 435      */
 436     private void setButtonsForTransferring() {
 437         if (!isEmpty()) {
 438             // let's protect the user from himself ;)
 439             getView().findViewById(R.id.fdKeepInSync).setEnabled(false);
 440
 441             // show the progress bar for the transfer
 442             getView().findViewById(R.id.fdProgressBlock).setVisibility(View.VISIBLE);
 443             TextView progressText = (TextView)getView().findViewById(R.id.fdProgressText);
 444             progressText.setVisibility(View.VISIBLE);
 445             FileDownloaderBinder downloaderBinder = mContainerActivity.getFileDownloaderBinder();
 446             FileUploaderBinder uploaderBinder = mContainerActivity.getFileUploaderBinder();
 447             if (downloaderBinder != null && downloaderBinder.isDownloading(mAccount, getFile())) {
 448                 progressText.setText(R.string.downloader_download_in_progress_ticker);
 449             } else if (uploaderBinder != null && uploaderBinder.isUploading(mAccount, getFile())) {
 450                 progressText.setText(R.string.uploader_upload_in_progress_ticker);
 451             }
 452         }
 453     }
 454
 455     /**
 456      * Enables or disables buttons for a file locally available
 457      */
 458     private void setButtonsForDown() {
 459         if (!isEmpty()) {
 460             getView().findViewById(R.id.fdKeepInSync).setEnabled(true);
 461
 462             // hides the progress bar
 463             getView().findViewById(R.id.fdProgressBlock).setVisibility(View.GONE);
 464             TextView progressText = (TextView)getView().findViewById(R.id.fdProgressText);
 465             progressText.setVisibility(View.GONE);
 466         }
 467     }
 468
 469     /**
 470      * Enables or disables buttons for a file not locally available
 471      */
 472     private void setButtonsForRemote() {
 473         if (!isEmpty()) {
 474             getView().findViewById(R.id.fdKeepInSync).setEnabled(true);
 475
 476             // hides the progress bar
 477             getView().findViewById(R.id.fdProgressBlock).setVisibility(View.GONE);
 478             TextView progressText = (TextView)getView().findViewById(R.id.fdProgressText);
 479             progressText.setVisibility(View.GONE);
 480         }
 481     }
 482
 483
 484     /**
 485      * In ownCloud 3.X.X and 4.X.X there is a bug that SabreDAV does not return
 486      * the time that the file was created. There is a chance that this will
 487      * be fixed in future versions. Use this method to check if this version of
 488      * ownCloud has this fix.
 489      * @return True, if ownCloud the ownCloud version is supporting creation time
 490      */
 491     private boolean ocVersionSupportsTimeCreated(){
 492         /*if(mAccount != null){
 493             AccountManager accManager = (AccountManager) getActivity().getSystemService(Context.ACCOUNT_SERVICE);
 494             OwnCloudVersion ocVersion = new OwnCloudVersion(accManager
 495                     .getUserData(mAccount, AccountAuthenticator.KEY_OC_VERSION));
 496             if(ocVersion.compareTo(new OwnCloudVersion(0x030000)) < 0) {
 497                 return true;
 498             }
 499         }*/
 500         return false;
 501     }
 502
 503
 504     public void listenForTransferProgress() {
 505         if (mProgressListener != null) {
 506             if (mContainerActivity.getFileDownloaderBinder() != null) {
 507                 mContainerActivity.getFileDownloaderBinder().addDatatransferProgressListener(mProgressListener, mAccount, getFile());
 508             }
 509             if (mContainerActivity.getFileUploaderBinder() != null) {
 510                 mContainerActivity.getFileUploaderBinder().addDatatransferProgressListener(mProgressListener, mAccount, getFile());
 511             }
 512         }
 513     }
 514
 515
 516     public void leaveTransferProgress() {
 517         if (mProgressListener != null) {
 518             if (mContainerActivity.getFileDownloaderBinder() != null) {
 519                 mContainerActivity.getFileDownloaderBinder().removeDatatransferProgressListener(mProgressListener, mAccount, getFile());
 520             }
 521             if (mContainerActivity.getFileUploaderBinder() != null) {
 522                 mContainerActivity.getFileUploaderBinder().removeDatatransferProgressListener(mProgressListener, mAccount, getFile());
 523             }
 524         }
 525     }
 526
 527
 528
 529     /**
 530      * Helper class responsible for updating the progress bar shown for file uploading or downloading
 531      *
 532      * @author David A. Velasco
 533      */
 534     private class ProgressListener implements OnDatatransferProgressListener {
 535         int mLastPercent = 0;
 536         WeakReference<ProgressBar> mProgressBar = null;
 537
 538         ProgressListener(ProgressBar progressBar) {
 539             mProgressBar = new WeakReference<ProgressBar>(progressBar);
 540         }
 541
 542         @Override
 543         public void onTransferProgress(long progressRate, long totalTransferredSoFar, long totalToTransfer, String filename) {
 544             int percent = (int)(100.0*((double)totalTransferredSoFar)/((double)totalToTransfer));
 545             if (percent != mLastPercent) {
 546                 ProgressBar pb = mProgressBar.get();
 547                 if (pb != null) {
 548                     pb.setProgress(percent);
 549                     pb.postInvalidate();
 550                 }
 551             }
 552             mLastPercent = percent;
 553         }
 554
 555     };
 556
 557 }