summaryrefslogtreecommitdiff
path: root/java/com/android/contacts/common/list/ContactListFilterController.java
blob: d2168f3f25488432e63f4206e6b5f294f0a3d5fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*
 * 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.android.contacts.common.list;

import android.content.Context;
import android.content.SharedPreferences;
import android.preference.PreferenceManager;
import com.android.contacts.common.model.AccountTypeManager;
import com.android.contacts.common.model.account.AccountWithDataSet;
import java.util.ArrayList;
import java.util.List;

/** Manages {@link ContactListFilter}. All methods must be called from UI thread. */
public abstract class ContactListFilterController {

  // singleton to cache the filter controller
  private static ContactListFilterControllerImpl sFilterController = null;

  public static ContactListFilterController getInstance(Context context) {
    // We may need to synchronize this in the future if background task will call this.
    if (sFilterController == null) {
      sFilterController = new ContactListFilterControllerImpl(context);
    }
    return sFilterController;
  }

  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);

  public interface ContactListFilterListener {

    void onContactListFilterChanged();
  }
}

/**
 * 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_ALL_ACCOUNTS),
              true,
              notifyListeners);
        }
    }
  }

  /** @return true if the Account for the current filter exists. */
  private boolean filterAccountExists() {
    final AccountTypeManager accountTypeManager = AccountTypeManager.getInstance(mContext);
    final AccountWithDataSet filterAccount =
        new AccountWithDataSet(mFilter.accountName, mFilter.accountType, mFilter.dataSet);
    return accountTypeManager.contains(filterAccount, false);
  }
}