/*
* Copyright (C) 2009 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.quicksearchbox;
import android.app.AlarmManager;
import android.content.Context;
import android.net.Uri;
import android.os.Process;
import android.util.Log;
import java.util.HashSet;
/**
* Provides values for configurable parameters in all of QSB.
*
* All the methods in this class return fixed default values. Subclasses may
* make these values server-side settable.
*
*/
public class Config {
private static final String TAG = "QSB.Config";
private static final boolean DBG = false;
protected static final long SECOND_MILLIS = 1000L;
protected static final long MINUTE_MILLIS = 60L * SECOND_MILLIS;
protected static final long DAY_MILLIS = 86400000L;
private static final int NUM_PROMOTED_SOURCES = 3;
private static final int MAX_RESULTS_PER_SOURCE = 50;
private static final long SOURCE_TIMEOUT_MILLIS = 10000;
private static final int QUERY_THREAD_PRIORITY =
Process.THREAD_PRIORITY_BACKGROUND + Process.THREAD_PRIORITY_MORE_FAVORABLE;
private static final long MAX_STAT_AGE_MILLIS = 30 * DAY_MILLIS;
private static final int MIN_CLICKS_FOR_SOURCE_RANKING = 3;
private static final int NUM_WEB_CORPUS_THREADS = 2;
private static final int LATENCY_LOG_FREQUENCY = 1000;
private static final long TYPING_SUGGESTIONS_UPDATE_DELAY_MILLIS = 100;
private static final long PUBLISH_RESULT_DELAY_MILLIS = 200;
private static final long VOICE_SEARCH_HINT_ACTIVE_PERIOD = 7L * DAY_MILLIS;
private static final long VOICE_SEARCH_HINT_UPDATE_INTERVAL
= AlarmManager.INTERVAL_FIFTEEN_MINUTES;
private static final long VOICE_SEARCH_HINT_SHOW_PERIOD_MILLIS
= AlarmManager.INTERVAL_HOUR * 2;
private static final long VOICE_SEARCH_HINT_CHANGE_PERIOD = 2L * MINUTE_MILLIS;
private static final long VOICE_SEARCH_HINT_VISIBLE_PERIOD = 6L * MINUTE_MILLIS;
private static final int HTTP_CONNECT_TIMEOUT_MILLIS = 4000;
private static final int HTTP_READ_TIMEOUT_MILLIS = 4000;
private static final String USER_AGENT = "Android/1.0";
private final Context mContext;
private HashSet<String> mDefaultCorpora;
private HashSet<String> mHiddenCorpora;
private HashSet<String> mDefaultCorporaSuggestUris;
/**
* Creates a new config that uses hard-coded default values.
*/
public Config(Context context) {
mContext = context;
}
protected Context getContext() {
return mContext;
}
/**
* Releases any resources used by the configuration object.
*
* Default implementation does nothing.
*/
public void close() {
}
private HashSet<String> loadResourceStringSet(int res) {
HashSet<String> defaultCorpora = new HashSet<String>();
String[] corpora = mContext.getResources().getStringArray(res);
for (String corpus : corpora) {
if (DBG) Log.d(TAG, "Default corpus: " + corpus);
defaultCorpora.add(corpus);
}
return defaultCorpora;
}
/**
* Checks if we trust the given source not to be spammy.
*/
public synchronized boolean isCorpusEnabledByDefault(Corpus corpus) {
if (DBG) Log.d(TAG, "isCorpusEnabledByDefault(" + corpus.getName() + ")");
if (mDefaultCorpora == null) {
mDefaultCorpora = loadResourceStringSet(R.array.default_corpora);
}
if (mDefaultCorpora.contains(corpus.getName())) {
if (DBG) Log.d(TAG, "Corpus " + corpus.getName() + " IS default");
return true;
}
if (mDefaultCorporaSuggestUris == null) {
mDefaultCorporaSuggestUris = loadResourceStringSet(
R.array.default_corpora_suggest_uris);
}
for (Source s : corpus.getSources()) {
String uri = s.getSuggestUri();
if (DBG) Log.d(TAG, "Suggest URI for " + corpus.getName() + ": " + uri);
if (mDefaultCorporaSuggestUris.contains(uri)) {
if (DBG) Log.d(TAG, "Corpus " + corpus.getName() + " IS default");
return true;
}
}
if (DBG) Log.d(TAG, "Corpus " + corpus.getName() + " is NOT default");
return false;
}
/**
* Checks if the given corpus should be hidden from the corpus selection dialog.
*/
public synchronized boolean isCorpusHidden(String corpusName) {
if (mHiddenCorpora == null) {
mHiddenCorpora = loadResourceStringSet(R.array.hidden_corpora);
}
return mHiddenCorpora.contains(corpusName);
}
/**
* The number of promoted sources.
*/
public int getNumPromotedSources() {
return NUM_PROMOTED_SOURCES;
}
/**
* The number of suggestions visible above the onscreen keyboard.
*/
public int getNumSuggestionsAboveKeyboard() {
// Get the list of default corpora from a resource, which allows vendor overlays.
return mContext.getResources().getInteger(R.integer.num_suggestions_above_keyboard);
}
/**
* The maximum number of suggestions to promote.
*/
public int getMaxPromotedSuggestions() {
return mContext.getResources().getInteger(R.integer.max_promoted_suggestions);
}
public int getMaxPromotedResults() {
return mContext.getResources().getInteger(R.integer.max_promoted_results);
}
/**
* The number of results to ask each source for.
*/
public int getMaxResultsPerSource() {
return MAX_RESULTS_PER_SOURCE;
}
/**
* The maximum number of shortcuts to show for the web source in All mode.
*/
public int getMaxShortcutsPerWebSource() {
return mContext.getResources().getInteger(R.integer.max_shortcuts_per_web_source);
}
/**
* The maximum number of shortcuts to show for each non-web source in All mode.
*/
public int getMaxShortcutsPerNonWebSource() {
return mContext.getResources().getInteger(R.integer.max_shortcuts_per_non_web_source);
}
/**
* Gets the maximum number of shortcuts that will be shown from the given source.
*/
public int getMaxShortcuts(String sourceName) {
return getMaxShortcutsPerNonWebSource();
}
/**
* The timeout for querying each source, in milliseconds.
*/
public long getSourceTimeoutMillis() {
return SOURCE_TIMEOUT_MILLIS;
}
/**
* The priority of query threads.
*
* @return A thread priority, as defined in {@link Process}.
*/
public int getQueryThreadPriority() {
return QUERY_THREAD_PRIORITY;
}
/**
* The maximum age of log data used for shortcuts.
*/
public long getMaxStatAgeMillis(){
return MAX_STAT_AGE_MILLIS;
}
/**
* The minimum number of clicks needed to rank a source.
*/
public int getMinClicksForSourceRanking(){
return MIN_CLICKS_FOR_SOURCE_RANKING;
}
public int getNumWebCorpusThreads() {
return NUM_WEB_CORPUS_THREADS;
}
/**
* How often query latency should be logged.
*
* @return An integer in the range 0-1000. 0 means that no latency events
* should be logged. 1000 means that all latency events should be logged.
*/
public int getLatencyLogFrequency() {
return LATENCY_LOG_FREQUENCY;
}
/**
* The delay in milliseconds before suggestions are updated while typing.
* If a new character is typed before this timeout expires, the timeout is reset.
*/
public long getTypingUpdateSuggestionsDelayMillis() {
return TYPING_SUGGESTIONS_UPDATE_DELAY_MILLIS;
}
/**
* The delay in milliseconds before corpus results are published.
* If a new result arrives before this timeout expires, the timeout is reset.
*/
public long getPublishResultDelayMillis() {
return PUBLISH_RESULT_DELAY_MILLIS;
}
public boolean allowVoiceSearchHints() {
return true;
}
/**
* The period of time for which after installing voice search we should consider showing voice
* search hints.
*
* @return The period in milliseconds.
*/
public long getVoiceSearchHintActivePeriod() {
return VOICE_SEARCH_HINT_ACTIVE_PERIOD;
}
/**
* The time interval at which we should consider whether or not to show some voice search hints.
*
* @return The period in milliseconds.
*/
public long getVoiceSearchHintUpdatePeriod() {
return VOICE_SEARCH_HINT_UPDATE_INTERVAL;
}
/**
* The time interval at which, on average, voice search hints are displayed.
*
* @return The period in milliseconds.
*/
public long getVoiceSearchHintShowPeriod() {
return VOICE_SEARCH_HINT_SHOW_PERIOD_MILLIS;
}
/**
* The amount of time for which voice search hints are displayed in one go.
*
* @return The period in milliseconds.
*/
public long getVoiceSearchHintVisibleTime() {
return VOICE_SEARCH_HINT_VISIBLE_PERIOD;
}
/**
* The period that we change voice search hints at while they're being displayed.
*
* @return The period in milliseconds.
*/
public long getVoiceSearchHintChangePeriod() {
return VOICE_SEARCH_HINT_CHANGE_PERIOD;
}
public boolean showSuggestionsForZeroQuery() {
// Get the list of default corpora from a resource, which allows vendor overlays.
return mContext.getResources().getBoolean(R.bool.show_zero_query_suggestions);
}
public boolean showShortcutsForZeroQuery() {
// Get the list of default corpora from a resource, which allows vendor overlays.
return mContext.getResources().getBoolean(R.bool.show_zero_query_shortcuts);
}
public boolean showScrollingSuggestions() {
return mContext.getResources().getBoolean(R.bool.show_scrolling_suggestions);
}
public boolean showScrollingResults() {
return mContext.getResources().getBoolean(R.bool.show_scrolling_results);
}
public Uri getHelpUrl(String activity) {
return null;
}
public int getHttpConnectTimeout() {
return HTTP_CONNECT_TIMEOUT_MILLIS;
}
public int getHttpReadTimeout() {
return HTTP_READ_TIMEOUT_MILLIS;
}
public String getUserAgent() {
return USER_AGENT;
}
}