cthrace/open-keychain
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #2164 from open-keychain/simplify-cache-ttl

Browse Source 
Simplify cache TTL logic
This commit is contained in:
Dominik Schürmann
2017-09-20 09:30:29 -10:00
committed by GitHub
parent ca1bcf93f2 647589c9ae
commit afed37ed7d
11 changed files with 47 additions and 406 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/Constants.java
View File

@@ -114,9 +114,8 @@ public final class Constants {
}
public static final class Pref {
public static final String PASSPHRASE_CACHE_TTLS = "passphraseCacheTtls";
public static final String PASSPHRASE_CACHE_DEFAULT = "passphraseCacheDefault";
public static final String PASSPHRASE_CACHE_SUBS = "passphraseCacheSubs";
public static final String PASSPHRASE_CACHE_LAST_TTL = "passphraseCacheLastTtl";
public static final String LANGUAGE = "language";
public static final String KEY_SERVERS = "keyServers";
public static final String PREF_VERSION = "keyServersDefaultVersion";

4
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/ui/PassphraseDialogActivity.java
View File

@@ -210,6 +210,8 @@ public class PassphraseDialogActivity extends FragmentActivity {
vTimeToLiveLayout.setVisibility(mRequiredInput.mSkipCaching ? View.GONE : View.VISIBLE);
mTimeToLiveSpinner = (CacheTTLSpinner) mLayout.findViewById(R.id.ttl_spinner);
int ttlSeconds = Preferences.getPreferences(getContext()).getCacheTtlSeconds();
mTimeToLiveSpinner.setSelectedTimeToLive(ttlSeconds);
alert.setNegativeButton(android.R.string.cancel, new DialogInterface.OnClickListener() {
@@ -426,6 +428,8 @@ public class PassphraseDialogActivity extends FragmentActivity {
final Passphrase passphrase = new Passphrase(mPassphraseEditText);
final int timeToLiveSeconds = mTimeToLiveSpinner.getSelectedTimeToLive();
Preferences.getPreferences(getContext()).setCacheTtlSeconds(timeToLiveSeconds);
// Early breakout if we are dealing with a symmetric key
if (mRequiredInput.mType == RequiredInputType.PASSPHRASE_SYMMETRIC) {
if (!mRequiredInput.mSkipCaching) {

11
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/ui/SettingsActivity.java
View File

@@ -204,17 +204,6 @@ public class SettingsActivity extends AppCompatPreferenceActivity {
// Load the preferences from an XML resource
addPreferencesFromResource(R.xml.passphrase_preferences);
findPreference(Constants.Pref.PASSPHRASE_CACHE_TTLS)
.setOnPreferenceClickListener(new Preference.OnPreferenceClickListener() {
public boolean onPreferenceClick(Preference preference) {
Intent intent = new Intent(getActivity(), SettingsCacheTTLActivity.class);
intent.putExtra(SettingsCacheTTLActivity.EXTRA_TTL_PREF,
sPreferences.getPassphraseCacheTtl());
startActivity(intent);
return false;
}
});
}
}

82
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/ui/SettingsCacheTTLActivity.java
View File

@@ -1,82 +0,0 @@
/*
* Copyright (C) 2015 Vincent Breitmoser <v.breitmoser@my.amazin.horse>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.sufficientlysecure.keychain.ui;
import java.util.ArrayList;
import android.content.Intent;
import android.os.Bundle;
import android.view.MenuItem;
import android.view.View;
import android.view.View.OnClickListener;
import org.sufficientlysecure.keychain.R;
import org.sufficientlysecure.keychain.ui.base.BaseActivity;
import org.sufficientlysecure.keychain.util.Preferences.CacheTTLPrefs;
public class SettingsCacheTTLActivity extends BaseActivity {
public static final String EXTRA_TTL_PREF = "ttl_pref";
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
Intent intent = getIntent();
CacheTTLPrefs ttlPrefs = (CacheTTLPrefs) intent.getSerializableExtra(EXTRA_TTL_PREF);
loadFragment(savedInstanceState, ttlPrefs);
getSupportActionBar().setDisplayHomeAsUpEnabled(true);
}
@Override
public boolean onOptionsItemSelected(MenuItem item) {
switch (item.getItemId()) {
case android.R.id.home:
finish();
return true;
}
return super.onOptionsItemSelected(item);
}
@Override
protected void initLayout() {
setContentView(R.layout.settings_cache_ttl);
}
private void loadFragment(Bundle savedInstanceState, CacheTTLPrefs ttlPrefs) {
// However, if we're being restored from a previous state,
// then we don't need to do anything and should return or else
// we could end up with overlapping fragments.
if (savedInstanceState != null) {
return;
}
SettingsCacheTTLFragment fragment = SettingsCacheTTLFragment.newInstance(ttlPrefs);
// Add the fragment to the 'fragment_container' FrameLayout
// NOTE: We use commitAllowingStateLoss() to prevent weird crashes!
getSupportFragmentManager().beginTransaction()
.replace(R.id.settings_cache_ttl_fragment, fragment)
.commitAllowingStateLoss();
// do it immediately!
getSupportFragmentManager().executePendingTransactions();
}
}

199
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/ui/SettingsCacheTTLFragment.java
View File

@@ -1,199 +0,0 @@
/*
* Copyright (C) 2015 Vincent Breitmoser <v.breitmoser@my.amazin.horse>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.sufficientlysecure.keychain.ui;
import java.util.ArrayList;
import android.os.Bundle;
import android.support.v4.app.Fragment;
import android.support.v4.app.FragmentActivity;
import android.support.v7.widget.LinearLayoutManager;
import android.support.v7.widget.RecyclerView;
import android.view.LayoutInflater;
import android.view.View;
import android.view.View.OnClickListener;
import android.view.ViewGroup;
import android.widget.CheckBox;
import android.widget.TextView;
import org.sufficientlysecure.keychain.R;
import org.sufficientlysecure.keychain.ui.util.Notify;
import org.sufficientlysecure.keychain.ui.util.Notify.Style;
import org.sufficientlysecure.keychain.ui.util.recyclerview.DividerItemDecoration;
import org.sufficientlysecure.keychain.util.Preferences;
import org.sufficientlysecure.keychain.util.Preferences.CacheTTLPrefs;
public class SettingsCacheTTLFragment extends Fragment {
public static final String ARG_TTL_PREFS = "ttl_prefs";
private CacheTTLListAdapter mAdapter;
public static SettingsCacheTTLFragment newInstance(CacheTTLPrefs ttlPrefs) {
Bundle args = new Bundle();
args.putSerializable(ARG_TTL_PREFS, ttlPrefs);
SettingsCacheTTLFragment fragment = new SettingsCacheTTLFragment();
fragment.setArguments(args);
return fragment;
}
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle
savedInstanceState) {
return inflater.inflate(R.layout.settings_cache_ttl_fragment, null);
}
@Override
public void onViewCreated(View view, Bundle savedInstanceState) {
super.onViewCreated(view, savedInstanceState);
CacheTTLPrefs prefs = (CacheTTLPrefs) getArguments().getSerializable(ARG_TTL_PREFS);
mAdapter = new CacheTTLListAdapter(prefs);
RecyclerView recyclerView = (RecyclerView) view.findViewById(R.id.cache_ttl_recycler_view);
recyclerView.setHasFixedSize(true);
recyclerView.setLayoutManager(new LinearLayoutManager(getActivity()));
recyclerView.setAdapter(mAdapter);
recyclerView.addItemDecoration(new DividerItemDecoration(getActivity(), DividerItemDecoration.VERTICAL_LIST,
true));
}
private void savePreference() {
FragmentActivity activity = getActivity();
if (activity == null) {
return;
}
CacheTTLPrefs prefs = mAdapter.getPrefs();
Preferences.getPreferences(activity).setPassphraseCacheTtl(prefs);
}
public class CacheTTLListAdapter extends RecyclerView.Adapter<CacheTTLListAdapter.ViewHolder> {
private final ArrayList<Boolean> mPositionIsChecked;
public CacheTTLListAdapter(CacheTTLPrefs prefs) {
this.mPositionIsChecked = new ArrayList<>();
for (int ttlTime : CacheTTLPrefs.CACHE_TTLS) {
mPositionIsChecked.add(prefs.ttlTimes.contains(ttlTime));
}
}
public CacheTTLPrefs getPrefs() {
ArrayList<String> ttls = new ArrayList<>();
for (int i = 0; i < mPositionIsChecked.size(); i++) {
if (mPositionIsChecked.get(i)) {
ttls.add(Integer.toString(CacheTTLPrefs.CACHE_TTLS.get(i)));
}
}
return new CacheTTLPrefs(ttls);
}
@Override
public ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
View view = LayoutInflater.from(parent.getContext())
.inflate(R.layout.settings_cache_ttl_item, parent, false);
return new ViewHolder(view);
}
@Override
public void onBindViewHolder(final ViewHolder holder, int position) {
holder.bind(position);
}
@Override
public int getItemCount() {
return mPositionIsChecked.size();
}
public class ViewHolder extends RecyclerView.ViewHolder {
CheckBox mChecked;
TextView mTitle;
public ViewHolder(View itemView) {
super(itemView);
mChecked = (CheckBox) itemView.findViewById(R.id.ttl_selected);
mTitle = (TextView) itemView.findViewById(R.id.ttl_title);
itemView.setOnClickListener(new OnClickListener() {
@Override
public void onClick(View v) {
mChecked.performClick();
}
});
}
public void bind(final int position) {
int ttl = CacheTTLPrefs.CACHE_TTLS.get(position);
boolean isChecked = mPositionIsChecked.get(position);
mTitle.setText(CacheTTLPrefs.CACHE_TTL_NAMES.get(ttl));
// avoid some ui flicker by skipping unnecessary updates
if (mChecked.isChecked() != isChecked) {
mChecked.setChecked(isChecked);
}
mChecked.setOnClickListener(new OnClickListener() {
@Override
public void onClick(View v) {
setTtlChecked(position);
savePreference();
}
});
}
private void setTtlChecked(int position) {
boolean isChecked = mPositionIsChecked.get(position);
int checkedItems = countCheckedItems();
boolean isLastChecked = isChecked && checkedItems == 1;
boolean isOneTooMany = !isChecked && checkedItems >= 3;
if (isLastChecked) {
Notify.create(getActivity(), R.string.settings_cache_ttl_at_least_one, Style.ERROR).show();
} else if (isOneTooMany) {
Notify.create(getActivity(), R.string.settings_cache_ttl_max_three, Style.ERROR).show();
} else {
mPositionIsChecked.set(position, !isChecked);
}
notifyItemChanged(position);
}
private int countCheckedItems() {
int result = 0;
for (boolean isChecked : mPositionIsChecked) {
if (isChecked) {
result += 1;
}
}
return result;
}
}
}
}

41
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/ui/widget/CacheTTLSpinner.java
View File

@@ -26,32 +26,36 @@ import android.support.v7.widget.AppCompatSpinner;
import android.util.AttributeSet;
import org.sufficientlysecure.keychain.R;
import org.sufficientlysecure.keychain.util.Preferences;
import org.sufficientlysecure.keychain.util.Preferences.CacheTTLPrefs;
public class CacheTTLSpinner extends AppCompatSpinner {
public static final int[] TTL_TIMES = {
0,
60 * 60,
60 * 60 * 24,
Integer.MAX_VALUE
};
public static final int[] TTL_STRINGS = {
R.string.cache_ttl_lock_screen,
R.string.cache_ttl_one_hour,
R.string.cache_ttl_one_day,
R.string.cache_ttl_forever
};
public CacheTTLSpinner(Context context, AttributeSet attrs) {
super(context, attrs);
initView(context);
initView();
}
public CacheTTLSpinner(Context context, AttributeSet attrs, int defStyle) {
super(context, attrs, defStyle);
initView(context);
initView();
}
private void initView(Context context) {
CacheTTLPrefs prefs = Preferences.getPreferences(context).getPassphraseCacheTtl();
MatrixCursor cursor = new MatrixCursor(new String[] { "_id", "TTL", "description" }, 5);
int i = 0;
for (int ttl : CacheTTLPrefs.CACHE_TTLS) {
if ( ! prefs.ttlTimes.contains(ttl)) {
continue;
}
cursor.addRow(new Object[] { i++, ttl, getContext().getString(CacheTTLPrefs.CACHE_TTL_NAMES.get(ttl)) });
private void initView() {
MatrixCursor cursor = new MatrixCursor(new String[] { "_id", "TTL", "description" }, TTL_TIMES.length);
for (int i = 0; i < TTL_TIMES.length; i++) {
cursor.addRow(new Object[] { i, TTL_TIMES[i], getContext().getString(TTL_STRINGS[i]) });
}
setAdapter(new SimpleCursorAdapter(getContext(), R.layout.simple_item, cursor,
@@ -64,4 +68,13 @@ public class CacheTTLSpinner extends AppCompatSpinner {
return ((Cursor) item).getInt(1);
}
public void setSelectedTimeToLive(int ttlSeconds) {
for (int i = 0; i < TTL_TIMES.length; i++) {
boolean isSelectedOrLast = ttlSeconds <= TTL_TIMES[i] || (i == TTL_TIMES.length - 1);
if (isSelectedOrLast) {
setSelection(i);
break;
}
}
}
}

87
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/util/Preferences.java
View File

@@ -19,6 +19,10 @@
package org.sufficientlysecure.keychain.util;
import java.net.Proxy;
import java.util.ArrayList;
import java.util.ListIterator;
import android.accounts.Account;
import android.annotation.SuppressLint;
import android.content.ContentResolver;
@@ -31,21 +35,9 @@ import android.preference.PreferenceManager;
import org.sufficientlysecure.keychain.Constants;
import org.sufficientlysecure.keychain.Constants.Pref;
import org.sufficientlysecure.keychain.KeychainApplication;
import org.sufficientlysecure.keychain.R;
import org.sufficientlysecure.keychain.keyimport.HkpKeyserverAddress;
import org.sufficientlysecure.keychain.service.KeyserverSyncAdapterService;
import java.io.Serializable;
import java.net.Proxy;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.ListIterator;
import java.util.Map;
import java.util.Set;
/**
* Singleton Implementation of a Preference Helper
*/
@@ -104,6 +96,16 @@ public class Preferences {
return mSharedPreferences.getBoolean(Pref.PASSPHRASE_CACHE_SUBS, false);
}
public int getCacheTtlSeconds() {
return mSharedPreferences.getInt(Pref.PASSPHRASE_CACHE_LAST_TTL, Integer.MAX_VALUE);
}
public void setCacheTtlSeconds(int ttlSeconds) {
SharedPreferences.Editor editor = mSharedPreferences.edit();
editor.putInt(Pref.PASSPHRASE_CACHE_LAST_TTL, ttlSeconds);
editor.commit();
}
public boolean getCachedConsolidate() {
return mSharedPreferences.getBoolean(Pref.CACHED_CONSOLIDATE, false);
}
@@ -307,67 +309,6 @@ public class Preferences {
!ContentResolver.getPeriodicSyncs(account, authority).isEmpty();
}
public CacheTTLPrefs getPassphraseCacheTtl() {
Set<String> pref = mSharedPreferences.getStringSet(Constants.Pref.PASSPHRASE_CACHE_TTLS, null);
if (pref == null) {
return CacheTTLPrefs.getDefault();
}
return new CacheTTLPrefs(pref);
}
public void setPassphraseCacheTtl(CacheTTLPrefs prefs) {
SharedPreferences.Editor editor = mSharedPreferences.edit();
editor.putStringSet(Constants.Pref.PASSPHRASE_CACHE_TTLS, prefs.getStringSet());
editor.commit();
}
public static class CacheTTLPrefs implements Serializable {
public static final Map<Integer, Integer> CACHE_TTL_NAMES;
public static final ArrayList<Integer> CACHE_TTLS;
static {
HashMap<Integer, Integer> cacheTtlNames = new HashMap<>();
cacheTtlNames.put(0, R.string.cache_ttl_lock_screen);
cacheTtlNames.put(60 * 10, R.string.cache_ttl_ten_minutes);
cacheTtlNames.put(60 * 30, R.string.cache_ttl_thirty_minutes);
cacheTtlNames.put(60 * 60, R.string.cache_ttl_one_hour);
cacheTtlNames.put(60 * 60 * 3, R.string.cache_ttl_three_hours);
cacheTtlNames.put(60 * 60 * 24, R.string.cache_ttl_one_day);
cacheTtlNames.put(60 * 60 * 24 * 3, R.string.cache_ttl_three_days);
cacheTtlNames.put(Integer.MAX_VALUE, R.string.cache_ttl_forever);
CACHE_TTL_NAMES = Collections.unmodifiableMap(cacheTtlNames);
CACHE_TTLS = new ArrayList<>(CacheTTLPrefs.CACHE_TTL_NAMES.keySet());
Collections.sort(CACHE_TTLS);
}
public HashSet<Integer> ttlTimes;
public CacheTTLPrefs(Collection<String> ttlStrings) {
ttlTimes = new HashSet<>();
for (String ttlString : ttlStrings) {
ttlTimes.add(Integer.parseInt(ttlString));
}
}
public HashSet<String> getStringSet() {
HashSet<String> ttlTimeStrings = new HashSet<>();
for (Integer ttlTime : ttlTimes) {
ttlTimeStrings.add(Integer.toString(ttlTime));
}
return ttlTimeStrings;
}
public static CacheTTLPrefs getDefault() {
ArrayList<String> ttlStrings = new ArrayList<>();
ttlStrings.add(Integer.toString(0));
ttlStrings.add(Integer.toString(60 * 60));
ttlStrings.add(Integer.toString(60 * 60 * 24));
return new CacheTTLPrefs(ttlStrings);
}
}
// cloud prefs
public CloudSearchPrefs getCloudSearchPrefs() {