/*
Copyright © 2013-2014, Silent Circle, LLC.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Any redistribution, use, or modification is done solely for personal
benefit and not for any commercial purpose or for monetary gain
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name Silent Circle nor the names of its contributors may
be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL SILENT CIRCLE, LLC BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*
* This implementation is edited version of original Android sources.
*/
/*
* Copyright (C) 2010 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.silentcircle.contacts.list;
import android.content.Context;
import android.content.SharedPreferences;
import android.preference.PreferenceManager;
import java.util.ArrayList;
import java.util.List;
/**
* Manages {@link ContactListFilter}. All methods must be called from UI thread.
*/
public abstract class ContactListFilterController {
public static final String CONTACT_LIST_FILTER_SERVICE = "contactListFilter";
private static ContactListFilterController mContactListFilterController;
public interface ContactListFilterListener {
void onContactListFilterChanged();
}
public static ContactListFilterController getInstance(Context context) {
if (mContactListFilterController == null) {
mContactListFilterController = createContactListFilterController(context);
}
return mContactListFilterController;
}
public static ContactListFilterController createContactListFilterController(Context context) {
return new ContactListFilterControllerImpl(context);
}
public abstract void addListener(ContactListFilterListener listener);
public abstract void removeListener(ContactListFilterListener listener);
/**
* Return the currently-active filter.
*/
public abstract ContactListFilter getFilter();
/**
* @param filter the filter
* @param persistent True when the given filter should be saved soon. False when the filter
* should not be saved. The latter case may happen when some Intent requires a certain type of
* UI (e.g. single contact) temporarily.
*/
public abstract void setContactListFilter(ContactListFilter filter, boolean persistent);
public abstract void selectCustomFilter();
/**
* Checks if the current filter is valid and reset the filter if not. It may happen when
* an account is removed while the filter points to the account with
* {@link ContactListFilter#FILTER_TYPE_ACCOUNT} type, for example. It may also happen if
* the current filter is {@link ContactListFilter#FILTER_TYPE_SINGLE_CONTACT}, in
* which case, we should switch to the last saved filter in {@link SharedPreferences}.
*/
public abstract void checkFilterValidity(boolean notifyListeners);
}
/**
* Stores the {@link ContactListFilter} selected by the user and saves it to
* {@link SharedPreferences} if necessary.
*/
class ContactListFilterControllerImpl extends ContactListFilterController {
private final Context mContext;
private final List<ContactListFilterListener> mListeners =
new ArrayList<ContactListFilterListener>();
private ContactListFilter mFilter;
public ContactListFilterControllerImpl(Context context) {
mContext = context;
mFilter = ContactListFilter.restoreDefaultPreferences(getSharedPreferences());
checkFilterValidity(true /* notify listeners */);
}
@Override
public void addListener(ContactListFilterListener listener) {
mListeners.add(listener);
}
@Override
public void removeListener(ContactListFilterListener listener) {
mListeners.remove(listener);
}
@Override
public ContactListFilter getFilter() {
return mFilter;
}
private SharedPreferences getSharedPreferences() {
return PreferenceManager.getDefaultSharedPreferences(mContext);
}
@Override
public void setContactListFilter(ContactListFilter filter, boolean persistent) {
setContactListFilter(filter, persistent, true);
}
private void setContactListFilter(ContactListFilter filter, boolean persistent, boolean notifyListeners) {
if (!filter.equals(mFilter)) {
mFilter = filter;
if (persistent) {
ContactListFilter.storeToPreferences(getSharedPreferences(), mFilter);
}
if (notifyListeners && !mListeners.isEmpty()) {
notifyContactListFilterChanged();
}
}
}
@Override
public void selectCustomFilter() {
setContactListFilter(ContactListFilter.createFilterWithType(ContactListFilter.FILTER_TYPE_CUSTOM), true);
}
private void notifyContactListFilterChanged() {
for (ContactListFilterListener listener : mListeners) {
listener.onContactListFilterChanged();
}
}
@Override
public void checkFilterValidity(boolean notifyListeners) {
if (mFilter == null) {
return;
}
switch (mFilter.filterType) {
case ContactListFilter.FILTER_TYPE_SINGLE_CONTACT:
setContactListFilter(ContactListFilter.restoreDefaultPreferences(getSharedPreferences()), false, notifyListeners);
break;
case ContactListFilter.FILTER_TYPE_ACCOUNT:
if (!filterAccountExists()) {
// The current account filter points to invalid account. Use "all" filter
// instead.
setContactListFilter(ContactListFilter.createFilterWithType(ContactListFilter.FILTER_TYPE_DEFAULT), true,
notifyListeners);
}
}
}
/**
* @return true if the Account for the current filter exists.
*/
private boolean filterAccountExists() {
return false;
}
}