SearchSettings.java revision 288002f8258274e67876bd86b02e13acaf255815 
1/*
2 * Copyright (C) 2009 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.android.quicksearchbox;
18
19import android.app.AlertDialog;
20import android.app.Dialog;
21import android.app.SearchManager;
22import android.content.Context;
23import android.content.DialogInterface;
24import android.content.Intent;
25import android.content.SharedPreferences;
26import android.content.pm.PackageManager;
27import android.content.pm.ResolveInfo;
28import android.database.ContentObserver;
29import android.os.Bundle;
30import android.preference.CheckBoxPreference;
31import android.preference.Preference;
32import android.preference.PreferenceActivity;
33import android.preference.PreferenceScreen;
34import android.preference.Preference.OnPreferenceClickListener;
35import android.provider.Settings;
36import android.provider.Settings.System;
37import android.util.Log;
38import android.view.Menu;
39
40import java.util.List;
41
42/**
43 * Activity for setting global search preferences.
44 */
45public class SearchSettings extends PreferenceActivity
46        implements OnPreferenceClickListener {
47
48    private static final boolean DBG = false;
49    private static final String TAG = "SearchSettings";
50
51    // Name of the preferences file used to store search preference
52    public static final String PREFERENCES_NAME = "SearchSettings";
53
54    // Intent action that opens the "Searchable Items" preference
55    public static final String ACTION_SEARCHABLE_ITEMS =
56            "com.android.quicksearchbox.action.SEARCHABLE_ITEMS";
57
58    // Only used to find the preferences after inflating
59    private static final String CLEAR_SHORTCUTS_PREF = "clear_shortcuts";
60    private static final String SEARCH_ENGINE_SETTINGS_PREF = "search_engine_settings";
61    private static final String SEARCH_CORPORA_PREF = "search_corpora";
62
63    // Prefix of per-corpus enable preference
64    private static final String CORPUS_ENABLED_PREF_PREFIX = "enable_corpus_";
65    private static final String VOICE_SEARCH_HINTS_ENABLED_PREF = "voice_search_hints_enabled";
66
67    // References to the top-level preference objects
68    private Preference mClearShortcutsPreference;
69    private PreferenceScreen mSearchEngineSettingsPreference;
70    private CheckBoxPreference mVoiceSearchHintsPreference;
71
72    // Dialog ids
73    private static final int CLEAR_SHORTCUTS_CONFIRM_DIALOG = 0;
74
75    @Override
76    protected void onCreate(Bundle savedInstanceState) {
77        super.onCreate(savedInstanceState);
78
79        getPreferenceManager().setSharedPreferencesName(PREFERENCES_NAME);
80
81        addPreferencesFromResource(R.xml.preferences);
82
83        PreferenceScreen preferenceScreen = getPreferenceScreen();
84        mClearShortcutsPreference = preferenceScreen.findPreference(CLEAR_SHORTCUTS_PREF);
85        mSearchEngineSettingsPreference = (PreferenceScreen) preferenceScreen.findPreference(
86                SEARCH_ENGINE_SETTINGS_PREF);
87        mVoiceSearchHintsPreference = (CheckBoxPreference)
88                preferenceScreen.findPreference(VOICE_SEARCH_HINTS_ENABLED_PREF);
89        Preference corporaPreference = preferenceScreen.findPreference(SEARCH_CORPORA_PREF);
90        corporaPreference.setIntent(getSearchableItemsIntent(this));
91
92        mClearShortcutsPreference.setOnPreferenceClickListener(this);
93        mVoiceSearchHintsPreference.setOnPreferenceClickListener(this);
94
95        updateClearShortcutsPreference();
96        populateSearchEnginePreference();
97    }
98
99    public static Intent getSearchableItemsIntent(Context context) {
100        Intent intent = new Intent(SearchSettings.ACTION_SEARCHABLE_ITEMS);
101        intent.setPackage(context.getPackageName());
102        return intent;
103    }
104
105    /**
106     * Gets the preference key of the preference for whether the given corpus
107     * is enabled. The preference is stored in the {@link #PREFERENCES_NAME}
108     * preferences file.
109     */
110    public static String getCorpusEnabledPreference(Corpus corpus) {
111        return CORPUS_ENABLED_PREF_PREFIX + corpus.getName();
112    }
113
114    public static boolean areVoiceSearchHintsEnabled(Context context) {
115        return getSearchPreferences(context).getBoolean(VOICE_SEARCH_HINTS_ENABLED_PREF, true);
116    }
117
118    public static void setVoiceSearchHintsEnabled(Context context, boolean enabled) {
119        getSearchPreferences(context)
120                .edit().putBoolean(VOICE_SEARCH_HINTS_ENABLED_PREF, enabled).commit();
121        SearchWidgetProvider.updateSearchWidgets(context);
122    }
123
124    public static SharedPreferences getSearchPreferences(Context context) {
125        return context.getSharedPreferences(PREFERENCES_NAME, Context.MODE_PRIVATE);
126    }
127
128    private QsbApplication getQsbApplication() {
129        return (QsbApplication) getApplication();
130    }
131
132    private ShortcutRepository getShortcuts() {
133        return getQsbApplication().getShortcutRepository();
134    }
135
136    /**
137     * Enables/disables the "Clear search shortcuts" preference depending
138     * on whether there is any search history.
139     */
140    private void updateClearShortcutsPreference() {
141        boolean hasHistory = getShortcuts().hasHistory();
142        if (DBG) Log.d(TAG, "hasHistory()=" + hasHistory);
143        mClearShortcutsPreference.setEnabled(hasHistory);
144    }
145
146    /**
147     * Populates the preference item for the web search engine, which links to further
148     * search settings.
149     */
150    private void populateSearchEnginePreference() {
151        Intent intent = new Intent(SearchManager.INTENT_ACTION_WEB_SEARCH_SETTINGS);
152        intent.setPackage(getPackageName());
153
154        CharSequence webSearchSettingsLabel = getActivityLabel(intent);
155        mSearchEngineSettingsPreference.setTitle(webSearchSettingsLabel);
156        mSearchEngineSettingsPreference.setIntent(intent);
157    }
158
159    private CharSequence getActivityLabel(Intent intent) {
160        PackageManager pm = getPackageManager();
161        List<ResolveInfo> resolveInfos = pm.queryIntentActivities(intent, 0);
162        if (resolveInfos.size() == 0) {
163            Log.e(TAG, "No web search settings activity");
164            return null;
165        }
166        if (resolveInfos.size() > 1) {
167            Log.e(TAG, "More than one web search settings activity");
168            return null;
169        }
170        return resolveInfos.get(0).activityInfo.loadLabel(pm);
171    }
172
173    public synchronized boolean onPreferenceClick(Preference preference) {
174        if (preference == mClearShortcutsPreference) {
175            showDialog(CLEAR_SHORTCUTS_CONFIRM_DIALOG);
176            return true;
177        } else if (preference == mVoiceSearchHintsPreference) {
178            SearchWidgetProvider.updateSearchWidgets(this);
179            return true;
180        }
181        return false;
182    }
183
184    @Override
185    protected Dialog onCreateDialog(int id, Bundle args) {
186        switch (id) {
187            case CLEAR_SHORTCUTS_CONFIRM_DIALOG:
188                return new AlertDialog.Builder(this)
189                        .setTitle(R.string.clear_shortcuts)
190                        .setMessage(R.string.clear_shortcuts_prompt)
191                        .setPositiveButton(R.string.agree, new DialogInterface.OnClickListener() {
192                            public void onClick(DialogInterface dialog, int whichButton) {
193                                if (DBG) Log.d(TAG, "Clearing history...");
194                                getShortcuts().clearHistory();
195                                mClearShortcutsPreference.setEnabled(false);
196                            }
197                        })
198                        .setNegativeButton(R.string.disagree, null).create();
199            default:
200                Log.e(TAG, "unknown dialog" + id);
201                return null;
202        }
203    }
204
205    /**
206     * Informs our listeners about the updated settings data.
207     */
208    public static void broadcastSettingsChanged(Context context) {
209        // We use a message broadcast since the listeners could be in multiple processes.
210        Intent intent = new Intent(SearchManager.INTENT_ACTION_SEARCH_SETTINGS_CHANGED);
211        Log.i(TAG, "Broadcasting: " + intent);
212        context.sendBroadcast(intent);
213    }
214
215    public static boolean getShowWebSuggestions(Context context) {
216        return (Settings.System.getInt(context.getContentResolver(),
217                Settings.System.SHOW_WEB_SUGGESTIONS,
218                1 /* default on until user actually changes it */) == 1);
219    }
220
221    public static void setShowWebSuggestions(Context context, boolean showWebSuggestions) {
222        System.putInt(context.getContentResolver(), System.SHOW_WEB_SUGGESTIONS,
223            showWebSuggestions ? 1 : 0);
224    }
225
226    public static void registerShowWebSuggestionsSettingObserver(
227            Context context, ContentObserver observer) {
228        context.getContentResolver().registerContentObserver(
229                Settings.System.getUriFor(Settings.System.SHOW_WEB_SUGGESTIONS),
230                false, observer);
231    }
232
233    public static void unregisterShowWebSuggestionsSettingObserver(
234            Context context, ContentObserver observer) {
235        context.getContentResolver().unregisterContentObserver(observer);
236    }
237
238    public static void addSearchSettingsMenuItem(Context context, Menu menu) {
239        Intent settings = new Intent(SearchManager.INTENT_ACTION_SEARCH_SETTINGS);
240        settings.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
241        // Don't show activity chooser if there are multiple search settings activities,
242        // e.g. from different QSB implementations.
243        settings.setPackage(context.getPackageName());
244        menu.add(Menu.NONE, Menu.NONE, 0, R.string.menu_settings)
245                .setIcon(android.R.drawable.ic_menu_preferences).setAlphabeticShortcut('P')
246                .setIntent(settings);
247    }
248}
249