src/com/owncloud/android/files/FileMenuFilter.java

   1 /* ownCloud Android client application
   2  *   Copyright (C) 2014 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
  18 package com.owncloud.android.files;
  19
  20 import java.util.ArrayList;
  21 import java.util.List;
  22
  23 import android.accounts.Account;
  24 import android.content.Context;
  25 import android.view.Menu;
  26 import android.view.MenuItem;
  27
  28 import com.owncloud.android.R;
  29 import com.owncloud.android.datamodel.OCFile;
  30 import com.owncloud.android.files.services.FileDownloader;
  31 import com.owncloud.android.files.services.FileDownloader.FileDownloaderBinder;
  32 import com.owncloud.android.files.services.FileUploader;
  33 import com.owncloud.android.files.services.FileUploader.FileUploaderBinder;
  34 import com.owncloud.android.ui.activity.ComponentsGetter;
  35
  36 /**
  37  * Filters out the file actions available in a given {@link Menu} for a given {@link OCFile}
  38  * according to the current state of the latest.
  39  *
  40  * @author David A. Velasco
  41  */
  42 public class FileMenuFilter {
  43
  44     private OCFile mFile;
  45     private ComponentsGetter mComponentsGetter;
  46     private Account mAccount;
  47     private Context mContext;
  48
  49     /**
  50      * Constructor
  51      *
  52      * @param targetFile        {@link OCFile} target of the action to filter in the {@link Menu}.
  53      * @param account           ownCloud {@link Account} holding targetFile.
  54      * @param cg                Accessor to app components, needed to get access the
  55      *                          {@link FileUploader} and {@link FileDownloader} services.
  56      * @param context           Android {@link Context}, needed to access build setup resources.
  57      */
  58     public FileMenuFilter(OCFile targetFile, Account account, ComponentsGetter cg, Context context) {
  59         mFile = targetFile;
  60         mAccount = account;
  61         mComponentsGetter = cg;
  62         mContext = context;
  63     }
  64
  65
  66     /**
  67      * Filters out the file actions available in the passed {@link Menu} taken into account
  68      * the state of the {@link OCFile} held by the filter.
  69      *
  70      * @param menu              Options or context menu to filter.
  71      */
  72     public void filter(Menu menu) {
  73         List<Integer> toShow = new ArrayList<Integer>();
  74         List<Integer> toHide = new ArrayList<Integer>();
  75
  76         filter(toShow, toHide);
  77
  78         MenuItem item = null;
  79         for (int i : toShow) {
  80             item = menu.findItem(i);
  81             if (item != null) {
  82                 item.setVisible(true);
  83                 item.setEnabled(true);
  84             }
  85         }
  86
  87         for (int i : toHide) {
  88             item = menu.findItem(i);
  89             if (item != null) {
  90                 item.setVisible(false);
  91                 item.setEnabled(false);
  92             }
  93         }
  94     }
  95
  96     /**
  97      * Filters out the file actions available in the passed {@link Menu} taken into account
  98      * the state of the {@link OCFile} held by the filter.
  99      *
 100      * Second method needed thanks to ActionBarSherlock.
 101      *
 102      * TODO Get rid of it when ActionBarSherlock is replaced for newer Android Support Library.
 103      *
 104      * @param menu              Options or context menu to filter.
 105      */
 106     public void filter(com.actionbarsherlock.view.Menu menu) {
 107
 108         List<Integer> toShow = new ArrayList<Integer>();
 109         List<Integer> toHide = new ArrayList<Integer>();
 110
 111         filter(toShow, toHide);
 112
 113         com.actionbarsherlock.view.MenuItem item = null;
 114         for (int i : toShow) {
 115             item = menu.findItem(i);
 116             if (item != null) {
 117                 item.setVisible(true);
 118                 item.setEnabled(true);
 119             }
 120         }
 121         for (int i : toHide) {
 122             item = menu.findItem(i);
 123             if (item != null) {
 124                 item.setVisible(false);
 125                 item.setEnabled(false);
 126             }
 127         }
 128     }
 129
 130     /**
 131      * Performs the real filtering, to be applied in the {@link Menu} by the caller methods.
 132      *
 133      * Decides what actions must be shown and hidden.
 134      *
 135      * @param toShow            List to save the options that must be shown in the menu.
 136      * @param toHide            List to save the options that must be shown in the menu.
 137      */
 138     private void filter(List<Integer> toShow, List <Integer> toHide) {
 139         boolean downloading = false;
 140         boolean uploading = false;
 141         if (mComponentsGetter != null && mFile != null && mAccount != null) {
 142             FileDownloaderBinder downloaderBinder = mComponentsGetter.getFileDownloaderBinder();
 143             downloading = downloaderBinder != null && downloaderBinder.isDownloading(mAccount, mFile);
 144             FileUploaderBinder uploaderBinder = mComponentsGetter.getFileUploaderBinder();
 145             uploading = uploaderBinder != null && uploaderBinder.isUploading(mAccount, mFile);
 146         }
 147
 148         /// decision is taken for each possible action on a file in the menu
 149
 150         // DOWNLOAD
 151         if (mFile == null || mFile.isFolder() || mFile.isDown() || downloading || uploading) {
 152             toHide.add(R.id.action_download_file);
 153
 154         } else {
 155             toShow.add(R.id.action_download_file);
 156         }
 157
 158         // RENAME
 159         if (mFile == null || downloading || uploading) {
 160             toHide.add(R.id.action_rename_file);
 161
 162         } else {
 163             toShow.add(R.id.action_rename_file);
 164         }
 165
 166         // REMOVE
 167         if (mFile == null || downloading || uploading) {
 168             toHide.add(R.id.action_remove_file);
 169
 170         } else {
 171             toShow.add(R.id.action_remove_file);
 172         }
 173
 174         // OPEN WITH (different to preview!)
 175         if (mFile == null || mFile.isFolder() || !mFile.isDown() || downloading || uploading) {
 176             toHide.add(R.id.action_open_file_with);
 177
 178         } else {
 179             toShow.add(R.id.action_open_file_with);
 180         }
 181
 182
 183         // CANCEL DOWNLOAD
 184         if (mFile == null || !downloading || mFile.isFolder()) {
 185             toHide.add(R.id.action_cancel_download);
 186         } else {
 187             toShow.add(R.id.action_cancel_download);
 188         }
 189
 190         // CANCEL UPLOAD
 191         if (mFile == null || !uploading || mFile.isFolder()) {
 192             toHide.add(R.id.action_cancel_upload);
 193         } else {
 194             toShow.add(R.id.action_cancel_upload);
 195         }
 196
 197         // SYNC FILE CONTENTS
 198         if (mFile == null || mFile.isFolder() || !mFile.isDown() || downloading || uploading) {
 199             toHide.add(R.id.action_sync_file);
 200         } else {
 201             toShow.add(R.id.action_sync_file);
 202         }
 203
 204         // SHARE FILE
 205         // TODO add check on SHARE available on server side?
 206         if (mFile == null) {
 207             toHide.add(R.id.action_share_file);
 208         } else {
 209             toShow.add(R.id.action_share_file);
 210         }
 211
 212         // UNSHARE FILE
 213         // TODO add check on SHARE available on server side?
 214         if (mFile == null || !mFile.isShareByLink()) {
 215             toHide.add(R.id.action_unshare_file);
 216         } else {
 217             toShow.add(R.id.action_unshare_file);
 218         }
 219
 220
 221         // SEE DETAILS
 222         if (mFile == null || mFile.isFolder()) {
 223             toHide.add(R.id.action_see_details);
 224         } else {
 225             toShow.add(R.id.action_see_details);
 226         }
 227
 228         // SEND
 229         boolean sendAllowed = (mContext != null &&
 230                 mContext.getString(R.string.send_files_to_other_apps).equalsIgnoreCase("on"));
 231         if (mFile == null || !sendAllowed || mFile.isFolder() || uploading || downloading) {
 232             toHide.add(R.id.action_send_file);
 233         } else {
 234             toShow.add(R.id.action_send_file);
 235         }
 236
 237     }
 238
 239 }